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