364
492
follow_name_owner_changes=True),
365
493
avahi.DBUS_INTERFACE_SERVER)
366
494
self.server.connect_to_signal("StateChanged",
367
self.server_state_changed)
495
self.server_state_changed)
368
496
self.server_state_changed(self.server.GetState())
370
499
class AvahiServiceToSyslog(AvahiService):
500
def rename(self, *args, **kwargs):
372
501
"""Add the new name to the syslog messages"""
373
ret = AvahiService.rename(self)
374
syslogger.setFormatter(logging.Formatter
375
('Mandos (%s) [%%(process)d]:'
376
' %%(levelname)s: %%(message)s'
502
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
503
syslogger.setFormatter(logging.Formatter(
504
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
380
def _timedelta_to_milliseconds(td):
381
"Convert a datetime.timedelta() to milliseconds"
382
return ((td.days * 24 * 60 * 60 * 1000)
383
+ (td.seconds * 1000)
384
+ (td.microseconds // 1000))
509
# Pretend that we have a GnuTLS module
510
class gnutls(object):
511
"""This isn't so much a class as it is a module-like namespace."""
513
library = ctypes.util.find_library("gnutls")
515
library = ctypes.util.find_library("gnutls-deb0")
516
_library = ctypes.cdll.LoadLibrary(library)
519
# Unless otherwise indicated, the constants and types below are
520
# all from the gnutls/gnutls.h C header file.
531
E_NO_CERTIFICATE_FOUND = -49
536
KEYID_USE_SHA256 = 1 # gnutls/x509.h
537
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
540
class session_int(ctypes.Structure):
542
session_t = ctypes.POINTER(session_int)
544
class certificate_credentials_st(ctypes.Structure):
546
certificate_credentials_t = ctypes.POINTER(
547
certificate_credentials_st)
548
certificate_type_t = ctypes.c_int
550
class datum_t(ctypes.Structure):
551
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
552
('size', ctypes.c_uint)]
554
class openpgp_crt_int(ctypes.Structure):
556
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
557
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
558
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
559
credentials_type_t = ctypes.c_int
560
transport_ptr_t = ctypes.c_void_p
561
close_request_t = ctypes.c_int
564
class Error(Exception):
565
def __init__(self, message=None, code=None, args=()):
566
# Default usage is by a message string, but if a return
567
# code is passed, convert it to a string with
570
if message is None and code is not None:
571
message = gnutls.strerror(code)
572
return super(gnutls.Error, self).__init__(
575
class CertificateSecurityError(Error):
579
class Credentials(object):
581
self._c_object = gnutls.certificate_credentials_t()
582
gnutls.certificate_allocate_credentials(
583
ctypes.byref(self._c_object))
584
self.type = gnutls.CRD_CERTIFICATE
587
gnutls.certificate_free_credentials(self._c_object)
589
class ClientSession(object):
590
def __init__(self, socket, credentials=None):
591
self._c_object = gnutls.session_t()
592
gnutls_flags = gnutls.CLIENT
593
if gnutls.check_version(b"3.5.6"):
594
gnutls_flags |= gnutls.NO_TICKETS
596
gnutls_flags |= gnutls.ENABLE_RAWPK
597
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
599
gnutls.set_default_priority(self._c_object)
600
gnutls.transport_set_ptr(self._c_object, socket.fileno())
601
gnutls.handshake_set_private_extensions(self._c_object,
604
if credentials is None:
605
credentials = gnutls.Credentials()
606
gnutls.credentials_set(self._c_object, credentials.type,
607
ctypes.cast(credentials._c_object,
609
self.credentials = credentials
612
gnutls.deinit(self._c_object)
615
return gnutls.handshake(self._c_object)
617
def send(self, data):
621
data_len -= gnutls.record_send(self._c_object,
626
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
628
# Error handling functions
629
def _error_code(result):
630
"""A function to raise exceptions on errors, suitable
631
for the 'restype' attribute on ctypes functions"""
634
if result == gnutls.E_NO_CERTIFICATE_FOUND:
635
raise gnutls.CertificateSecurityError(code=result)
636
raise gnutls.Error(code=result)
638
def _retry_on_error(result, func, arguments):
639
"""A function to retry on some errors, suitable
640
for the 'errcheck' attribute on ctypes functions"""
642
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
643
return _error_code(result)
644
result = func(*arguments)
647
# Unless otherwise indicated, the function declarations below are
648
# all from the gnutls/gnutls.h C header file.
651
priority_set_direct = _library.gnutls_priority_set_direct
652
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
653
ctypes.POINTER(ctypes.c_char_p)]
654
priority_set_direct.restype = _error_code
656
init = _library.gnutls_init
657
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
658
init.restype = _error_code
660
set_default_priority = _library.gnutls_set_default_priority
661
set_default_priority.argtypes = [session_t]
662
set_default_priority.restype = _error_code
664
record_send = _library.gnutls_record_send
665
record_send.argtypes = [session_t, ctypes.c_void_p,
667
record_send.restype = ctypes.c_ssize_t
668
record_send.errcheck = _retry_on_error
670
certificate_allocate_credentials = (
671
_library.gnutls_certificate_allocate_credentials)
672
certificate_allocate_credentials.argtypes = [
673
ctypes.POINTER(certificate_credentials_t)]
674
certificate_allocate_credentials.restype = _error_code
676
certificate_free_credentials = (
677
_library.gnutls_certificate_free_credentials)
678
certificate_free_credentials.argtypes = [
679
certificate_credentials_t]
680
certificate_free_credentials.restype = None
682
handshake_set_private_extensions = (
683
_library.gnutls_handshake_set_private_extensions)
684
handshake_set_private_extensions.argtypes = [session_t,
686
handshake_set_private_extensions.restype = None
688
credentials_set = _library.gnutls_credentials_set
689
credentials_set.argtypes = [session_t, credentials_type_t,
691
credentials_set.restype = _error_code
693
strerror = _library.gnutls_strerror
694
strerror.argtypes = [ctypes.c_int]
695
strerror.restype = ctypes.c_char_p
697
certificate_type_get = _library.gnutls_certificate_type_get
698
certificate_type_get.argtypes = [session_t]
699
certificate_type_get.restype = _error_code
701
certificate_get_peers = _library.gnutls_certificate_get_peers
702
certificate_get_peers.argtypes = [session_t,
703
ctypes.POINTER(ctypes.c_uint)]
704
certificate_get_peers.restype = ctypes.POINTER(datum_t)
706
global_set_log_level = _library.gnutls_global_set_log_level
707
global_set_log_level.argtypes = [ctypes.c_int]
708
global_set_log_level.restype = None
710
global_set_log_function = _library.gnutls_global_set_log_function
711
global_set_log_function.argtypes = [log_func]
712
global_set_log_function.restype = None
714
deinit = _library.gnutls_deinit
715
deinit.argtypes = [session_t]
716
deinit.restype = None
718
handshake = _library.gnutls_handshake
719
handshake.argtypes = [session_t]
720
handshake.restype = _error_code
721
handshake.errcheck = _retry_on_error
723
transport_set_ptr = _library.gnutls_transport_set_ptr
724
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
725
transport_set_ptr.restype = None
727
bye = _library.gnutls_bye
728
bye.argtypes = [session_t, close_request_t]
729
bye.restype = _error_code
730
bye.errcheck = _retry_on_error
732
check_version = _library.gnutls_check_version
733
check_version.argtypes = [ctypes.c_char_p]
734
check_version.restype = ctypes.c_char_p
736
_need_version = b"3.3.0"
737
if check_version(_need_version) is None:
738
raise self.Error("Needs GnuTLS {} or later"
739
.format(_need_version))
741
_tls_rawpk_version = b"3.6.6"
742
has_rawpk = bool(check_version(_tls_rawpk_version))
746
class pubkey_st(ctypes.Structure):
748
pubkey_t = ctypes.POINTER(pubkey_st)
750
x509_crt_fmt_t = ctypes.c_int
752
# All the function declarations below are from gnutls/abstract.h
753
pubkey_init = _library.gnutls_pubkey_init
754
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
755
pubkey_init.restype = _error_code
757
pubkey_import = _library.gnutls_pubkey_import
758
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
760
pubkey_import.restype = _error_code
762
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
763
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
764
ctypes.POINTER(ctypes.c_ubyte),
765
ctypes.POINTER(ctypes.c_size_t)]
766
pubkey_get_key_id.restype = _error_code
768
pubkey_deinit = _library.gnutls_pubkey_deinit
769
pubkey_deinit.argtypes = [pubkey_t]
770
pubkey_deinit.restype = None
772
# All the function declarations below are from gnutls/openpgp.h
774
openpgp_crt_init = _library.gnutls_openpgp_crt_init
775
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
776
openpgp_crt_init.restype = _error_code
778
openpgp_crt_import = _library.gnutls_openpgp_crt_import
779
openpgp_crt_import.argtypes = [openpgp_crt_t,
780
ctypes.POINTER(datum_t),
782
openpgp_crt_import.restype = _error_code
784
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
785
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
786
ctypes.POINTER(ctypes.c_uint)]
787
openpgp_crt_verify_self.restype = _error_code
789
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
790
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
791
openpgp_crt_deinit.restype = None
793
openpgp_crt_get_fingerprint = (
794
_library.gnutls_openpgp_crt_get_fingerprint)
795
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
799
openpgp_crt_get_fingerprint.restype = _error_code
801
if check_version(b"3.6.4"):
802
certificate_type_get2 = _library.gnutls_certificate_type_get2
803
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
804
certificate_type_get2.restype = _error_code
806
# Remove non-public functions
807
del _error_code, _retry_on_error
810
def call_pipe(connection, # : multiprocessing.Connection
811
func, *args, **kwargs):
812
"""This function is meant to be called by multiprocessing.Process
814
This function runs func(*args, **kwargs), and writes the resulting
815
return value on the provided multiprocessing.Connection.
817
connection.send(func(*args, **kwargs))
386
821
class Client(object):
387
822
"""A representation of a client host served by this server.
390
_approved: bool(); 'None' if not yet approved/disapproved
825
approved: bool(); 'None' if not yet approved/disapproved
391
826
approval_delay: datetime.timedelta(); Time to wait for approval
392
827
approval_duration: datetime.timedelta(); Duration of one approval
393
checker: subprocess.Popen(); a running checker process used
394
to see if the client lives.
395
'None' if no process is running.
396
checker_callback_tag: a gobject event source tag, or None
828
checker: multiprocessing.Process(); a running checker process used
829
to see if the client lives. 'None' if no process is
831
checker_callback_tag: a GLib event source tag, or None
397
832
checker_command: string; External command which is run to check
398
833
if client lives. %() expansions are done at
399
834
runtime with vars(self) as dict, so that for
400
835
instance %(name)s can be used in the command.
401
checker_initiator_tag: a gobject event source tag, or None
836
checker_initiator_tag: a GLib event source tag, or None
402
837
created: datetime.datetime(); (UTC) object creation
403
838
client_structure: Object describing what attributes a client has
404
839
and is used for storing the client at exit
405
840
current_checker_command: string; current running checker_command
406
disable_initiator_tag: a gobject event source tag, or None
841
disable_initiator_tag: a GLib event source tag, or None
408
843
fingerprint: string (40 or 32 hexadecimal digits); used to
409
uniquely identify the client
844
uniquely identify an OpenPGP client
845
key_id: string (64 hexadecimal digits); used to uniquely identify
846
a client using raw public keys
410
847
host: string; available for use by the checker command
411
848
interval: datetime.timedelta(); How often to start a new checker
412
849
last_approval_request: datetime.datetime(); (UTC) or None
413
850
last_checked_ok: datetime.datetime(); (UTC) or None
415
851
last_checker_status: integer between 0 and 255 reflecting exit
416
852
status of last checker. -1 reflects crashed
853
checker, -2 means no checker completed yet.
854
last_checker_signal: The signal which killed the last checker, if
855
last_checker_status is -1
418
856
last_enabled: datetime.datetime(); (UTC) or None
419
857
name: string; from the config file, used in log messages and
420
858
D-Bus identifiers
421
859
secret: bytestring; sent verbatim (over TLS) to client
422
860
timeout: datetime.timedelta(); How long from last_checked_ok
423
861
until this client is disabled
424
extended_timeout: extra long timeout when password has been sent
862
extended_timeout: extra long timeout when secret has been sent
425
863
runtime_expansions: Allowed attributes for runtime expansion.
426
864
expires: datetime.datetime(); time (UTC) when a client will be
427
865
disabled, or None
866
server_settings: The server_settings dict from main()
430
869
runtime_expansions = ("approval_delay", "approval_duration",
431
"created", "enabled", "fingerprint",
432
"host", "interval", "last_checked_ok",
870
"created", "enabled", "expires", "key_id",
871
"fingerprint", "host", "interval",
872
"last_approval_request", "last_checked_ok",
433
873
"last_enabled", "name", "timeout")
435
def timeout_milliseconds(self):
436
"Return the 'timeout' attribute in milliseconds"
437
return _timedelta_to_milliseconds(self.timeout)
439
def extended_timeout_milliseconds(self):
440
"Return the 'extended_timeout' attribute in milliseconds"
441
return _timedelta_to_milliseconds(self.extended_timeout)
443
def interval_milliseconds(self):
444
"Return the 'interval' attribute in milliseconds"
445
return _timedelta_to_milliseconds(self.interval)
447
def approval_delay_milliseconds(self):
448
return _timedelta_to_milliseconds(self.approval_delay)
450
def __init__(self, name = None, config=None):
451
"""Note: the 'checker' key in 'config' sets the
452
'checker_command' attribute and *not* the 'checker'
876
"extended_timeout": "PT15M",
878
"checker": "fping -q -- %%(host)s",
880
"approval_delay": "PT0S",
881
"approval_duration": "PT1S",
882
"approved_by_default": "True",
887
def config_parser(config):
888
"""Construct a new dict of client settings of this form:
889
{ client_name: {setting_name: value, ...}, ...}
890
with exceptions for any special settings as defined above.
891
NOTE: Must be a pure function. Must return the same result
892
value given the same arguments.
895
for client_name in config.sections():
896
section = dict(config.items(client_name))
897
client = settings[client_name] = {}
899
client["host"] = section["host"]
900
# Reformat values from string types to Python types
901
client["approved_by_default"] = config.getboolean(
902
client_name, "approved_by_default")
903
client["enabled"] = config.getboolean(client_name,
906
# Uppercase and remove spaces from key_id and fingerprint
907
# for later comparison purposes with return value from the
908
# key_id() and fingerprint() functions
909
client["key_id"] = (section.get("key_id", "").upper()
911
client["fingerprint"] = (section["fingerprint"].upper()
913
if "secret" in section:
914
client["secret"] = codecs.decode(section["secret"]
917
elif "secfile" in section:
918
with open(os.path.expanduser(os.path.expandvars
919
(section["secfile"])),
921
client["secret"] = secfile.read()
923
raise TypeError("No secret or secfile for section {}"
925
client["timeout"] = string_to_delta(section["timeout"])
926
client["extended_timeout"] = string_to_delta(
927
section["extended_timeout"])
928
client["interval"] = string_to_delta(section["interval"])
929
client["approval_delay"] = string_to_delta(
930
section["approval_delay"])
931
client["approval_duration"] = string_to_delta(
932
section["approval_duration"])
933
client["checker_command"] = section["checker"]
934
client["last_approval_request"] = None
935
client["last_checked_ok"] = None
936
client["last_checker_status"] = -2
940
def __init__(self, settings, name=None, server_settings=None):
942
if server_settings is None:
944
self.server_settings = server_settings
945
# adding all client settings
946
for setting, value in settings.items():
947
setattr(self, setting, value)
950
if not hasattr(self, "last_enabled"):
951
self.last_enabled = datetime.datetime.utcnow()
952
if not hasattr(self, "expires"):
953
self.expires = (datetime.datetime.utcnow()
956
self.last_enabled = None
457
959
logger.debug("Creating client %r", self.name)
458
# Uppercase and remove spaces from fingerprint for later
459
# comparison purposes with return value from the fingerprint()
461
self.fingerprint = (config["fingerprint"].upper()
960
logger.debug(" Key ID: %s", self.key_id)
463
961
logger.debug(" Fingerprint: %s", self.fingerprint)
464
if "secret" in config:
465
self.secret = config["secret"].decode("base64")
466
elif "secfile" in config:
467
with open(os.path.expanduser(os.path.expandvars
468
(config["secfile"])),
470
self.secret = secfile.read()
472
raise TypeError("No secret or secfile for client %s"
474
self.host = config.get("host", "")
475
self.created = datetime.datetime.utcnow()
476
self.enabled = config.get("enabled", True)
477
self.last_approval_request = None
479
self.last_enabled = datetime.datetime.utcnow()
481
self.last_enabled = None
482
self.last_checked_ok = None
483
self.last_checker_status = None
484
self.timeout = string_to_delta(config["timeout"])
485
self.extended_timeout = string_to_delta(config
486
["extended_timeout"])
487
self.interval = string_to_delta(config["interval"])
962
self.created = settings.get("created",
963
datetime.datetime.utcnow())
965
# attributes specific for this server instance
488
966
self.checker = None
489
967
self.checker_initiator_tag = None
490
968
self.disable_initiator_tag = None
492
self.expires = datetime.datetime.utcnow() + self.timeout
495
969
self.checker_callback_tag = None
496
self.checker_command = config["checker"]
497
970
self.current_checker_command = None
498
self._approved = None
499
self.approved_by_default = config.get("approved_by_default",
501
972
self.approvals_pending = 0
502
self.approval_delay = string_to_delta(
503
config["approval_delay"])
504
self.approval_duration = string_to_delta(
505
config["approval_duration"])
506
self.changedstate = (multiprocessing_manager
507
.Condition(multiprocessing_manager
509
self.client_structure = [attr for attr in
510
self.__dict__.iterkeys()
973
self.changedstate = multiprocessing_manager.Condition(
974
multiprocessing_manager.Lock())
975
self.client_structure = [attr
976
for attr in self.__dict__.keys()
511
977
if not attr.startswith("_")]
512
978
self.client_structure.append("client_structure")
514
for name, t in inspect.getmembers(type(self),
980
for name, t in inspect.getmembers(
981
type(self), lambda obj: isinstance(obj, property)):
518
982
if not name.startswith("_"):
519
983
self.client_structure.append(name)
521
985
# Send notice to process children that client state has changed
522
986
def send_changedstate(self):
523
987
with self.changedstate:
524
988
self.changedstate.notify_all()
526
990
def enable(self):
527
991
"""Start this client's checker and timeout hooks"""
528
992
if getattr(self, "enabled", False):
529
993
# Already enabled
531
self.send_changedstate()
532
995
self.expires = datetime.datetime.utcnow() + self.timeout
533
996
self.enabled = True
534
997
self.last_enabled = datetime.datetime.utcnow()
535
998
self.init_checker()
999
self.send_changedstate()
537
1001
def disable(self, quiet=True):
538
1002
"""Disable this client."""
539
1003
if not getattr(self, "enabled", False):
542
self.send_changedstate()
544
1006
logger.info("Disabling client %s", self.name)
545
if getattr(self, "disable_initiator_tag", False):
546
gobject.source_remove(self.disable_initiator_tag)
1007
if getattr(self, "disable_initiator_tag", None) is not None:
1008
GLib.source_remove(self.disable_initiator_tag)
547
1009
self.disable_initiator_tag = None
548
1010
self.expires = None
549
if getattr(self, "checker_initiator_tag", False):
550
gobject.source_remove(self.checker_initiator_tag)
1011
if getattr(self, "checker_initiator_tag", None) is not None:
1012
GLib.source_remove(self.checker_initiator_tag)
551
1013
self.checker_initiator_tag = None
552
1014
self.stop_checker()
553
1015
self.enabled = False
554
# Do not run this again if called by a gobject.timeout_add
1017
self.send_changedstate()
1018
# Do not run this again if called by a GLib.timeout_add
557
1021
def __del__(self):
560
1024
def init_checker(self):
561
1025
# Schedule a new checker to be started an 'interval' from now,
562
1026
# and every interval from then on.
563
self.checker_initiator_tag = (gobject.timeout_add
564
(self.interval_milliseconds(),
1027
if self.checker_initiator_tag is not None:
1028
GLib.source_remove(self.checker_initiator_tag)
1029
self.checker_initiator_tag = GLib.timeout_add(
1030
int(self.interval.total_seconds() * 1000),
566
1032
# Schedule a disable() when 'timeout' has passed
567
self.disable_initiator_tag = (gobject.timeout_add
568
(self.timeout_milliseconds(),
1033
if self.disable_initiator_tag is not None:
1034
GLib.source_remove(self.disable_initiator_tag)
1035
self.disable_initiator_tag = GLib.timeout_add(
1036
int(self.timeout.total_seconds() * 1000), self.disable)
570
1037
# Also start a new checker *right now*.
571
1038
self.start_checker()
573
def checker_callback(self, pid, condition, command):
1040
def checker_callback(self, source, condition, connection,
574
1042
"""The checker has completed, so take appropriate actions."""
1043
# Read return code from connection (see call_pipe)
1044
returncode = connection.recv()
575
1047
self.checker_callback_tag = None
576
1048
self.checker = None
577
if os.WIFEXITED(condition):
578
self.last_checker_status = os.WEXITSTATUS(condition)
1051
self.last_checker_status = returncode
1052
self.last_checker_signal = None
579
1053
if self.last_checker_status == 0:
580
1054
logger.info("Checker for %(name)s succeeded",
582
1056
self.checked_ok()
584
logger.info("Checker for %(name)s failed",
1058
logger.info("Checker for %(name)s failed", vars(self))
587
1060
self.last_checker_status = -1
1061
self.last_checker_signal = -returncode
588
1062
logger.warning("Checker for %(name)s crashed?",
591
def checked_ok(self, timeout=None):
592
"""Bump up the timeout for this client.
594
This should only be called when the client has been seen,
1066
def checked_ok(self):
1067
"""Assert that the client has been seen, alive and well."""
1068
self.last_checked_ok = datetime.datetime.utcnow()
1069
self.last_checker_status = 0
1070
self.last_checker_signal = None
1073
def bump_timeout(self, timeout=None):
1074
"""Bump up the timeout for this client."""
597
1075
if timeout is None:
598
1076
timeout = self.timeout
599
self.last_checked_ok = datetime.datetime.utcnow()
600
1077
if self.disable_initiator_tag is not None:
601
gobject.source_remove(self.disable_initiator_tag)
1078
GLib.source_remove(self.disable_initiator_tag)
1079
self.disable_initiator_tag = None
602
1080
if getattr(self, "enabled", False):
603
self.disable_initiator_tag = (gobject.timeout_add
604
(_timedelta_to_milliseconds
605
(timeout), self.disable))
1081
self.disable_initiator_tag = GLib.timeout_add(
1082
int(timeout.total_seconds() * 1000), self.disable)
606
1083
self.expires = datetime.datetime.utcnow() + timeout
608
1085
def need_approval(self):
609
1086
self.last_approval_request = datetime.datetime.utcnow()
611
1088
def start_checker(self):
612
1089
"""Start a new checker subprocess if one is not running.
614
1091
If a checker already exists, leave it running and do
616
1093
# The reason for not killing a running checker is that if we
617
# did that, then if a checker (for some reason) started
618
# running slowly and taking more than 'interval' time, the
619
# client would inevitably timeout, since no checker would get
620
# a chance to run to completion. If we instead leave running
1094
# did that, and if a checker (for some reason) started running
1095
# slowly and taking more than 'interval' time, then the client
1096
# would inevitably timeout, since no checker would get a
1097
# chance to run to completion. If we instead leave running
621
1098
# checkers alone, the checker would have to take more time
622
1099
# than 'timeout' for the client to be disabled, which is as it
625
# If a checker exists, make sure it is not a zombie
627
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
628
except (AttributeError, OSError) as error:
629
if (isinstance(error, OSError)
630
and error.errno != errno.ECHILD):
634
logger.warning("Checker was a zombie")
635
gobject.source_remove(self.checker_callback_tag)
636
self.checker_callback(pid, status,
637
self.current_checker_command)
1102
if self.checker is not None and not self.checker.is_alive():
1103
logger.warning("Checker was not alive; joining")
638
1106
# Start a new checker if needed
639
1107
if self.checker is None:
1108
# Escape attributes for the shell
1110
attr: re.escape(str(getattr(self, attr)))
1111
for attr in self.runtime_expansions}
641
# In case checker_command has exactly one % operator
642
command = self.checker_command % self.host
644
# Escape attributes for the shell
645
escaped_attrs = dict(
647
re.escape(unicode(str(getattr(self, attr, "")),
651
self.runtime_expansions)
654
command = self.checker_command % escaped_attrs
655
except TypeError as error:
656
logger.error('Could not format string "%s":'
657
' %s', self.checker_command, error)
658
return True # Try again later
1113
command = self.checker_command % escaped_attrs
1114
except TypeError as error:
1115
logger.error('Could not format string "%s"',
1116
self.checker_command,
1118
return True # Try again later
659
1119
self.current_checker_command = command
661
logger.info("Starting checker %r for %s",
663
# We don't need to redirect stdout and stderr, since
664
# in normal mode, that is already done by daemon(),
665
# and in debug mode we don't want to. (Stdin is
666
# always replaced by /dev/null.)
667
self.checker = subprocess.Popen(command,
670
self.checker_callback_tag = (gobject.child_watch_add
672
self.checker_callback,
674
# The checker may have completed before the gobject
675
# watch was added. Check for this.
676
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
678
gobject.source_remove(self.checker_callback_tag)
679
self.checker_callback(pid, status, command)
680
except OSError as error:
681
logger.error("Failed to start subprocess: %s",
683
# Re-run this periodically if run by gobject.timeout_add
1120
logger.info("Starting checker %r for %s", command,
1122
# We don't need to redirect stdout and stderr, since
1123
# in normal mode, that is already done by daemon(),
1124
# and in debug mode we don't want to. (Stdin is
1125
# always replaced by /dev/null.)
1126
# The exception is when not debugging but nevertheless
1127
# running in the foreground; use the previously
1129
popen_args = {"close_fds": True,
1132
if (not self.server_settings["debug"]
1133
and self.server_settings["foreground"]):
1134
popen_args.update({"stdout": wnull,
1136
pipe = multiprocessing.Pipe(duplex=False)
1137
self.checker = multiprocessing.Process(
1139
args=(pipe[1], subprocess.call, command),
1141
self.checker.start()
1142
self.checker_callback_tag = GLib.io_add_watch(
1143
pipe[0].fileno(), GLib.IO_IN,
1144
self.checker_callback, pipe[0], command)
1145
# Re-run this periodically if run by GLib.timeout_add
686
1148
def stop_checker(self):
687
1149
"""Force the checker process, if any, to stop."""
688
1150
if self.checker_callback_tag:
689
gobject.source_remove(self.checker_callback_tag)
1151
GLib.source_remove(self.checker_callback_tag)
690
1152
self.checker_callback_tag = None
691
1153
if getattr(self, "checker", None) is None:
693
1155
logger.debug("Stopping checker for %(name)s", vars(self))
695
os.kill(self.checker.pid, signal.SIGTERM)
697
#if self.checker.poll() is None:
698
# os.kill(self.checker.pid, signal.SIGKILL)
699
except OSError as error:
700
if error.errno != errno.ESRCH: # No such process
1156
self.checker.terminate()
702
1157
self.checker = None
705
def dbus_service_property(dbus_interface, signature="v",
706
access="readwrite", byte_arrays=False):
1160
def dbus_service_property(dbus_interface,
707
1164
"""Decorators for marking methods of a DBusObjectWithProperties to
708
1165
become properties on the D-Bus.
710
1167
The decorated method will be called with no arguments by "Get"
711
1168
and with one argument by "Set".
713
1170
The parameters, where they are supported, are the same as
714
1171
dbus.service.method, except there is only "signature", since the
715
1172
type from Get() and the type sent to Set() is the same.
885
1505
except (AttributeError, xml.dom.DOMException,
886
1506
xml.parsers.expat.ExpatError) as error:
887
1507
logger.error("Failed to override Introspection method",
892
def datetime_to_dbus (dt, variant_level=0):
1513
dbus.OBJECT_MANAGER_IFACE
1514
except AttributeError:
1515
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1518
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1519
"""A D-Bus object with an ObjectManager.
1521
Classes inheriting from this exposes the standard
1522
GetManagedObjects call and the InterfacesAdded and
1523
InterfacesRemoved signals on the standard
1524
"org.freedesktop.DBus.ObjectManager" interface.
1526
Note: No signals are sent automatically; they must be sent
1529
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1530
out_signature="a{oa{sa{sv}}}")
1531
def GetManagedObjects(self):
1532
"""This function must be overridden"""
1533
raise NotImplementedError()
1535
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1536
signature="oa{sa{sv}}")
1537
def InterfacesAdded(self, object_path, interfaces_and_properties):
1540
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1541
def InterfacesRemoved(self, object_path, interfaces):
1544
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1546
path_keyword='object_path',
1547
connection_keyword='connection')
1548
def Introspect(self, object_path, connection):
1549
"""Overloading of standard D-Bus method.
1551
Override return argument name of GetManagedObjects to be
1552
"objpath_interfaces_and_properties"
1554
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1558
document = xml.dom.minidom.parseString(xmlstring)
1560
for if_tag in document.getElementsByTagName("interface"):
1561
# Fix argument name for the GetManagedObjects method
1562
if (if_tag.getAttribute("name")
1563
== dbus.OBJECT_MANAGER_IFACE):
1564
for cn in if_tag.getElementsByTagName("method"):
1565
if (cn.getAttribute("name")
1566
== "GetManagedObjects"):
1567
for arg in cn.getElementsByTagName("arg"):
1568
if (arg.getAttribute("direction")
1572
"objpath_interfaces"
1574
xmlstring = document.toxml("utf-8")
1576
except (AttributeError, xml.dom.DOMException,
1577
xml.parsers.expat.ExpatError) as error:
1578
logger.error("Failed to override Introspection method",
1583
def datetime_to_dbus(dt, variant_level=0):
893
1584
"""Convert a UTC datetime.datetime() to a D-Bus type."""
895
return dbus.String("", variant_level = variant_level)
896
return dbus.String(dt.isoformat(),
897
variant_level=variant_level)
900
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
902
"""Applied to an empty subclass of a D-Bus object, this metaclass
903
will add additional D-Bus attributes matching a certain pattern.
1586
return dbus.String("", variant_level=variant_level)
1587
return dbus.String(dt.isoformat(), variant_level=variant_level)
1590
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1591
"""A class decorator; applied to a subclass of
1592
dbus.service.Object, it will add alternate D-Bus attributes with
1593
interface names according to the "alt_interface_names" mapping.
1596
@alternate_dbus_interfaces({"org.example.Interface":
1597
"net.example.AlternateInterface"})
1598
class SampleDBusObject(dbus.service.Object):
1599
@dbus.service.method("org.example.Interface")
1600
def SampleDBusMethod():
1603
The above "SampleDBusMethod" on "SampleDBusObject" will be
1604
reachable via two interfaces: "org.example.Interface" and
1605
"net.example.AlternateInterface", the latter of which will have
1606
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1607
"true", unless "deprecate" is passed with a False value.
1609
This works for methods and signals, and also for D-Bus properties
1610
(from DBusObjectWithProperties) and interfaces (from the
1611
dbus_interface_annotations decorator).
905
def __new__(mcs, name, bases, attr):
906
# Go through all the base classes which could have D-Bus
907
# methods, signals, or properties in them
908
for base in (b for b in bases
909
if issubclass(b, dbus.service.Object)):
910
# Go though all attributes of the base class
911
for attrname, attribute in inspect.getmembers(base):
1615
for orig_interface_name, alt_interface_name in (
1616
alt_interface_names.items()):
1618
interface_names = set()
1619
# Go though all attributes of the class
1620
for attrname, attribute in inspect.getmembers(cls):
912
1621
# Ignore non-D-Bus attributes, and D-Bus attributes
913
1622
# with the wrong interface name
914
1623
if (not hasattr(attribute, "_dbus_interface")
915
or not attribute._dbus_interface
916
.startswith("se.recompile.Mandos")):
1624
or not attribute._dbus_interface.startswith(
1625
orig_interface_name)):
918
1627
# Create an alternate D-Bus interface name based on
919
1628
# the current name
920
alt_interface = (attribute._dbus_interface
921
.replace("se.recompile.Mandos",
922
"se.bsnet.fukt.Mandos"))
1629
alt_interface = attribute._dbus_interface.replace(
1630
orig_interface_name, alt_interface_name)
1631
interface_names.add(alt_interface)
923
1632
# Is this a D-Bus signal?
924
1633
if getattr(attribute, "_dbus_is_signal", False):
925
# Extract the original non-method function by
927
nonmethod_func = (dict(
1634
# Extract the original non-method undecorated
1635
# function by black magic
1636
if sys.version_info.major == 2:
1637
nonmethod_func = (dict(
928
1638
zip(attribute.func_code.co_freevars,
929
attribute.__closure__))["func"]
1639
attribute.__closure__))
1640
["func"].cell_contents)
1642
nonmethod_func = (dict(
1643
zip(attribute.__code__.co_freevars,
1644
attribute.__closure__))
1645
["func"].cell_contents)
931
1646
# Create a new, but exactly alike, function
932
1647
# object, and decorate it to be a new D-Bus signal
933
1648
# with the alternate D-Bus interface name
934
new_function = (dbus.service.signal
936
attribute._dbus_signature)
938
nonmethod_func.func_code,
939
nonmethod_func.func_globals,
940
nonmethod_func.func_name,
941
nonmethod_func.func_defaults,
942
nonmethod_func.func_closure)))
1649
new_function = copy_function(nonmethod_func)
1650
new_function = (dbus.service.signal(
1652
attribute._dbus_signature)(new_function))
1653
# Copy annotations, if any
1655
new_function._dbus_annotations = dict(
1656
attribute._dbus_annotations)
1657
except AttributeError:
943
1660
# Define a creator of a function to call both the
944
# old and new functions, so both the old and new
945
# signals gets sent when the function is called
1661
# original and alternate functions, so both the
1662
# original and alternate signals gets sent when
1663
# the function is called
946
1664
def fixscope(func1, func2):
947
1665
"""This function is a scope container to pass
948
1666
func1 and func2 to the "call_both" function
949
1667
outside of its arguments"""
1669
@functools.wraps(func2)
950
1670
def call_both(*args, **kwargs):
951
1671
"""This function will emit two D-Bus
952
1672
signals by calling func1 and func2"""
953
1673
func1(*args, **kwargs)
954
1674
func2(*args, **kwargs)
1675
# Make wrapper function look like a D-Bus
1677
for name, attr in inspect.getmembers(func2):
1678
if name.startswith("_dbus_"):
1679
setattr(call_both, name, attr)
955
1681
return call_both
956
1682
# Create the "call_both" function and add it to
958
attr[attrname] = fixscope(attribute,
1684
attr[attrname] = fixscope(attribute, new_function)
960
1685
# Is this a D-Bus method?
961
1686
elif getattr(attribute, "_dbus_is_method", False):
962
1687
# Create a new, but exactly alike, function
963
1688
# object. Decorate it to be a new D-Bus method
964
1689
# with the alternate D-Bus interface name. Add it
966
attr[attrname] = (dbus.service.method
968
attribute._dbus_in_signature,
969
attribute._dbus_out_signature)
971
(attribute.func_code,
972
attribute.func_globals,
974
attribute.func_defaults,
975
attribute.func_closure)))
1692
dbus.service.method(
1694
attribute._dbus_in_signature,
1695
attribute._dbus_out_signature)
1696
(copy_function(attribute)))
1697
# Copy annotations, if any
1699
attr[attrname]._dbus_annotations = dict(
1700
attribute._dbus_annotations)
1701
except AttributeError:
976
1703
# Is this a D-Bus property?
977
1704
elif getattr(attribute, "_dbus_is_property", False):
978
1705
# Create a new, but exactly alike, function
979
1706
# object, and decorate it to be a new D-Bus
980
1707
# property with the alternate D-Bus interface
981
1708
# name. Add it to the class.
982
attr[attrname] = (dbus_service_property
984
attribute._dbus_signature,
985
attribute._dbus_access,
987
._dbus_get_args_options
990
(attribute.func_code,
991
attribute.func_globals,
993
attribute.func_defaults,
994
attribute.func_closure)))
995
return type.__new__(mcs, name, bases, attr)
1709
attr[attrname] = (dbus_service_property(
1710
alt_interface, attribute._dbus_signature,
1711
attribute._dbus_access,
1712
attribute._dbus_get_args_options
1714
(copy_function(attribute)))
1715
# Copy annotations, if any
1717
attr[attrname]._dbus_annotations = dict(
1718
attribute._dbus_annotations)
1719
except AttributeError:
1721
# Is this a D-Bus interface?
1722
elif getattr(attribute, "_dbus_is_interface", False):
1723
# Create a new, but exactly alike, function
1724
# object. Decorate it to be a new D-Bus interface
1725
# with the alternate D-Bus interface name. Add it
1728
dbus_interface_annotations(alt_interface)
1729
(copy_function(attribute)))
1731
# Deprecate all alternate interfaces
1732
iname = "_AlternateDBusNames_interface_annotation{}"
1733
for interface_name in interface_names:
1735
@dbus_interface_annotations(interface_name)
1737
return {"org.freedesktop.DBus.Deprecated":
1739
# Find an unused name
1740
for aname in (iname.format(i)
1741
for i in itertools.count()):
1742
if aname not in attr:
1746
# Replace the class with a new subclass of it with
1747
# methods, signals, etc. as created above.
1748
if sys.version_info.major == 2:
1749
cls = type(b"{}Alternate".format(cls.__name__),
1752
cls = type("{}Alternate".format(cls.__name__),
1759
@alternate_dbus_interfaces({"se.recompile.Mandos":
1760
"se.bsnet.fukt.Mandos"})
998
1761
class ClientDBus(Client, DBusObjectWithProperties):
999
1762
"""A Client class using D-Bus
1002
1765
dbus_object_path: dbus.ObjectPath
1003
1766
bus: dbus.SystemBus()
1006
1769
runtime_expansions = (Client.runtime_expansions
1007
+ ("dbus_object_path",))
1770
+ ("dbus_object_path", ))
1772
_interface = "se.recompile.Mandos.Client"
1009
1774
# dbus.service.Object doesn't use super(), so we can't either.
1011
def __init__(self, bus = None, *args, **kwargs):
1776
def __init__(self, bus=None, *args, **kwargs):
1013
1778
Client.__init__(self, *args, **kwargs)
1015
self._approvals_pending = 0
1016
1779
# Only now, when this client is initialized, can it show up on
1018
client_object_name = unicode(self.name).translate(
1781
client_object_name = str(self.name).translate(
1019
1782
{ord("."): ord("_"),
1020
1783
ord("-"): ord("_")})
1021
self.dbus_object_path = (dbus.ObjectPath
1022
("/clients/" + client_object_name))
1784
self.dbus_object_path = dbus.ObjectPath(
1785
"/clients/" + client_object_name)
1023
1786
DBusObjectWithProperties.__init__(self, self.bus,
1024
1787
self.dbus_object_path)
1026
def notifychangeproperty(transform_func,
1027
dbus_name, type_func=lambda x: x,
1789
def notifychangeproperty(transform_func, dbus_name,
1790
type_func=lambda x: x,
1792
invalidate_only=False,
1793
_interface=_interface):
1029
1794
""" Modify a variable so that it's a property which announces
1030
1795
its changes to DBus.
1032
1797
transform_fun: Function that takes a value and a variant_level
1033
1798
and transforms it to a D-Bus type.
1034
1799
dbus_name: D-Bus name of the variable
1391
2190
self.start_checker()
1393
2192
self.stop_checker()
1395
2194
# ObjectPath - property
2196
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2197
"org.freedesktop.DBus.Deprecated": "true"})
1396
2198
@dbus_service_property(_interface, signature="o", access="read")
1397
2199
def ObjectPath_dbus_property(self):
1398
return self.dbus_object_path # is already a dbus.ObjectPath
2200
return self.dbus_object_path # is already a dbus.ObjectPath
1400
2202
# Secret = property
1401
@dbus_service_property(_interface, signature="ay",
1402
access="write", byte_arrays=True)
2204
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2206
@dbus_service_property(_interface,
1403
2210
def Secret_dbus_property(self, value):
1404
self.secret = str(value)
2211
self.secret = bytes(value)
1409
2216
class ProxyClient(object):
1410
def __init__(self, child_pipe, fpr, address):
2217
def __init__(self, child_pipe, key_id, fpr, address):
1411
2218
self._pipe = child_pipe
1412
self._pipe.send(('init', fpr, address))
2219
self._pipe.send(('init', key_id, fpr, address))
1413
2220
if not self._pipe.recv():
2221
raise KeyError(key_id or fpr)
1416
2223
def __getattribute__(self, name):
1417
if(name == '_pipe'):
1418
2225
return super(ProxyClient, self).__getattribute__(name)
1419
2226
self._pipe.send(('getattr', name))
1420
2227
data = self._pipe.recv()
1421
2228
if data[0] == 'data':
1423
2230
if data[0] == 'function':
1424
2232
def func(*args, **kwargs):
1425
2233
self._pipe.send(('funcall', name, args, kwargs))
1426
2234
return self._pipe.recv()[1]
1429
2238
def __setattr__(self, name, value):
1430
if(name == '_pipe'):
1431
2240
return super(ProxyClient, self).__setattr__(name, value)
1432
2241
self._pipe.send(('setattr', name, value))
1435
class ClientDBusTransitional(ClientDBus):
1436
__metaclass__ = AlternateDBusNamesMetaclass
1439
2244
class ClientHandler(socketserver.BaseRequestHandler, object):
1440
2245
"""A class to handle client connections.
1442
2247
Instantiated once for each connection to handle it.
1443
2248
Note: This will run in its own forked process."""
1445
2250
def handle(self):
1446
2251
with contextlib.closing(self.server.child_pipe) as child_pipe:
1447
2252
logger.info("TCP connection from: %s",
1448
unicode(self.client_address))
2253
str(self.client_address))
1449
2254
logger.debug("Pipe FD: %d",
1450
2255
self.server.child_pipe.fileno())
1452
session = (gnutls.connection
1453
.ClientSession(self.request,
1455
.X509Credentials()))
1457
# Note: gnutls.connection.X509Credentials is really a
1458
# generic GnuTLS certificate credentials object so long as
1459
# no X.509 keys are added to it. Therefore, we can use it
1460
# here despite using OpenPGP certificates.
1462
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1463
# "+AES-256-CBC", "+SHA1",
1464
# "+COMP-NULL", "+CTYPE-OPENPGP",
2257
session = gnutls.ClientSession(self.request)
2259
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2260
# "+AES-256-CBC", "+SHA1",
2261
# "+COMP-NULL", "+CTYPE-OPENPGP",
1466
2263
# Use a fallback default, since this MUST be set.
1467
2264
priority = self.server.gnutls_priority
1468
2265
if priority is None:
1469
2266
priority = "NORMAL"
1470
(gnutls.library.functions
1471
.gnutls_priority_set_direct(session._c_object,
2267
gnutls.priority_set_direct(session._c_object,
2268
priority.encode("utf-8"),
1474
2271
# Start communication using the Mandos protocol
1475
2272
# Get protocol number
1476
2273
line = self.request.makefile().readline()
1477
2274
logger.debug("Protocol version: %r", line)
1479
2276
if int(line.strip().split()[0]) > 1:
2277
raise RuntimeError(line)
1481
2278
except (ValueError, IndexError, RuntimeError) as error:
1482
2279
logger.error("Unknown protocol version: %s", error)
1485
2282
# Start GnuTLS connection
1487
2284
session.handshake()
1488
except gnutls.errors.GNUTLSError as error:
2285
except gnutls.Error as error:
1489
2286
logger.warning("Handshake failed: %s", error)
1490
2287
# Do not run session.bye() here: the session is not
1491
2288
# established. Just abandon the request.
1493
2290
logger.debug("Handshake succeeded")
1495
2292
approval_required = False
1498
fpr = self.fingerprint(self.peer_certificate
1501
gnutls.errors.GNUTLSError) as error:
1502
logger.warning("Bad certificate: %s", error)
1504
logger.debug("Fingerprint: %s", fpr)
1505
if self.server.use_dbus:
1507
client.NewRequest(str(self.client_address))
1510
client = ProxyClient(child_pipe, fpr,
2294
if gnutls.has_rawpk:
2297
key_id = self.key_id(
2298
self.peer_certificate(session))
2299
except (TypeError, gnutls.Error) as error:
2300
logger.warning("Bad certificate: %s", error)
2302
logger.debug("Key ID: %s", key_id)
2307
fpr = self.fingerprint(
2308
self.peer_certificate(session))
2309
except (TypeError, gnutls.Error) as error:
2310
logger.warning("Bad certificate: %s", error)
2312
logger.debug("Fingerprint: %s", fpr)
2315
client = ProxyClient(child_pipe, key_id, fpr,
1511
2316
self.client_address)
1512
2317
except KeyError:
1515
2320
if client.approval_delay:
1516
2321
delay = client.approval_delay
1517
2322
client.approvals_pending += 1
1518
2323
approval_required = True
1521
2326
if not client.enabled:
1522
2327
logger.info("Client %s is disabled",
1524
2329
if self.server.use_dbus:
1525
2330
# Emit D-Bus signal
1526
2331
client.Rejected("Disabled")
1529
if client._approved or not client.approval_delay:
1530
#We are approved or approval is disabled
2334
if client.approved or not client.approval_delay:
2335
# We are approved or approval is disabled
1532
elif client._approved is None:
2337
elif client.approved is None:
1533
2338
logger.info("Client %s needs approval",
1535
2340
if self.server.use_dbus:
1536
2341
# Emit D-Bus signal
1537
2342
client.NeedApproval(
1538
client.approval_delay_milliseconds(),
1539
client.approved_by_default)
2343
client.approval_delay.total_seconds()
2344
* 1000, client.approved_by_default)
1541
2346
logger.warning("Client %s was not approved",
2046
3064
use_ipv6 = server_settings["use_ipv6"]
2047
3065
stored_state_path = os.path.join(server_settings["statedir"],
2048
3066
stored_state_file)
3067
foreground = server_settings["foreground"]
3068
zeroconf = server_settings["zeroconf"]
2051
initlogger(logging.DEBUG)
3071
initlogger(debug, logging.DEBUG)
2053
3073
if not debuglevel:
2056
3076
level = getattr(logging, debuglevel.upper())
3077
initlogger(debug, level)
2059
3079
if server_settings["servicename"] != "Mandos":
2060
syslogger.setFormatter(logging.Formatter
2061
('Mandos (%s) [%%(process)d]:'
2062
' %%(levelname)s: %%(message)s'
2063
% server_settings["servicename"]))
3080
syslogger.setFormatter(
3081
logging.Formatter('Mandos ({}) [%(process)d]:'
3082
' %(levelname)s: %(message)s'.format(
3083
server_settings["servicename"])))
2065
3085
# Parse config file with clients
2066
client_defaults = { "timeout": "5m",
2067
"extended_timeout": "15m",
2069
"checker": "fping -q -- %%(host)s",
2071
"approval_delay": "0s",
2072
"approval_duration": "1s",
2074
client_config = configparser.SafeConfigParser(client_defaults)
3086
client_config = configparser.ConfigParser(Client.client_defaults)
2075
3087
client_config.read(os.path.join(server_settings["configdir"],
2076
3088
"clients.conf"))
2078
3090
global mandos_dbus_service
2079
3091
mandos_dbus_service = None
2081
tcp_server = MandosServer((server_settings["address"],
2082
server_settings["port"]),
2084
interface=(server_settings["interface"]
2088
server_settings["priority"],
2091
pidfilename = "/var/run/mandos.pid"
2093
pidfile = open(pidfilename, "w")
2095
logger.error("Could not open file %r", pidfilename)
2098
uid = pwd.getpwnam("_mandos").pw_uid
2099
gid = pwd.getpwnam("_mandos").pw_gid
2102
uid = pwd.getpwnam("mandos").pw_uid
2103
gid = pwd.getpwnam("mandos").pw_gid
3094
if server_settings["socket"] != "":
3095
socketfd = server_settings["socket"]
3096
tcp_server = MandosServer(
3097
(server_settings["address"], server_settings["port"]),
3099
interface=(server_settings["interface"] or None),
3101
gnutls_priority=server_settings["priority"],
3105
pidfilename = "/run/mandos.pid"
3106
if not os.path.isdir("/run/."):
3107
pidfilename = "/var/run/mandos.pid"
3110
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3111
except IOError as e:
3112
logger.error("Could not open file %r", pidfilename,
3115
for name, group in (("_mandos", "_mandos"),
3116
("mandos", "mandos"),
3117
("nobody", "nogroup")):
3119
uid = pwd.getpwnam(name).pw_uid
3120
gid = pwd.getpwnam(group).pw_gid
2104
3122
except KeyError:
2106
uid = pwd.getpwnam("nobody").pw_uid
2107
gid = pwd.getpwnam("nobody").pw_gid
3131
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2114
3133
except OSError as error:
2115
if error[0] != errno.EPERM:
3134
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3135
.format(uid, gid, os.strerror(error.errno)))
3136
if error.errno != errno.EPERM:
2119
3140
# Enable all possible GnuTLS debugging
2121
3142
# "Use a log level over 10 to enable all debugging options."
2122
3143
# - GnuTLS manual
2123
gnutls.library.functions.gnutls_global_set_log_level(11)
2125
@gnutls.library.types.gnutls_log_func
3144
gnutls.global_set_log_level(11)
2126
3147
def debug_gnutls(level, string):
2127
3148
logger.debug("GnuTLS: %s", string[:-1])
2129
(gnutls.library.functions
2130
.gnutls_global_set_log_function(debug_gnutls))
3150
gnutls.global_set_log_function(debug_gnutls)
2132
3152
# Redirect stdin so all checkers get /dev/null
2133
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3153
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2134
3154
os.dup2(null, sys.stdin.fileno())
2138
# No console logging
2139
logger.removeHandler(console)
2141
3158
# Need to fork before connecting to D-Bus
2143
3160
# Close all input and output, do double fork, etc.
3163
if gi.version_info < (3, 10, 2):
3164
# multiprocessing will use threads, so before we use GLib we
3165
# need to inform GLib that threads will be used.
2146
3168
global main_loop
2147
3169
# From the Avahi example code
2148
DBusGMainLoop(set_as_default=True )
2149
main_loop = gobject.MainLoop()
3170
DBusGMainLoop(set_as_default=True)
3171
main_loop = GLib.MainLoop()
2150
3172
bus = dbus.SystemBus()
2151
3173
# End of Avahi example code
2154
3176
bus_name = dbus.service.BusName("se.recompile.Mandos",
2155
bus, do_not_queue=True)
2156
old_bus_name = (dbus.service.BusName
2157
("se.bsnet.fukt.Mandos", bus,
2159
except dbus.exceptions.NameExistsException as e:
2160
logger.error(unicode(e) + ", disabling D-Bus")
3179
old_bus_name = dbus.service.BusName(
3180
"se.bsnet.fukt.Mandos", bus,
3182
except dbus.exceptions.DBusException as e:
3183
logger.error("Disabling D-Bus:", exc_info=e)
2161
3184
use_dbus = False
2162
3185
server_settings["use_dbus"] = False
2163
3186
tcp_server.use_dbus = False
2164
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2165
service = AvahiServiceToSyslog(name =
2166
server_settings["servicename"],
2167
servicetype = "_mandos._tcp",
2168
protocol = protocol, bus = bus)
2169
if server_settings["interface"]:
2170
service.interface = (if_nametoindex
2171
(str(server_settings["interface"])))
3188
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3189
service = AvahiServiceToSyslog(
3190
name=server_settings["servicename"],
3191
servicetype="_mandos._tcp",
3194
if server_settings["interface"]:
3195
service.interface = if_nametoindex(
3196
server_settings["interface"].encode("utf-8"))
2173
3198
global multiprocessing_manager
2174
3199
multiprocessing_manager = multiprocessing.Manager()
2176
3201
client_class = Client
2178
client_class = functools.partial(ClientDBusTransitional,
2181
special_settings = {
2182
# Some settings need to be accessd by special methods;
2183
# booleans need .getboolean(), etc. Here is a list of them:
2184
"approved_by_default":
2186
client_config.getboolean(section, "approved_by_default"),
2189
client_config.getboolean(section, "enabled"),
2191
# Construct a new dict of client settings of this form:
2192
# { client_name: {setting_name: value, ...}, ...}
2193
# with exceptions for any special settings as defined above
2194
client_settings = dict((clientname,
2197
if setting not in special_settings
2198
else special_settings[setting]
2200
for setting, value in
2201
client_config.items(clientname)))
2202
for clientname in client_config.sections())
3203
client_class = functools.partial(ClientDBus, bus=bus)
3205
client_settings = Client.config_parser(client_config)
2204
3206
old_client_settings = {}
3209
# This is used to redirect stdout and stderr for checker processes
3211
wnull = open(os.devnull, "w") # A writable /dev/null
3212
# Only used if server is running in foreground but not in debug
3214
if debug or not foreground:
2207
3217
# Get client data and settings from last running state.
2208
3218
if server_settings["restore"]:
2210
3220
with open(stored_state_path, "rb") as stored_state:
2211
clients_data, old_client_settings = (pickle.load
3221
if sys.version_info.major == 2:
3222
clients_data, old_client_settings = pickle.load(
3225
bytes_clients_data, bytes_old_client_settings = (
3226
pickle.load(stored_state, encoding="bytes"))
3227
# Fix bytes to strings
3230
clients_data = {(key.decode("utf-8")
3231
if isinstance(key, bytes)
3234
bytes_clients_data.items()}
3235
del bytes_clients_data
3236
for key in clients_data:
3237
value = {(k.decode("utf-8")
3238
if isinstance(k, bytes) else k): v
3240
clients_data[key].items()}
3241
clients_data[key] = value
3243
value["client_structure"] = [
3245
if isinstance(s, bytes)
3247
value["client_structure"]]
3249
for k in ("name", "host"):
3250
if isinstance(value[k], bytes):
3251
value[k] = value[k].decode("utf-8")
3252
if "key_id" not in value:
3253
value["key_id"] = ""
3254
elif "fingerprint" not in value:
3255
value["fingerprint"] = ""
3256
# old_client_settings
3258
old_client_settings = {
3259
(key.decode("utf-8")
3260
if isinstance(key, bytes)
3263
bytes_old_client_settings.items()}
3264
del bytes_old_client_settings
3266
for value in old_client_settings.values():
3267
if isinstance(value["host"], bytes):
3268
value["host"] = (value["host"]
2213
3270
os.remove(stored_state_path)
2214
3271
except IOError as e:
2215
logger.warning("Could not load persistent state: {0}"
2217
if e.errno != errno.ENOENT:
3272
if e.errno == errno.ENOENT:
3273
logger.warning("Could not load persistent state:"
3274
" {}".format(os.strerror(e.errno)))
3276
logger.critical("Could not load persistent state:",
2220
with Crypto() as crypt:
2221
for client in clients_data:
2222
client_name = client["name"]
3279
except EOFError as e:
3280
logger.warning("Could not load persistent state: "
3284
with PGPEngine() as pgp:
3285
for client_name, client in clients_data.items():
3286
# Skip removed clients
3287
if client_name not in client_settings:
2224
3290
# Decide which value to use after restoring saved state.
2225
3291
# We have three different values: Old config file,
2226
3292
# new config file, and saved state.
2231
3297
# For each value in new config, check if it
2232
3298
# differs from the old config value (Except for
2233
3299
# the "secret" attribute)
2234
if (name != "secret" and
2235
value != old_client_settings[client_name]
2237
setattr(client, name, value)
3300
if (name != "secret"
3302
old_client_settings[client_name][name])):
3303
client[name] = value
2238
3304
except KeyError:
2241
3307
# Clients who has passed its expire date can still be
2242
# enabled if its last checker was sucessful. Clients
2243
# whose checker failed before we stored its state is
2244
# assumed to have failed all checkers during downtime.
2245
if client["enabled"] and client["last_checked_ok"]:
2246
if ((datetime.datetime.utcnow()
2247
- client["last_checked_ok"])
2248
> client["interval"]):
2249
if client["last_checker_status"] != 0:
3308
# enabled if its last checker was successful. A Client
3309
# whose checker succeeded before we stored its state is
3310
# assumed to have successfully run all checkers during
3312
if client["enabled"]:
3313
if datetime.datetime.utcnow() >= client["expires"]:
3314
if not client["last_checked_ok"]:
3316
"disabling client {} - Client never "
3317
"performed a successful checker".format(
3319
client["enabled"] = False
3320
elif client["last_checker_status"] != 0:
3322
"disabling client {} - Client last"
3323
" checker failed with error code"
3326
client["last_checker_status"]))
2250
3327
client["enabled"] = False
2252
client["expires"] = (datetime.datetime
2254
+ client["timeout"])
2256
client["changedstate"] = (multiprocessing_manager
2258
(multiprocessing_manager
2261
new_client = (ClientDBusTransitional.__new__
2262
(ClientDBusTransitional))
2263
tcp_server.clients[client_name] = new_client
2264
new_client.bus = bus
2265
for name, value in client.iteritems():
2266
setattr(new_client, name, value)
2267
client_object_name = unicode(client_name).translate(
2268
{ord("."): ord("_"),
2269
ord("-"): ord("_")})
2270
new_client.dbus_object_path = (dbus.ObjectPath
2272
+ client_object_name))
2273
DBusObjectWithProperties.__init__(new_client,
2278
tcp_server.clients[client_name] = (Client.__new__
2280
for name, value in client.iteritems():
2281
setattr(tcp_server.clients[client_name],
3329
client["expires"] = (
3330
datetime.datetime.utcnow()
3331
+ client["timeout"])
3332
logger.debug("Last checker succeeded,"
3333
" keeping {} enabled".format(
2285
tcp_server.clients[client_name].secret = (
2286
crypt.decrypt(tcp_server.clients[client_name]
2288
client_settings[client_name]
3336
client["secret"] = pgp.decrypt(
3337
client["encrypted_secret"],
3338
client_settings[client_name]["secret"])
2291
3340
# If decryption fails, we use secret from new settings
2292
tcp_server.clients[client_name].secret = (
2293
client_settings[client_name]["secret"])
2295
# Create/remove clients based on new changes made to config
2296
for clientname in set(old_client_settings) - set(client_settings):
2297
del tcp_server.clients[clientname]
2298
for clientname in set(client_settings) - set(old_client_settings):
2299
tcp_server.clients[clientname] = (client_class(name
3341
logger.debug("Failed to decrypt {} old secret".format(
3343
client["secret"] = (client_settings[client_name]
3346
# Add/remove clients based on new changes made to config
3347
for client_name in (set(old_client_settings)
3348
- set(client_settings)):
3349
del clients_data[client_name]
3350
for client_name in (set(client_settings)
3351
- set(old_client_settings)):
3352
clients_data[client_name] = client_settings[client_name]
3354
# Create all client objects
3355
for client_name, client in clients_data.items():
3356
tcp_server.clients[client_name] = client_class(
3359
server_settings=server_settings)
2305
3361
if not tcp_server.clients:
2306
3362
logger.warning("No clients defined")
2312
pidfile.write(str(pid) + "\n".encode("utf-8"))
2315
logger.error("Could not write to file %r with PID %d",
2318
# "pidfile" was never created
3365
if pidfile is not None:
3369
print(pid, file=pidfile)
3371
logger.error("Could not write to file %r with PID %d",
2320
3374
del pidfilename
2322
signal.signal(signal.SIGINT, signal.SIG_IGN)
2324
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2325
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3376
for termsig in (signal.SIGHUP, signal.SIGTERM):
3377
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3378
lambda: main_loop.quit() and False)
2328
class MandosDBusService(dbus.service.Object):
3382
@alternate_dbus_interfaces(
3383
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3384
class MandosDBusService(DBusObjectWithObjectManager):
2329
3385
"""A D-Bus proxy object"""
2330
3387
def __init__(self):
2331
3388
dbus.service.Object.__init__(self, bus, "/")
2332
3390
_interface = "se.recompile.Mandos"
2334
3392
@dbus.service.signal(_interface, signature="o")
2335
3393
def ClientAdded(self, objpath):
2339
3397
@dbus.service.signal(_interface, signature="ss")
2340
def ClientNotFound(self, fingerprint, address):
3398
def ClientNotFound(self, key_id, address):
3402
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2344
3404
@dbus.service.signal(_interface, signature="os")
2345
3405
def ClientRemoved(self, objpath, name):
3409
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2349
3411
@dbus.service.method(_interface, out_signature="ao")
2350
3412
def GetAllClients(self):
2352
return dbus.Array(c.dbus_object_path
2354
tcp_server.clients.itervalues())
3414
return dbus.Array(c.dbus_object_path for c in
3415
tcp_server.clients.values())
3417
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2356
3419
@dbus.service.method(_interface,
2357
3420
out_signature="a{oa{sv}}")
2358
3421
def GetAllClientsWithProperties(self):
2360
3423
return dbus.Dictionary(
2361
((c.dbus_object_path, c.GetAll(""))
2362
for c in tcp_server.clients.itervalues()),
3424
{c.dbus_object_path: c.GetAll(
3425
"se.recompile.Mandos.Client")
3426
for c in tcp_server.clients.values()},
2363
3427
signature="oa{sv}")
2365
3429
@dbus.service.method(_interface, in_signature="o")
2366
3430
def RemoveClient(self, object_path):
2368
for c in tcp_server.clients.itervalues():
3432
for c in tcp_server.clients.values():
2369
3433
if c.dbus_object_path == object_path:
2370
3434
del tcp_server.clients[c.name]
2371
3435
c.remove_from_connection()
2372
# Don't signal anything except ClientRemoved
3436
# Don't signal the disabling
2373
3437
c.disable(quiet=True)
2375
self.ClientRemoved(object_path, c.name)
3438
# Emit D-Bus signal for removal
3439
self.client_removed_signal(c)
2377
3441
raise KeyError(object_path)
2381
class MandosDBusServiceTransitional(MandosDBusService):
2382
__metaclass__ = AlternateDBusNamesMetaclass
2383
mandos_dbus_service = MandosDBusServiceTransitional()
3445
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3446
out_signature="a{oa{sa{sv}}}")
3447
def GetManagedObjects(self):
3449
return dbus.Dictionary(
3450
{client.dbus_object_path:
3452
{interface: client.GetAll(interface)
3454
client._get_all_interface_names()})
3455
for client in tcp_server.clients.values()})
3457
def client_added_signal(self, client):
3458
"""Send the new standard signal and the old signal"""
3460
# New standard signal
3461
self.InterfacesAdded(
3462
client.dbus_object_path,
3464
{interface: client.GetAll(interface)
3466
client._get_all_interface_names()}))
3468
self.ClientAdded(client.dbus_object_path)
3470
def client_removed_signal(self, client):
3471
"""Send the new standard signal and the old signal"""
3473
# New standard signal
3474
self.InterfacesRemoved(
3475
client.dbus_object_path,
3476
client._get_all_interface_names())
3478
self.ClientRemoved(client.dbus_object_path,
3481
mandos_dbus_service = MandosDBusService()
3483
# Save modules to variables to exempt the modules from being
3484
# unloaded before the function registered with atexit() is run.
3485
mp = multiprocessing
2386
3489
"Cleanup function; run on exit"
2389
multiprocessing.active_children()
3493
mp.active_children()
2390
3495
if not (tcp_server.clients or client_settings):
2393
3498
# Store client before exiting. Secrets are encrypted with key
2394
3499
# based on what config file has. If config file is
2395
3500
# removed/edited, old secret will thus be unrecovable.
2397
with Crypto() as crypt:
2398
for client in tcp_server.clients.itervalues():
3502
with PGPEngine() as pgp:
3503
for client in tcp_server.clients.values():
2399
3504
key = client_settings[client.name]["secret"]
2400
client.encrypted_secret = crypt.encrypt(client.secret,
3505
client.encrypted_secret = pgp.encrypt(client.secret,
2402
3507
client_dict = {}
2404
# A list of attributes that will not be stored when
2406
exclude = set(("bus", "changedstate", "secret"))
2407
for name, typ in (inspect.getmembers
2408
(dbus.service.Object)):
3509
# A list of attributes that can not be pickled
3511
exclude = {"bus", "changedstate", "secret",
3512
"checker", "server_settings"}
3513
for name, typ in inspect.getmembers(dbus.service
2409
3515
exclude.add(name)
2411
3517
client_dict["encrypted_secret"] = (client
2412
3518
.encrypted_secret)
2413
3519
for attr in client.client_structure:
2414
3520
if attr not in exclude:
2415
3521
client_dict[attr] = getattr(client, attr)
2417
clients.append(client_dict)
3523
clients[client.name] = client_dict
2418
3524
del client_settings[client.name]["secret"]
2421
with os.fdopen(os.open(stored_state_path,
2422
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2423
0600), "wb") as stored_state:
2424
pickle.dump((clients, client_settings), stored_state)
3527
with tempfile.NamedTemporaryFile(
3531
dir=os.path.dirname(stored_state_path),
3532
delete=False) as stored_state:
3533
pickle.dump((clients, client_settings), stored_state,
3535
tempname = stored_state.name
3536
os.rename(tempname, stored_state_path)
2425
3537
except (IOError, OSError) as e:
2426
logger.warning("Could not save persistent state: {0}"
2428
if e.errno not in (errno.ENOENT, errno.EACCES):
3543
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3544
logger.warning("Could not save persistent state: {}"
3545
.format(os.strerror(e.errno)))
3547
logger.warning("Could not save persistent state:",
2431
3551
# Delete all clients, and settings from config
2432
3552
while tcp_server.clients:
2433
3553
name, client = tcp_server.clients.popitem()
2435
3555
client.remove_from_connection()
2436
# Don't signal anything except ClientRemoved
3556
# Don't signal the disabling
2437
3557
client.disable(quiet=True)
3558
# Emit D-Bus signal for removal
2440
mandos_dbus_service.ClientRemoved(client
3560
mandos_dbus_service.client_removed_signal(client)
2443
3561
client_settings.clear()
2445
3563
atexit.register(cleanup)
2447
for client in tcp_server.clients.itervalues():
3565
for client in tcp_server.clients.values():
2450
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3567
# Emit D-Bus signal for adding
3568
mandos_dbus_service.client_added_signal(client)
2451
3569
# Need to initiate checking of clients
2452
3570
if client.enabled:
2453
3571
client.init_checker()
2455
3573
tcp_server.enable()
2456
3574
tcp_server.server_activate()
2458
3576
# Find out what port we got
2459
service.port = tcp_server.socket.getsockname()[1]
3578
service.port = tcp_server.socket.getsockname()[1]
2461
3580
logger.info("Now listening on address %r, port %d,"
2462
" flowinfo %d, scope_id %d"
2463
% tcp_server.socket.getsockname())
3581
" flowinfo %d, scope_id %d",
3582
*tcp_server.socket.getsockname())
2465
logger.info("Now listening on address %r, port %d"
2466
% tcp_server.socket.getsockname())
2468
#service.interface = tcp_server.socket.getsockname()[3]
3584
logger.info("Now listening on address %r, port %d",
3585
*tcp_server.socket.getsockname())
3587
# service.interface = tcp_server.socket.getsockname()[3]
2471
# From the Avahi example code
2474
except dbus.exceptions.DBusException as error:
2475
logger.critical("DBusException: %s", error)
2478
# End of Avahi example code
2480
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2481
lambda *args, **kwargs:
2482
(tcp_server.handle_request
2483
(*args[2:], **kwargs) or True))
3591
# From the Avahi example code
3594
except dbus.exceptions.DBusException as error:
3595
logger.critical("D-Bus Exception", exc_info=error)
3598
# End of Avahi example code
3600
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3601
lambda *args, **kwargs:
3602
(tcp_server.handle_request
3603
(*args[2:], **kwargs) or True))
2485
3605
logger.debug("Starting main loop")
2486
3606
main_loop.run()
2487
3607
except AvahiError as error:
2488
logger.critical("AvahiError: %s", error)
3608
logger.critical("Avahi Error", exc_info=error)
2491
3611
except KeyboardInterrupt: