189
431
dbus.UInt16(self.port),
190
432
avahi.string_array_to_txt_array(self.TXT))
191
433
self.group.Commit()
192
435
def entry_group_state_changed(self, state, error):
193
436
"""Derived from the Avahi example code"""
194
logger.debug(u"Avahi state change: %i", state)
437
logger.debug("Avahi entry group state change: %i", state)
196
439
if state == avahi.ENTRY_GROUP_ESTABLISHED:
197
logger.debug(u"Zeroconf service established.")
440
logger.debug("Zeroconf service established.")
198
441
elif state == avahi.ENTRY_GROUP_COLLISION:
199
logger.warning(u"Zeroconf service name collision.")
442
logger.info("Zeroconf service name collision.")
201
444
elif state == avahi.ENTRY_GROUP_FAILURE:
202
logger.critical(u"Avahi: Error in group state changed %s",
204
raise AvahiGroupError(u"State changed: %s"
445
logger.critical("Avahi: Error in group state changed %s",
447
raise AvahiGroupError("State changed: {!s}".format(error))
206
449
def cleanup(self):
207
450
"""Derived from the Avahi example code"""
208
451
if self.group is not None:
454
except (dbus.exceptions.UnknownMethodException,
455
dbus.exceptions.DBusException):
210
457
self.group = None
211
def server_state_changed(self, state):
460
def server_state_changed(self, state, error=None):
212
461
"""Derived from the Avahi example code"""
213
if state == avahi.SERVER_COLLISION:
214
logger.error(u"Zeroconf server name collision")
462
logger.debug("Avahi server state change: %i", state)
464
avahi.SERVER_INVALID: "Zeroconf server invalid",
465
avahi.SERVER_REGISTERING: None,
466
avahi.SERVER_COLLISION: "Zeroconf server name collision",
467
avahi.SERVER_FAILURE: "Zeroconf server failure",
469
if state in bad_states:
470
if bad_states[state] is not None:
472
logger.error(bad_states[state])
474
logger.error(bad_states[state] + ": %r", error)
216
476
elif state == avahi.SERVER_RUNNING:
479
except dbus.exceptions.DBusException as error:
480
if (error.get_dbus_name()
481
== "org.freedesktop.Avahi.CollisionError"):
482
logger.info("Local Zeroconf service name"
484
return self.rename(remove=False)
486
logger.critical("D-Bus Exception", exc_info=error)
491
logger.debug("Unknown state: %r", state)
493
logger.debug("Unknown state: %r: %r", state, error)
218
495
def activate(self):
219
496
"""Derived from the Avahi example code"""
220
497
if self.server is None:
221
498
self.server = dbus.Interface(
222
499
self.bus.get_object(avahi.DBUS_NAME,
223
avahi.DBUS_PATH_SERVER),
500
avahi.DBUS_PATH_SERVER,
501
follow_name_owner_changes=True),
224
502
avahi.DBUS_INTERFACE_SERVER)
225
self.server.connect_to_signal(u"StateChanged",
226
self.server_state_changed)
503
self.server.connect_to_signal("StateChanged",
504
self.server_state_changed)
227
505
self.server_state_changed(self.server.GetState())
230
class Client(object):
508
class AvahiServiceToSyslog(AvahiService):
509
def rename(self, *args, **kwargs):
510
"""Add the new name to the syslog messages"""
511
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
512
syslogger.setFormatter(logging.Formatter(
513
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
518
# Pretend that we have a GnuTLS module
520
"""This isn't so much a class as it is a module-like namespace."""
522
library = ctypes.util.find_library("gnutls")
524
library = ctypes.util.find_library("gnutls-deb0")
525
_library = ctypes.cdll.LoadLibrary(library)
528
# Unless otherwise indicated, the constants and types below are
529
# all from the gnutls/gnutls.h C header file.
540
E_NO_CERTIFICATE_FOUND = -49
545
KEYID_USE_SHA256 = 1 # gnutls/x509.h
546
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
549
class session_int(ctypes.Structure):
551
session_t = ctypes.POINTER(session_int)
553
class certificate_credentials_st(ctypes.Structure):
555
certificate_credentials_t = ctypes.POINTER(
556
certificate_credentials_st)
557
certificate_type_t = ctypes.c_int
559
class datum_t(ctypes.Structure):
560
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
561
('size', ctypes.c_uint)]
563
class openpgp_crt_int(ctypes.Structure):
565
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
566
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
567
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
568
credentials_type_t = ctypes.c_int
569
transport_ptr_t = ctypes.c_void_p
570
close_request_t = ctypes.c_int
573
class Error(Exception):
574
def __init__(self, message=None, code=None, args=()):
575
# Default usage is by a message string, but if a return
576
# code is passed, convert it to a string with
579
if message is None and code is not None:
580
message = gnutls.strerror(code)
581
return super(gnutls.Error, self).__init__(
584
class CertificateSecurityError(Error):
590
self._c_object = gnutls.certificate_credentials_t()
591
gnutls.certificate_allocate_credentials(
592
ctypes.byref(self._c_object))
593
self.type = gnutls.CRD_CERTIFICATE
596
gnutls.certificate_free_credentials(self._c_object)
599
def __init__(self, socket, credentials=None):
600
self._c_object = gnutls.session_t()
601
gnutls_flags = gnutls.CLIENT
602
if gnutls.check_version(b"3.5.6"):
603
gnutls_flags |= gnutls.NO_TICKETS
605
gnutls_flags |= gnutls.ENABLE_RAWPK
606
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
608
gnutls.set_default_priority(self._c_object)
609
gnutls.transport_set_ptr(self._c_object, socket.fileno())
610
gnutls.handshake_set_private_extensions(self._c_object,
613
if credentials is None:
614
credentials = gnutls.Credentials()
615
gnutls.credentials_set(self._c_object, credentials.type,
616
ctypes.cast(credentials._c_object,
618
self.credentials = credentials
621
gnutls.deinit(self._c_object)
624
return gnutls.handshake(self._c_object)
626
def send(self, data):
630
data_len -= gnutls.record_send(self._c_object,
635
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
637
# Error handling functions
638
def _error_code(result):
639
"""A function to raise exceptions on errors, suitable
640
for the 'restype' attribute on ctypes functions"""
643
if result == gnutls.E_NO_CERTIFICATE_FOUND:
644
raise gnutls.CertificateSecurityError(code=result)
645
raise gnutls.Error(code=result)
647
def _retry_on_error(result, func, arguments):
648
"""A function to retry on some errors, suitable
649
for the 'errcheck' attribute on ctypes functions"""
651
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
652
return _error_code(result)
653
result = func(*arguments)
656
# Unless otherwise indicated, the function declarations below are
657
# all from the gnutls/gnutls.h C header file.
660
priority_set_direct = _library.gnutls_priority_set_direct
661
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
662
ctypes.POINTER(ctypes.c_char_p)]
663
priority_set_direct.restype = _error_code
665
init = _library.gnutls_init
666
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
667
init.restype = _error_code
669
set_default_priority = _library.gnutls_set_default_priority
670
set_default_priority.argtypes = [session_t]
671
set_default_priority.restype = _error_code
673
record_send = _library.gnutls_record_send
674
record_send.argtypes = [session_t, ctypes.c_void_p,
676
record_send.restype = ctypes.c_ssize_t
677
record_send.errcheck = _retry_on_error
679
certificate_allocate_credentials = (
680
_library.gnutls_certificate_allocate_credentials)
681
certificate_allocate_credentials.argtypes = [
682
ctypes.POINTER(certificate_credentials_t)]
683
certificate_allocate_credentials.restype = _error_code
685
certificate_free_credentials = (
686
_library.gnutls_certificate_free_credentials)
687
certificate_free_credentials.argtypes = [
688
certificate_credentials_t]
689
certificate_free_credentials.restype = None
691
handshake_set_private_extensions = (
692
_library.gnutls_handshake_set_private_extensions)
693
handshake_set_private_extensions.argtypes = [session_t,
695
handshake_set_private_extensions.restype = None
697
credentials_set = _library.gnutls_credentials_set
698
credentials_set.argtypes = [session_t, credentials_type_t,
700
credentials_set.restype = _error_code
702
strerror = _library.gnutls_strerror
703
strerror.argtypes = [ctypes.c_int]
704
strerror.restype = ctypes.c_char_p
706
certificate_type_get = _library.gnutls_certificate_type_get
707
certificate_type_get.argtypes = [session_t]
708
certificate_type_get.restype = _error_code
710
certificate_get_peers = _library.gnutls_certificate_get_peers
711
certificate_get_peers.argtypes = [session_t,
712
ctypes.POINTER(ctypes.c_uint)]
713
certificate_get_peers.restype = ctypes.POINTER(datum_t)
715
global_set_log_level = _library.gnutls_global_set_log_level
716
global_set_log_level.argtypes = [ctypes.c_int]
717
global_set_log_level.restype = None
719
global_set_log_function = _library.gnutls_global_set_log_function
720
global_set_log_function.argtypes = [log_func]
721
global_set_log_function.restype = None
723
deinit = _library.gnutls_deinit
724
deinit.argtypes = [session_t]
725
deinit.restype = None
727
handshake = _library.gnutls_handshake
728
handshake.argtypes = [session_t]
729
handshake.restype = _error_code
730
handshake.errcheck = _retry_on_error
732
transport_set_ptr = _library.gnutls_transport_set_ptr
733
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
734
transport_set_ptr.restype = None
736
bye = _library.gnutls_bye
737
bye.argtypes = [session_t, close_request_t]
738
bye.restype = _error_code
739
bye.errcheck = _retry_on_error
741
check_version = _library.gnutls_check_version
742
check_version.argtypes = [ctypes.c_char_p]
743
check_version.restype = ctypes.c_char_p
745
_need_version = b"3.3.0"
746
if check_version(_need_version) is None:
747
raise self.Error("Needs GnuTLS {} or later"
748
.format(_need_version))
750
_tls_rawpk_version = b"3.6.6"
751
has_rawpk = bool(check_version(_tls_rawpk_version))
755
class pubkey_st(ctypes.Structure):
757
pubkey_t = ctypes.POINTER(pubkey_st)
759
x509_crt_fmt_t = ctypes.c_int
761
# All the function declarations below are from gnutls/abstract.h
762
pubkey_init = _library.gnutls_pubkey_init
763
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
764
pubkey_init.restype = _error_code
766
pubkey_import = _library.gnutls_pubkey_import
767
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
769
pubkey_import.restype = _error_code
771
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
772
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
773
ctypes.POINTER(ctypes.c_ubyte),
774
ctypes.POINTER(ctypes.c_size_t)]
775
pubkey_get_key_id.restype = _error_code
777
pubkey_deinit = _library.gnutls_pubkey_deinit
778
pubkey_deinit.argtypes = [pubkey_t]
779
pubkey_deinit.restype = None
781
# All the function declarations below are from gnutls/openpgp.h
783
openpgp_crt_init = _library.gnutls_openpgp_crt_init
784
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
785
openpgp_crt_init.restype = _error_code
787
openpgp_crt_import = _library.gnutls_openpgp_crt_import
788
openpgp_crt_import.argtypes = [openpgp_crt_t,
789
ctypes.POINTER(datum_t),
791
openpgp_crt_import.restype = _error_code
793
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
794
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
795
ctypes.POINTER(ctypes.c_uint)]
796
openpgp_crt_verify_self.restype = _error_code
798
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
799
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
800
openpgp_crt_deinit.restype = None
802
openpgp_crt_get_fingerprint = (
803
_library.gnutls_openpgp_crt_get_fingerprint)
804
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
808
openpgp_crt_get_fingerprint.restype = _error_code
810
if check_version(b"3.6.4"):
811
certificate_type_get2 = _library.gnutls_certificate_type_get2
812
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
813
certificate_type_get2.restype = _error_code
815
# Remove non-public functions
816
del _error_code, _retry_on_error
819
def call_pipe(connection, # : multiprocessing.Connection
820
func, *args, **kwargs):
821
"""This function is meant to be called by multiprocessing.Process
823
This function runs func(*args, **kwargs), and writes the resulting
824
return value on the provided multiprocessing.Connection.
826
connection.send(func(*args, **kwargs))
231
831
"""A representation of a client host served by this server.
834
approved: bool(); 'None' if not yet approved/disapproved
835
approval_delay: datetime.timedelta(); Time to wait for approval
836
approval_duration: datetime.timedelta(); Duration of one approval
837
checker: multiprocessing.Process(); a running checker process used
838
to see if the client lives. 'None' if no process is
840
checker_callback_tag: a GLib event source tag, or None
841
checker_command: string; External command which is run to check
842
if client lives. %() expansions are done at
843
runtime with vars(self) as dict, so that for
844
instance %(name)s can be used in the command.
845
checker_initiator_tag: a GLib event source tag, or None
846
created: datetime.datetime(); (UTC) object creation
847
client_structure: Object describing what attributes a client has
848
and is used for storing the client at exit
849
current_checker_command: string; current running checker_command
850
disable_initiator_tag: a GLib event source tag, or None
852
fingerprint: string (40 or 32 hexadecimal digits); used to
853
uniquely identify an OpenPGP client
854
key_id: string (64 hexadecimal digits); used to uniquely identify
855
a client using raw public keys
856
host: string; available for use by the checker command
857
interval: datetime.timedelta(); How often to start a new checker
858
last_approval_request: datetime.datetime(); (UTC) or None
859
last_checked_ok: datetime.datetime(); (UTC) or None
860
last_checker_status: integer between 0 and 255 reflecting exit
861
status of last checker. -1 reflects crashed
862
checker, -2 means no checker completed yet.
863
last_checker_signal: The signal which killed the last checker, if
864
last_checker_status is -1
865
last_enabled: datetime.datetime(); (UTC) or None
234
866
name: string; from the config file, used in log messages and
235
867
D-Bus identifiers
236
fingerprint: string (40 or 32 hexadecimal digits); used to
237
uniquely identify the client
238
868
secret: bytestring; sent verbatim (over TLS) to client
239
host: string; available for use by the checker command
240
created: datetime.datetime(); (UTC) object creation
241
last_enabled: datetime.datetime(); (UTC)
243
last_checked_ok: datetime.datetime(); (UTC) or None
244
869
timeout: datetime.timedelta(); How long from last_checked_ok
245
until this client is invalid
246
interval: datetime.timedelta(); How often to start a new checker
247
disable_hook: If set, called by disable() as disable_hook(self)
248
checker: subprocess.Popen(); a running checker process used
249
to see if the client lives.
250
'None' if no process is running.
251
checker_initiator_tag: a gobject event source tag, or None
252
disable_initiator_tag: - '' -
253
checker_callback_tag: - '' -
254
checker_command: string; External command which is run to check if
255
client lives. %() expansions are done at
256
runtime with vars(self) as dict, so that for
257
instance %(name)s can be used in the command.
258
current_checker_command: string; current running checker_command
870
until this client is disabled
871
extended_timeout: extra long timeout when secret has been sent
872
runtime_expansions: Allowed attributes for runtime expansion.
873
expires: datetime.datetime(); time (UTC) when a client will be
875
server_settings: The server_settings dict from main()
878
runtime_expansions = ("approval_delay", "approval_duration",
879
"created", "enabled", "expires", "key_id",
880
"fingerprint", "host", "interval",
881
"last_approval_request", "last_checked_ok",
882
"last_enabled", "name", "timeout")
885
"extended_timeout": "PT15M",
887
"checker": "fping -q -- %%(host)s",
889
"approval_delay": "PT0S",
890
"approval_duration": "PT1S",
891
"approved_by_default": "True",
262
def _timedelta_to_milliseconds(td):
263
"Convert a datetime.timedelta() to milliseconds"
264
return ((td.days * 24 * 60 * 60 * 1000)
265
+ (td.seconds * 1000)
266
+ (td.microseconds // 1000))
268
def timeout_milliseconds(self):
269
"Return the 'timeout' attribute in milliseconds"
270
return self._timedelta_to_milliseconds(self.timeout)
272
def interval_milliseconds(self):
273
"Return the 'interval' attribute in milliseconds"
274
return self._timedelta_to_milliseconds(self.interval)
276
def __init__(self, name = None, disable_hook=None, config=None):
277
"""Note: the 'checker' key in 'config' sets the
278
'checker_command' attribute and *not* the 'checker'
896
def config_parser(config):
897
"""Construct a new dict of client settings of this form:
898
{ client_name: {setting_name: value, ...}, ...}
899
with exceptions for any special settings as defined above.
900
NOTE: Must be a pure function. Must return the same result
901
value given the same arguments.
904
for client_name in config.sections():
905
section = dict(config.items(client_name))
906
client = settings[client_name] = {}
908
client["host"] = section["host"]
909
# Reformat values from string types to Python types
910
client["approved_by_default"] = config.getboolean(
911
client_name, "approved_by_default")
912
client["enabled"] = config.getboolean(client_name,
915
# Uppercase and remove spaces from key_id and fingerprint
916
# for later comparison purposes with return value from the
917
# key_id() and fingerprint() functions
918
client["key_id"] = (section.get("key_id", "").upper()
920
client["fingerprint"] = (section["fingerprint"].upper()
922
if "secret" in section:
923
client["secret"] = codecs.decode(section["secret"]
926
elif "secfile" in section:
927
with open(os.path.expanduser(os.path.expandvars
928
(section["secfile"])),
930
client["secret"] = secfile.read()
932
raise TypeError("No secret or secfile for section {}"
934
client["timeout"] = string_to_delta(section["timeout"])
935
client["extended_timeout"] = string_to_delta(
936
section["extended_timeout"])
937
client["interval"] = string_to_delta(section["interval"])
938
client["approval_delay"] = string_to_delta(
939
section["approval_delay"])
940
client["approval_duration"] = string_to_delta(
941
section["approval_duration"])
942
client["checker_command"] = section["checker"]
943
client["last_approval_request"] = None
944
client["last_checked_ok"] = None
945
client["last_checker_status"] = -2
949
def __init__(self, settings, name=None, server_settings=None):
283
logger.debug(u"Creating client %r", self.name)
284
# Uppercase and remove spaces from fingerprint for later
285
# comparison purposes with return value from the fingerprint()
287
self.fingerprint = (config[u"fingerprint"].upper()
289
logger.debug(u" Fingerprint: %s", self.fingerprint)
290
if u"secret" in config:
291
self.secret = config[u"secret"].decode(u"base64")
292
elif u"secfile" in config:
293
with closing(open(os.path.expanduser
295
(config[u"secfile"])),
297
self.secret = secfile.read()
951
if server_settings is None:
953
self.server_settings = server_settings
954
# adding all client settings
955
for setting, value in settings.items():
956
setattr(self, setting, value)
959
if not hasattr(self, "last_enabled"):
960
self.last_enabled = datetime.datetime.utcnow()
961
if not hasattr(self, "expires"):
962
self.expires = (datetime.datetime.utcnow()
299
raise TypeError(u"No secret or secfile for client %s"
301
self.host = config.get(u"host", u"")
302
self.created = datetime.datetime.utcnow()
304
self.last_enabled = None
305
self.last_checked_ok = None
306
self.timeout = string_to_delta(config[u"timeout"])
307
self.interval = string_to_delta(config[u"interval"])
308
self.disable_hook = disable_hook
965
self.last_enabled = None
968
logger.debug("Creating client %r", self.name)
969
logger.debug(" Key ID: %s", self.key_id)
970
logger.debug(" Fingerprint: %s", self.fingerprint)
971
self.created = settings.get("created",
972
datetime.datetime.utcnow())
974
# attributes specific for this server instance
309
975
self.checker = None
310
976
self.checker_initiator_tag = None
311
977
self.disable_initiator_tag = None
312
978
self.checker_callback_tag = None
313
self.checker_command = config[u"checker"]
314
979
self.current_checker_command = None
315
self.last_connect = None
981
self.approvals_pending = 0
982
self.changedstate = multiprocessing_manager.Condition(
983
multiprocessing_manager.Lock())
984
self.client_structure = [attr
985
for attr in self.__dict__.keys()
986
if not attr.startswith("_")]
987
self.client_structure.append("client_structure")
989
for name, t in inspect.getmembers(
990
type(self), lambda obj: isinstance(obj, property)):
991
if not name.startswith("_"):
992
self.client_structure.append(name)
994
# Send notice to process children that client state has changed
995
def send_changedstate(self):
996
with self.changedstate:
997
self.changedstate.notify_all()
317
999
def enable(self):
318
1000
"""Start this client's checker and timeout hooks"""
319
if getattr(self, u"enabled", False):
1001
if getattr(self, "enabled", False):
320
1002
# Already enabled
1004
self.expires = datetime.datetime.utcnow() + self.timeout
322
1006
self.last_enabled = datetime.datetime.utcnow()
1008
self.send_changedstate()
1010
def disable(self, quiet=True):
1011
"""Disable this client."""
1012
if not getattr(self, "enabled", False):
1015
logger.info("Disabling client %s", self.name)
1016
if getattr(self, "disable_initiator_tag", None) is not None:
1017
GLib.source_remove(self.disable_initiator_tag)
1018
self.disable_initiator_tag = None
1020
if getattr(self, "checker_initiator_tag", None) is not None:
1021
GLib.source_remove(self.checker_initiator_tag)
1022
self.checker_initiator_tag = None
1024
self.enabled = False
1026
self.send_changedstate()
1027
# Do not run this again if called by a GLib.timeout_add
1033
def init_checker(self):
323
1034
# Schedule a new checker to be started an 'interval' from now,
324
1035
# and every interval from then on.
325
self.checker_initiator_tag = (gobject.timeout_add
326
(self.interval_milliseconds(),
1036
if self.checker_initiator_tag is not None:
1037
GLib.source_remove(self.checker_initiator_tag)
1038
self.checker_initiator_tag = GLib.timeout_add(
1039
random.randrange(int(self.interval.total_seconds() * 1000
1042
# Schedule a disable() when 'timeout' has passed
1043
if self.disable_initiator_tag is not None:
1044
GLib.source_remove(self.disable_initiator_tag)
1045
self.disable_initiator_tag = GLib.timeout_add(
1046
int(self.timeout.total_seconds() * 1000), self.disable)
328
1047
# Also start a new checker *right now*.
329
1048
self.start_checker()
330
# Schedule a disable() when 'timeout' has passed
331
self.disable_initiator_tag = (gobject.timeout_add
332
(self.timeout_milliseconds(),
337
"""Disable this client."""
338
if not getattr(self, "enabled", False):
340
logger.info(u"Disabling client %s", self.name)
341
if getattr(self, u"disable_initiator_tag", False):
342
gobject.source_remove(self.disable_initiator_tag)
343
self.disable_initiator_tag = None
344
if getattr(self, u"checker_initiator_tag", False):
345
gobject.source_remove(self.checker_initiator_tag)
346
self.checker_initiator_tag = None
348
if self.disable_hook:
349
self.disable_hook(self)
351
# Do not run this again if called by a gobject.timeout_add
355
self.disable_hook = None
358
def checker_callback(self, pid, condition, command):
1050
def checker_callback(self, source, condition, connection,
359
1052
"""The checker has completed, so take appropriate actions."""
1053
# Read return code from connection (see call_pipe)
1054
returncode = connection.recv()
1056
if self.checker is not None:
360
1058
self.checker_callback_tag = None
361
1059
self.checker = None
362
if os.WIFEXITED(condition):
363
exitstatus = os.WEXITSTATUS(condition)
365
logger.info(u"Checker for %(name)s succeeded",
1062
self.last_checker_status = returncode
1063
self.last_checker_signal = None
1064
if self.last_checker_status == 0:
1065
logger.info("Checker for %(name)s succeeded",
367
1067
self.checked_ok()
369
logger.info(u"Checker for %(name)s failed",
1069
logger.info("Checker for %(name)s failed", vars(self))
372
logger.warning(u"Checker for %(name)s crashed?",
1071
self.last_checker_status = -1
1072
self.last_checker_signal = -returncode
1073
logger.warning("Checker for %(name)s crashed?",
375
1077
def checked_ok(self):
376
"""Bump up the timeout for this client.
378
This should only be called when the client has been seen,
1078
"""Assert that the client has been seen, alive and well."""
381
1079
self.last_checked_ok = datetime.datetime.utcnow()
382
gobject.source_remove(self.disable_initiator_tag)
383
self.disable_initiator_tag = (gobject.timeout_add
384
(self.timeout_milliseconds(),
1080
self.last_checker_status = 0
1081
self.last_checker_signal = None
1084
def bump_timeout(self, timeout=None):
1085
"""Bump up the timeout for this client."""
1087
timeout = self.timeout
1088
if self.disable_initiator_tag is not None:
1089
GLib.source_remove(self.disable_initiator_tag)
1090
self.disable_initiator_tag = None
1091
if getattr(self, "enabled", False):
1092
self.disable_initiator_tag = GLib.timeout_add(
1093
int(timeout.total_seconds() * 1000), self.disable)
1094
self.expires = datetime.datetime.utcnow() + timeout
1096
def need_approval(self):
1097
self.last_approval_request = datetime.datetime.utcnow()
387
1099
def start_checker(self):
388
1100
"""Start a new checker subprocess if one is not running.
390
1102
If a checker already exists, leave it running and do
392
1104
# The reason for not killing a running checker is that if we
393
# did that, then if a checker (for some reason) started
394
# running slowly and taking more than 'interval' time, the
395
# client would inevitably timeout, since no checker would get
396
# a chance to run to completion. If we instead leave running
1105
# did that, and if a checker (for some reason) started running
1106
# slowly and taking more than 'interval' time, then the client
1107
# would inevitably timeout, since no checker would get a
1108
# chance to run to completion. If we instead leave running
397
1109
# checkers alone, the checker would have to take more time
398
# than 'timeout' for the client to be declared invalid, which
399
# is as it should be.
401
# If a checker exists, make sure it is not a zombie
403
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
404
except (AttributeError, OSError), error:
405
if (isinstance(error, OSError)
406
and error.errno != errno.ECHILD):
410
logger.warning(u"Checker was a zombie")
411
gobject.source_remove(self.checker_callback_tag)
412
self.checker_callback(pid, status,
413
self.current_checker_command)
1110
# than 'timeout' for the client to be disabled, which is as it
1113
if self.checker is not None and not self.checker.is_alive():
1114
logger.warning("Checker was not alive; joining")
414
1117
# Start a new checker if needed
415
1118
if self.checker is None:
1119
# Escape attributes for the shell
1121
attr: re.escape(str(getattr(self, attr)))
1122
for attr in self.runtime_expansions}
417
# In case checker_command has exactly one % operator
418
command = self.checker_command % self.host
420
# Escape attributes for the shell
421
escaped_attrs = dict((key,
422
re.escape(unicode(str(val),
426
vars(self).iteritems())
428
command = self.checker_command % escaped_attrs
429
except TypeError, error:
430
logger.error(u'Could not format string "%s":'
431
u' %s', self.checker_command, error)
432
return True # Try again later
1124
command = self.checker_command % escaped_attrs
1125
except TypeError as error:
1126
logger.error('Could not format string "%s"',
1127
self.checker_command,
1129
return True # Try again later
433
1130
self.current_checker_command = command
435
logger.info(u"Starting checker %r for %s",
437
# We don't need to redirect stdout and stderr, since
438
# in normal mode, that is already done by daemon(),
439
# and in debug mode we don't want to. (Stdin is
440
# always replaced by /dev/null.)
441
self.checker = subprocess.Popen(command,
443
shell=True, cwd=u"/")
444
self.checker_callback_tag = (gobject.child_watch_add
446
self.checker_callback,
448
# The checker may have completed before the gobject
449
# watch was added. Check for this.
450
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
452
gobject.source_remove(self.checker_callback_tag)
453
self.checker_callback(pid, status, command)
454
except OSError, error:
455
logger.error(u"Failed to start subprocess: %s",
457
# Re-run this periodically if run by gobject.timeout_add
1131
logger.info("Starting checker %r for %s", command,
1133
# We don't need to redirect stdout and stderr, since
1134
# in normal mode, that is already done by daemon(),
1135
# and in debug mode we don't want to. (Stdin is
1136
# always replaced by /dev/null.)
1137
# The exception is when not debugging but nevertheless
1138
# running in the foreground; use the previously
1140
popen_args = {"close_fds": True,
1143
if (not self.server_settings["debug"]
1144
and self.server_settings["foreground"]):
1145
popen_args.update({"stdout": wnull,
1147
pipe = multiprocessing.Pipe(duplex=False)
1148
self.checker = multiprocessing.Process(
1150
args=(pipe[1], subprocess.call, command),
1152
self.checker.start()
1153
self.checker_callback_tag = GLib.io_add_watch(
1154
GLib.IOChannel.unix_new(pipe[0].fileno()),
1155
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1156
self.checker_callback, pipe[0], command)
1157
# Re-run this periodically if run by GLib.timeout_add
460
1160
def stop_checker(self):
461
1161
"""Force the checker process, if any, to stop."""
462
1162
if self.checker_callback_tag:
463
gobject.source_remove(self.checker_callback_tag)
1163
GLib.source_remove(self.checker_callback_tag)
464
1164
self.checker_callback_tag = None
465
if getattr(self, u"checker", None) is None:
1165
if getattr(self, "checker", None) is None:
467
logger.debug(u"Stopping checker for %(name)s", vars(self))
469
os.kill(self.checker.pid, signal.SIGTERM)
471
#if self.checker.poll() is None:
472
# os.kill(self.checker.pid, signal.SIGKILL)
473
except OSError, error:
474
if error.errno != errno.ESRCH: # No such process
1167
logger.debug("Stopping checker for %(name)s", vars(self))
1168
self.checker.terminate()
476
1169
self.checker = None
478
def still_valid(self):
479
"""Has the timeout not yet passed for this client?"""
480
if not getattr(self, u"enabled", False):
482
now = datetime.datetime.utcnow()
483
if self.last_checked_ok is None:
484
return now < (self.created + self.timeout)
486
return now < (self.last_checked_ok + self.timeout)
489
def dbus_service_property(dbus_interface, signature=u"v",
490
access=u"readwrite", byte_arrays=False):
1172
def dbus_service_property(dbus_interface,
491
1176
"""Decorators for marking methods of a DBusObjectWithProperties to
492
1177
become properties on the D-Bus.
494
1179
The decorated method will be called with no arguments by "Get"
495
1180
and with one argument by "Set".
497
1182
The parameters, where they are supported, are the same as
498
1183
dbus.service.method, except there is only "signature", since the
499
1184
type from Get() and the type sent to Set() is the same.
1186
# Encoding deeply encoded byte arrays is not supported yet by the
1187
# "Set" method, so we fail early here:
1188
if byte_arrays and signature != "ay":
1189
raise ValueError("Byte arrays not supported for non-'ay'"
1190
" signature {!r}".format(signature))
501
1192
def decorator(func):
502
1193
func._dbus_is_property = True
503
1194
func._dbus_interface = dbus_interface
504
1195
func._dbus_signature = signature
505
1196
func._dbus_access = access
506
1197
func._dbus_name = func.__name__
507
if func._dbus_name.endswith(u"_dbus_property"):
1198
if func._dbus_name.endswith("_dbus_property"):
508
1199
func._dbus_name = func._dbus_name[:-14]
509
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1200
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1206
def dbus_interface_annotations(dbus_interface):
1207
"""Decorator for marking functions returning interface annotations
1211
@dbus_interface_annotations("org.example.Interface")
1212
def _foo(self): # Function name does not matter
1213
return {"org.freedesktop.DBus.Deprecated": "true",
1214
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1218
def decorator(func):
1219
func._dbus_is_interface = True
1220
func._dbus_interface = dbus_interface
1221
func._dbus_name = dbus_interface
1227
def dbus_annotations(annotations):
1228
"""Decorator to annotate D-Bus methods, signals or properties
1231
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1232
"org.freedesktop.DBus.Property."
1233
"EmitsChangedSignal": "false"})
1234
@dbus_service_property("org.example.Interface", signature="b",
1236
def Property_dbus_property(self):
1237
return dbus.Boolean(False)
1239
See also the DBusObjectWithAnnotations class.
1242
def decorator(func):
1243
func._dbus_annotations = annotations
511
1246
return decorator
514
1249
class DBusPropertyException(dbus.exceptions.DBusException):
515
1250
"""A base class for D-Bus property-related exceptions
517
def __unicode__(self):
518
return unicode(str(self))
521
1255
class DBusPropertyAccessException(DBusPropertyException):
533
class DBusObjectWithProperties(dbus.service.Object):
1267
class DBusObjectWithAnnotations(dbus.service.Object):
1268
"""A D-Bus object with annotations.
1270
Classes inheriting from this can use the dbus_annotations
1271
decorator to add annotations to methods or signals.
1275
def _is_dbus_thing(thing):
1276
"""Returns a function testing if an attribute is a D-Bus thing
1278
If called like _is_dbus_thing("method") it returns a function
1279
suitable for use as predicate to inspect.getmembers().
1281
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1284
def _get_all_dbus_things(self, thing):
1285
"""Returns a generator of (name, attribute) pairs
1287
return ((getattr(athing.__get__(self), "_dbus_name", name),
1288
athing.__get__(self))
1289
for cls in self.__class__.__mro__
1291
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1293
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1295
path_keyword='object_path',
1296
connection_keyword='connection')
1297
def Introspect(self, object_path, connection):
1298
"""Overloading of standard D-Bus method.
1300
Inserts annotation tags on methods and signals.
1302
xmlstring = dbus.service.Object.Introspect(self, object_path,
1305
document = xml.dom.minidom.parseString(xmlstring)
1307
for if_tag in document.getElementsByTagName("interface"):
1308
# Add annotation tags
1309
for typ in ("method", "signal"):
1310
for tag in if_tag.getElementsByTagName(typ):
1312
for name, prop in (self.
1313
_get_all_dbus_things(typ)):
1314
if (name == tag.getAttribute("name")
1315
and prop._dbus_interface
1316
== if_tag.getAttribute("name")):
1317
annots.update(getattr(
1318
prop, "_dbus_annotations", {}))
1319
for name, value in annots.items():
1320
ann_tag = document.createElement(
1322
ann_tag.setAttribute("name", name)
1323
ann_tag.setAttribute("value", value)
1324
tag.appendChild(ann_tag)
1325
# Add interface annotation tags
1326
for annotation, value in dict(
1327
itertools.chain.from_iterable(
1328
annotations().items()
1329
for name, annotations
1330
in self._get_all_dbus_things("interface")
1331
if name == if_tag.getAttribute("name")
1333
ann_tag = document.createElement("annotation")
1334
ann_tag.setAttribute("name", annotation)
1335
ann_tag.setAttribute("value", value)
1336
if_tag.appendChild(ann_tag)
1337
# Fix argument name for the Introspect method itself
1338
if (if_tag.getAttribute("name")
1339
== dbus.INTROSPECTABLE_IFACE):
1340
for cn in if_tag.getElementsByTagName("method"):
1341
if cn.getAttribute("name") == "Introspect":
1342
for arg in cn.getElementsByTagName("arg"):
1343
if (arg.getAttribute("direction")
1345
arg.setAttribute("name",
1347
xmlstring = document.toxml("utf-8")
1349
except (AttributeError, xml.dom.DOMException,
1350
xml.parsers.expat.ExpatError) as error:
1351
logger.error("Failed to override Introspection method",
1356
class DBusObjectWithProperties(DBusObjectWithAnnotations):
534
1357
"""A D-Bus object with properties.
536
1359
Classes inheriting from this can use the dbus_service_property
537
1360
decorator to expose methods as D-Bus properties. It exposes the
538
1361
standard Get(), Set(), and GetAll() methods on the D-Bus.
542
def _is_dbus_property(obj):
543
return getattr(obj, u"_dbus_is_property", False)
545
def _get_all_dbus_properties(self):
546
"""Returns a generator of (name, attribute) pairs
548
return ((prop._dbus_name, prop)
550
inspect.getmembers(self, self._is_dbus_property))
552
1364
def _get_dbus_property(self, interface_name, property_name):
553
1365
"""Returns a bound method if one exists which is a D-Bus
554
1366
property with the specified name and interface.
556
for name in (property_name,
557
property_name + u"_dbus_property"):
558
prop = getattr(self, name, None)
560
or not self._is_dbus_property(prop)
561
or prop._dbus_name != property_name
562
or (interface_name and prop._dbus_interface
563
and interface_name != prop._dbus_interface)):
1368
for cls in self.__class__.__mro__:
1369
for name, value in inspect.getmembers(
1370
cls, self._is_dbus_thing("property")):
1371
if (value._dbus_name == property_name
1372
and value._dbus_interface == interface_name):
1373
return value.__get__(self)
566
1375
# No such property
567
raise DBusPropertyNotFound(self.dbus_object_path + u":"
568
+ interface_name + u"."
571
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1376
raise DBusPropertyNotFound("{}:{}.{}".format(
1377
self.dbus_object_path, interface_name, property_name))
1380
def _get_all_interface_names(cls):
1381
"""Get a sequence of all interfaces supported by an object"""
1382
return (name for name in set(getattr(getattr(x, attr),
1383
"_dbus_interface", None)
1384
for x in (inspect.getmro(cls))
1386
if name is not None)
1388
@dbus.service.method(dbus.PROPERTIES_IFACE,
573
1391
def Get(self, interface_name, property_name):
574
1392
"""Standard D-Bus property Get() method, see D-Bus standard.
576
1394
prop = self._get_dbus_property(interface_name, property_name)
577
if prop._dbus_access == u"write":
1395
if prop._dbus_access == "write":
578
1396
raise DBusPropertyAccessException(property_name)
580
if not hasattr(value, u"variant_level"):
1398
if not hasattr(value, "variant_level"):
582
1400
return type(value)(value, variant_level=value.variant_level+1)
584
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1402
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
585
1403
def Set(self, interface_name, property_name, value):
586
1404
"""Standard D-Bus property Set() method, see D-Bus standard.
588
1406
prop = self._get_dbus_property(interface_name, property_name)
589
if prop._dbus_access == u"read":
1407
if prop._dbus_access == "read":
590
1408
raise DBusPropertyAccessException(property_name)
591
if prop._dbus_get_args_options[u"byte_arrays"]:
592
value = dbus.ByteArray(''.join(unichr(byte)
1409
if prop._dbus_get_args_options["byte_arrays"]:
1410
# The byte_arrays option is not supported yet on
1411
# signatures other than "ay".
1412
if prop._dbus_signature != "ay":
1413
raise ValueError("Byte arrays not supported for non-"
1414
"'ay' signature {!r}"
1415
.format(prop._dbus_signature))
1416
value = dbus.ByteArray(bytes(value))
596
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
597
out_signature=u"a{sv}")
1419
@dbus.service.method(dbus.PROPERTIES_IFACE,
1421
out_signature="a{sv}")
598
1422
def GetAll(self, interface_name):
599
1423
"""Standard D-Bus property GetAll() method, see D-Bus
602
1426
Note: Will not include properties with access="write".
605
for name, prop in self._get_all_dbus_properties():
1429
for name, prop in self._get_all_dbus_things("property"):
606
1430
if (interface_name
607
1431
and interface_name != prop._dbus_interface):
608
1432
# Interface non-empty but did not match
610
1434
# Ignore write-only properties
611
if prop._dbus_access == u"write":
1435
if prop._dbus_access == "write":
614
if not hasattr(value, u"variant_level"):
1438
if not hasattr(value, "variant_level"):
1439
properties[name] = value
617
all[name] = type(value)(value, variant_level=
618
value.variant_level+1)
619
return dbus.Dictionary(all, signature=u"sv")
1441
properties[name] = type(value)(
1442
value, variant_level=value.variant_level + 1)
1443
return dbus.Dictionary(properties, signature="sv")
1445
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1446
def PropertiesChanged(self, interface_name, changed_properties,
1447
invalidated_properties):
1448
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
621
1453
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
623
1455
path_keyword='object_path',
624
1456
connection_keyword='connection')
625
1457
def Introspect(self, object_path, connection):
626
"""Standard D-Bus method, overloaded to insert property tags.
1458
"""Overloading of standard D-Bus method.
1460
Inserts property tags and interface annotation tags.
628
xmlstring = dbus.service.Object.Introspect(self, object_path,
1462
xmlstring = DBusObjectWithAnnotations.Introspect(self,
631
1466
document = xml.dom.minidom.parseString(xmlstring)
632
1468
def make_tag(document, name, prop):
633
e = document.createElement(u"property")
634
e.setAttribute(u"name", name)
635
e.setAttribute(u"type", prop._dbus_signature)
636
e.setAttribute(u"access", prop._dbus_access)
1469
e = document.createElement("property")
1470
e.setAttribute("name", name)
1471
e.setAttribute("type", prop._dbus_signature)
1472
e.setAttribute("access", prop._dbus_access)
638
for if_tag in document.getElementsByTagName(u"interface"):
1475
for if_tag in document.getElementsByTagName("interface"):
639
1477
for tag in (make_tag(document, name, prop)
641
in self._get_all_dbus_properties()
1479
in self._get_all_dbus_things("property")
642
1480
if prop._dbus_interface
643
== if_tag.getAttribute(u"name")):
1481
== if_tag.getAttribute("name")):
644
1482
if_tag.appendChild(tag)
1483
# Add annotation tags for properties
1484
for tag in if_tag.getElementsByTagName("property"):
1486
for name, prop in self._get_all_dbus_things(
1488
if (name == tag.getAttribute("name")
1489
and prop._dbus_interface
1490
== if_tag.getAttribute("name")):
1491
annots.update(getattr(
1492
prop, "_dbus_annotations", {}))
1493
for name, value in annots.items():
1494
ann_tag = document.createElement(
1496
ann_tag.setAttribute("name", name)
1497
ann_tag.setAttribute("value", value)
1498
tag.appendChild(ann_tag)
645
1499
# Add the names to the return values for the
646
1500
# "org.freedesktop.DBus.Properties" methods
647
if (if_tag.getAttribute(u"name")
648
== u"org.freedesktop.DBus.Properties"):
649
for cn in if_tag.getElementsByTagName(u"method"):
650
if cn.getAttribute(u"name") == u"Get":
651
for arg in cn.getElementsByTagName(u"arg"):
652
if (arg.getAttribute(u"direction")
654
arg.setAttribute(u"name", u"value")
655
elif cn.getAttribute(u"name") == u"GetAll":
656
for arg in cn.getElementsByTagName(u"arg"):
657
if (arg.getAttribute(u"direction")
659
arg.setAttribute(u"name", u"props")
660
xmlstring = document.toxml(u"utf-8")
662
except (AttributeError, xml.dom.DOMException,
663
xml.parsers.expat.ExpatError), error:
664
logger.error(u"Failed to override Introspection method",
1501
if (if_tag.getAttribute("name")
1502
== "org.freedesktop.DBus.Properties"):
1503
for cn in if_tag.getElementsByTagName("method"):
1504
if cn.getAttribute("name") == "Get":
1505
for arg in cn.getElementsByTagName("arg"):
1506
if (arg.getAttribute("direction")
1508
arg.setAttribute("name", "value")
1509
elif cn.getAttribute("name") == "GetAll":
1510
for arg in cn.getElementsByTagName("arg"):
1511
if (arg.getAttribute("direction")
1513
arg.setAttribute("name", "props")
1514
xmlstring = document.toxml("utf-8")
1516
except (AttributeError, xml.dom.DOMException,
1517
xml.parsers.expat.ExpatError) as error:
1518
logger.error("Failed to override Introspection method",
1524
dbus.OBJECT_MANAGER_IFACE
1525
except AttributeError:
1526
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1529
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1530
"""A D-Bus object with an ObjectManager.
1532
Classes inheriting from this exposes the standard
1533
GetManagedObjects call and the InterfacesAdded and
1534
InterfacesRemoved signals on the standard
1535
"org.freedesktop.DBus.ObjectManager" interface.
1537
Note: No signals are sent automatically; they must be sent
1540
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1541
out_signature="a{oa{sa{sv}}}")
1542
def GetManagedObjects(self):
1543
"""This function must be overridden"""
1544
raise NotImplementedError()
1546
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1547
signature="oa{sa{sv}}")
1548
def InterfacesAdded(self, object_path, interfaces_and_properties):
1551
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1552
def InterfacesRemoved(self, object_path, interfaces):
1555
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1557
path_keyword='object_path',
1558
connection_keyword='connection')
1559
def Introspect(self, object_path, connection):
1560
"""Overloading of standard D-Bus method.
1562
Override return argument name of GetManagedObjects to be
1563
"objpath_interfaces_and_properties"
1565
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1569
document = xml.dom.minidom.parseString(xmlstring)
1571
for if_tag in document.getElementsByTagName("interface"):
1572
# Fix argument name for the GetManagedObjects method
1573
if (if_tag.getAttribute("name")
1574
== dbus.OBJECT_MANAGER_IFACE):
1575
for cn in if_tag.getElementsByTagName("method"):
1576
if (cn.getAttribute("name")
1577
== "GetManagedObjects"):
1578
for arg in cn.getElementsByTagName("arg"):
1579
if (arg.getAttribute("direction")
1583
"objpath_interfaces"
1585
xmlstring = document.toxml("utf-8")
1587
except (AttributeError, xml.dom.DOMException,
1588
xml.parsers.expat.ExpatError) as error:
1589
logger.error("Failed to override Introspection method",
1594
def datetime_to_dbus(dt, variant_level=0):
1595
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1597
return dbus.String("", variant_level=variant_level)
1598
return dbus.String(dt.isoformat(), variant_level=variant_level)
1601
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1602
"""A class decorator; applied to a subclass of
1603
dbus.service.Object, it will add alternate D-Bus attributes with
1604
interface names according to the "alt_interface_names" mapping.
1607
@alternate_dbus_interfaces({"org.example.Interface":
1608
"net.example.AlternateInterface"})
1609
class SampleDBusObject(dbus.service.Object):
1610
@dbus.service.method("org.example.Interface")
1611
def SampleDBusMethod():
1614
The above "SampleDBusMethod" on "SampleDBusObject" will be
1615
reachable via two interfaces: "org.example.Interface" and
1616
"net.example.AlternateInterface", the latter of which will have
1617
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1618
"true", unless "deprecate" is passed with a False value.
1620
This works for methods and signals, and also for D-Bus properties
1621
(from DBusObjectWithProperties) and interfaces (from the
1622
dbus_interface_annotations decorator).
1626
for orig_interface_name, alt_interface_name in (
1627
alt_interface_names.items()):
1629
interface_names = set()
1630
# Go though all attributes of the class
1631
for attrname, attribute in inspect.getmembers(cls):
1632
# Ignore non-D-Bus attributes, and D-Bus attributes
1633
# with the wrong interface name
1634
if (not hasattr(attribute, "_dbus_interface")
1635
or not attribute._dbus_interface.startswith(
1636
orig_interface_name)):
1638
# Create an alternate D-Bus interface name based on
1640
alt_interface = attribute._dbus_interface.replace(
1641
orig_interface_name, alt_interface_name)
1642
interface_names.add(alt_interface)
1643
# Is this a D-Bus signal?
1644
if getattr(attribute, "_dbus_is_signal", False):
1645
# Extract the original non-method undecorated
1646
# function by black magic
1647
if sys.version_info.major == 2:
1648
nonmethod_func = (dict(
1649
zip(attribute.func_code.co_freevars,
1650
attribute.__closure__))
1651
["func"].cell_contents)
1653
nonmethod_func = (dict(
1654
zip(attribute.__code__.co_freevars,
1655
attribute.__closure__))
1656
["func"].cell_contents)
1657
# Create a new, but exactly alike, function
1658
# object, and decorate it to be a new D-Bus signal
1659
# with the alternate D-Bus interface name
1660
new_function = copy_function(nonmethod_func)
1661
new_function = (dbus.service.signal(
1663
attribute._dbus_signature)(new_function))
1664
# Copy annotations, if any
1666
new_function._dbus_annotations = dict(
1667
attribute._dbus_annotations)
1668
except AttributeError:
1671
# Define a creator of a function to call both the
1672
# original and alternate functions, so both the
1673
# original and alternate signals gets sent when
1674
# the function is called
1675
def fixscope(func1, func2):
1676
"""This function is a scope container to pass
1677
func1 and func2 to the "call_both" function
1678
outside of its arguments"""
1680
@functools.wraps(func2)
1681
def call_both(*args, **kwargs):
1682
"""This function will emit two D-Bus
1683
signals by calling func1 and func2"""
1684
func1(*args, **kwargs)
1685
func2(*args, **kwargs)
1686
# Make wrapper function look like a D-Bus
1688
for name, attr in inspect.getmembers(func2):
1689
if name.startswith("_dbus_"):
1690
setattr(call_both, name, attr)
1693
# Create the "call_both" function and add it to
1695
attr[attrname] = fixscope(attribute, new_function)
1696
# Is this a D-Bus method?
1697
elif getattr(attribute, "_dbus_is_method", False):
1698
# Create a new, but exactly alike, function
1699
# object. Decorate it to be a new D-Bus method
1700
# with the alternate D-Bus interface name. Add it
1703
dbus.service.method(
1705
attribute._dbus_in_signature,
1706
attribute._dbus_out_signature)
1707
(copy_function(attribute)))
1708
# Copy annotations, if any
1710
attr[attrname]._dbus_annotations = dict(
1711
attribute._dbus_annotations)
1712
except AttributeError:
1714
# Is this a D-Bus property?
1715
elif getattr(attribute, "_dbus_is_property", False):
1716
# Create a new, but exactly alike, function
1717
# object, and decorate it to be a new D-Bus
1718
# property with the alternate D-Bus interface
1719
# name. Add it to the class.
1720
attr[attrname] = (dbus_service_property(
1721
alt_interface, attribute._dbus_signature,
1722
attribute._dbus_access,
1723
attribute._dbus_get_args_options
1725
(copy_function(attribute)))
1726
# Copy annotations, if any
1728
attr[attrname]._dbus_annotations = dict(
1729
attribute._dbus_annotations)
1730
except AttributeError:
1732
# Is this a D-Bus interface?
1733
elif getattr(attribute, "_dbus_is_interface", False):
1734
# Create a new, but exactly alike, function
1735
# object. Decorate it to be a new D-Bus interface
1736
# with the alternate D-Bus interface name. Add it
1739
dbus_interface_annotations(alt_interface)
1740
(copy_function(attribute)))
1742
# Deprecate all alternate interfaces
1743
iname = "_AlternateDBusNames_interface_annotation{}"
1744
for interface_name in interface_names:
1746
@dbus_interface_annotations(interface_name)
1748
return {"org.freedesktop.DBus.Deprecated":
1750
# Find an unused name
1751
for aname in (iname.format(i)
1752
for i in itertools.count()):
1753
if aname not in attr:
1757
# Replace the class with a new subclass of it with
1758
# methods, signals, etc. as created above.
1759
if sys.version_info.major == 2:
1760
cls = type(b"{}Alternate".format(cls.__name__),
1763
cls = type("{}Alternate".format(cls.__name__),
1770
@alternate_dbus_interfaces({"se.recompile.Mandos":
1771
"se.bsnet.fukt.Mandos"})
669
1772
class ClientDBus(Client, DBusObjectWithProperties):
670
1773
"""A Client class using D-Bus
673
1776
dbus_object_path: dbus.ObjectPath
674
1777
bus: dbus.SystemBus()
1780
runtime_expansions = (Client.runtime_expansions
1781
+ ("dbus_object_path", ))
1783
_interface = "se.recompile.Mandos.Client"
676
1785
# dbus.service.Object doesn't use super(), so we can't either.
678
def __init__(self, bus = None, *args, **kwargs):
1787
def __init__(self, bus=None, *args, **kwargs):
680
1789
Client.__init__(self, *args, **kwargs)
681
1790
# Only now, when this client is initialized, can it show up on
683
self.dbus_object_path = (dbus.ObjectPath
685
+ self.name.replace(u".", u"_")))
1792
client_object_name = str(self.name).translate(
1793
{ord("."): ord("_"),
1794
ord("-"): ord("_")})
1795
self.dbus_object_path = dbus.ObjectPath(
1796
"/clients/" + client_object_name)
686
1797
DBusObjectWithProperties.__init__(self, self.bus,
687
1798
self.dbus_object_path)
690
def _datetime_to_dbus(dt, variant_level=0):
691
"""Convert a UTC datetime.datetime() to a D-Bus type."""
692
return dbus.String(dt.isoformat(),
693
variant_level=variant_level)
696
oldstate = getattr(self, u"enabled", False)
697
r = Client.enable(self)
698
if oldstate != self.enabled:
700
self.PropertyChanged(dbus.String(u"enabled"),
701
dbus.Boolean(True, variant_level=1))
702
self.PropertyChanged(
703
dbus.String(u"last_enabled"),
704
self._datetime_to_dbus(self.last_enabled,
708
def disable(self, signal = True):
709
oldstate = getattr(self, u"enabled", False)
710
r = Client.disable(self)
711
if signal and oldstate != self.enabled:
713
self.PropertyChanged(dbus.String(u"enabled"),
714
dbus.Boolean(False, variant_level=1))
1800
def notifychangeproperty(transform_func, dbus_name,
1801
type_func=lambda x: x,
1803
invalidate_only=False,
1804
_interface=_interface):
1805
""" Modify a variable so that it's a property which announces
1806
its changes to DBus.
1808
transform_fun: Function that takes a value and a variant_level
1809
and transforms it to a D-Bus type.
1810
dbus_name: D-Bus name of the variable
1811
type_func: Function that transform the value before sending it
1812
to the D-Bus. Default: no transform
1813
variant_level: D-Bus variant level. Default: 1
1815
attrname = "_{}".format(dbus_name)
1817
def setter(self, value):
1818
if hasattr(self, "dbus_object_path"):
1819
if (not hasattr(self, attrname) or
1820
type_func(getattr(self, attrname, None))
1821
!= type_func(value)):
1823
self.PropertiesChanged(
1824
_interface, dbus.Dictionary(),
1825
dbus.Array((dbus_name, )))
1827
dbus_value = transform_func(
1829
variant_level=variant_level)
1830
self.PropertyChanged(dbus.String(dbus_name),
1832
self.PropertiesChanged(
1834
dbus.Dictionary({dbus.String(dbus_name):
1837
setattr(self, attrname, value)
1839
return property(lambda self: getattr(self, attrname), setter)
1841
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1842
approvals_pending = notifychangeproperty(dbus.Boolean,
1845
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1846
last_enabled = notifychangeproperty(datetime_to_dbus,
1848
checker = notifychangeproperty(
1849
dbus.Boolean, "CheckerRunning",
1850
type_func=lambda checker: checker is not None)
1851
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1853
last_checker_status = notifychangeproperty(dbus.Int16,
1854
"LastCheckerStatus")
1855
last_approval_request = notifychangeproperty(
1856
datetime_to_dbus, "LastApprovalRequest")
1857
approved_by_default = notifychangeproperty(dbus.Boolean,
1858
"ApprovedByDefault")
1859
approval_delay = notifychangeproperty(
1860
dbus.UInt64, "ApprovalDelay",
1861
type_func=lambda td: td.total_seconds() * 1000)
1862
approval_duration = notifychangeproperty(
1863
dbus.UInt64, "ApprovalDuration",
1864
type_func=lambda td: td.total_seconds() * 1000)
1865
host = notifychangeproperty(dbus.String, "Host")
1866
timeout = notifychangeproperty(
1867
dbus.UInt64, "Timeout",
1868
type_func=lambda td: td.total_seconds() * 1000)
1869
extended_timeout = notifychangeproperty(
1870
dbus.UInt64, "ExtendedTimeout",
1871
type_func=lambda td: td.total_seconds() * 1000)
1872
interval = notifychangeproperty(
1873
dbus.UInt64, "Interval",
1874
type_func=lambda td: td.total_seconds() * 1000)
1875
checker_command = notifychangeproperty(dbus.String, "Checker")
1876
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1877
invalidate_only=True)
1879
del notifychangeproperty
717
1881
def __del__(self, *args, **kwargs):
719
1883
self.remove_from_connection()
720
1884
except LookupError:
722
if hasattr(DBusObjectWithProperties, u"__del__"):
1886
if hasattr(DBusObjectWithProperties, "__del__"):
723
1887
DBusObjectWithProperties.__del__(self, *args, **kwargs)
724
1888
Client.__del__(self, *args, **kwargs)
726
def checker_callback(self, pid, condition, command,
728
self.checker_callback_tag = None
731
self.PropertyChanged(dbus.String(u"checker_running"),
732
dbus.Boolean(False, variant_level=1))
733
if os.WIFEXITED(condition):
734
exitstatus = os.WEXITSTATUS(condition)
1890
def checker_callback(self, source, condition,
1891
connection, command, *args, **kwargs):
1892
ret = Client.checker_callback(self, source, condition,
1893
connection, command, *args,
1895
exitstatus = self.last_checker_status
735
1897
# Emit D-Bus signal
736
1898
self.CheckerCompleted(dbus.Int16(exitstatus),
737
dbus.Int64(condition),
1899
# This is specific to GNU libC
1900
dbus.Int64(exitstatus << 8),
738
1901
dbus.String(command))
740
1903
# Emit D-Bus signal
741
1904
self.CheckerCompleted(dbus.Int16(-1),
742
dbus.Int64(condition),
1906
# This is specific to GNU libC
1908
| self.last_checker_signal),
743
1909
dbus.String(command))
745
return Client.checker_callback(self, pid, condition, command,
748
def checked_ok(self, *args, **kwargs):
749
r = Client.checked_ok(self, *args, **kwargs)
751
self.PropertyChanged(
752
dbus.String(u"last_checked_ok"),
753
(self._datetime_to_dbus(self.last_checked_ok,
757
1912
def start_checker(self, *args, **kwargs):
758
old_checker = self.checker
759
if self.checker is not None:
760
old_checker_pid = self.checker.pid
762
old_checker_pid = None
1913
old_checker_pid = getattr(self.checker, "pid", None)
763
1914
r = Client.start_checker(self, *args, **kwargs)
764
1915
# Only if new checker process was started
765
1916
if (self.checker is not None
766
1917
and old_checker_pid != self.checker.pid):
767
1918
# Emit D-Bus signal
768
1919
self.CheckerStarted(self.current_checker_command)
769
self.PropertyChanged(
770
dbus.String(u"checker_running"),
771
dbus.Boolean(True, variant_level=1))
774
def stop_checker(self, *args, **kwargs):
775
old_checker = getattr(self, u"checker", None)
776
r = Client.stop_checker(self, *args, **kwargs)
777
if (old_checker is not None
778
and getattr(self, u"checker", None) is None):
779
self.PropertyChanged(dbus.String(u"checker_running"),
780
dbus.Boolean(False, variant_level=1))
783
## D-Bus methods & signals
784
_interface = u"se.bsnet.fukt.Mandos.Client"
787
@dbus.service.method(_interface)
789
return self.checked_ok()
1922
def _reset_approved(self):
1923
self.approved = None
1926
def approve(self, value=True):
1927
self.approved = value
1928
GLib.timeout_add(int(self.approval_duration.total_seconds()
1929
* 1000), self._reset_approved)
1930
self.send_changedstate()
1932
# D-Bus methods, signals & properties
791
1938
# CheckerCompleted - signal
792
@dbus.service.signal(_interface, signature=u"nxs")
1939
@dbus.service.signal(_interface, signature="nxs")
793
1940
def CheckerCompleted(self, exitcode, waitstatus, command):
797
1944
# CheckerStarted - signal
798
@dbus.service.signal(_interface, signature=u"s")
1945
@dbus.service.signal(_interface, signature="s")
799
1946
def CheckerStarted(self, command):
803
1950
# PropertyChanged - signal
804
@dbus.service.signal(_interface, signature=u"sv")
1951
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1952
@dbus.service.signal(_interface, signature="sv")
805
1953
def PropertyChanged(self, property, value):
809
1957
# GotSecret - signal
810
1958
@dbus.service.signal(_interface)
811
1959
def GotSecret(self):
1961
Is sent after a successful transfer of secret from the Mandos
1962
server to mandos-client
815
1966
# Rejected - signal
816
@dbus.service.signal(_interface)
1967
@dbus.service.signal(_interface, signature="s")
1968
def Rejected(self, reason):
1972
# NeedApproval - signal
1973
@dbus.service.signal(_interface, signature="tb")
1974
def NeedApproval(self, timeout, default):
1976
return self.need_approval()
1981
@dbus.service.method(_interface, in_signature="b")
1982
def Approve(self, value):
1985
# CheckedOK - method
1986
@dbus.service.method(_interface)
1987
def CheckedOK(self):
821
1990
# Enable - method
1991
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
822
1992
@dbus.service.method(_interface)
823
1993
def Enable(self):
827
1997
# StartChecker - method
1998
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
828
1999
@dbus.service.method(_interface)
829
2000
def StartChecker(self):
831
2002
self.start_checker()
833
2004
# Disable - method
2005
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
834
2006
@dbus.service.method(_interface)
835
2007
def Disable(self):
839
2011
# StopChecker - method
2012
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
840
2013
@dbus.service.method(_interface)
841
2014
def StopChecker(self):
842
2015
self.stop_checker()
845
@dbus_service_property(_interface, signature=u"s", access=u"read")
846
def name_dbus_property(self):
2019
# ApprovalPending - property
2020
@dbus_service_property(_interface, signature="b", access="read")
2021
def ApprovalPending_dbus_property(self):
2022
return dbus.Boolean(bool(self.approvals_pending))
2024
# ApprovedByDefault - property
2025
@dbus_service_property(_interface,
2028
def ApprovedByDefault_dbus_property(self, value=None):
2029
if value is None: # get
2030
return dbus.Boolean(self.approved_by_default)
2031
self.approved_by_default = bool(value)
2033
# ApprovalDelay - property
2034
@dbus_service_property(_interface,
2037
def ApprovalDelay_dbus_property(self, value=None):
2038
if value is None: # get
2039
return dbus.UInt64(self.approval_delay.total_seconds()
2041
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2043
# ApprovalDuration - property
2044
@dbus_service_property(_interface,
2047
def ApprovalDuration_dbus_property(self, value=None):
2048
if value is None: # get
2049
return dbus.UInt64(self.approval_duration.total_seconds()
2051
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2055
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2056
@dbus_service_property(_interface, signature="s", access="read")
2057
def Name_dbus_property(self):
847
2058
return dbus.String(self.name)
849
# fingerprint - property
850
@dbus_service_property(_interface, signature=u"s", access=u"read")
851
def fingerprint_dbus_property(self):
2062
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2063
@dbus_service_property(_interface, signature="s", access="read")
2064
def KeyID_dbus_property(self):
2065
return dbus.String(self.key_id)
2067
# Fingerprint - property
2069
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2070
@dbus_service_property(_interface, signature="s", access="read")
2071
def Fingerprint_dbus_property(self):
852
2072
return dbus.String(self.fingerprint)
855
@dbus_service_property(_interface, signature=u"s",
857
def host_dbus_property(self, value=None):
2075
@dbus_service_property(_interface,
2078
def Host_dbus_property(self, value=None):
858
2079
if value is None: # get
859
2080
return dbus.String(self.host)
862
self.PropertyChanged(dbus.String(u"host"),
863
dbus.String(value, variant_level=1))
866
@dbus_service_property(_interface, signature=u"s", access=u"read")
867
def created_dbus_property(self):
868
return dbus.String(self._datetime_to_dbus(self.created))
870
# last_enabled - property
871
@dbus_service_property(_interface, signature=u"s", access=u"read")
872
def last_enabled_dbus_property(self):
873
if self.last_enabled is None:
874
return dbus.String(u"")
875
return dbus.String(self._datetime_to_dbus(self.last_enabled))
878
@dbus_service_property(_interface, signature=u"b",
880
def enabled_dbus_property(self, value=None):
2081
self.host = str(value)
2083
# Created - property
2085
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2086
@dbus_service_property(_interface, signature="s", access="read")
2087
def Created_dbus_property(self):
2088
return datetime_to_dbus(self.created)
2090
# LastEnabled - property
2091
@dbus_service_property(_interface, signature="s", access="read")
2092
def LastEnabled_dbus_property(self):
2093
return datetime_to_dbus(self.last_enabled)
2095
# Enabled - property
2096
@dbus_service_property(_interface,
2099
def Enabled_dbus_property(self, value=None):
881
2100
if value is None: # get
882
2101
return dbus.Boolean(self.enabled)
888
# last_checked_ok - property
889
@dbus_service_property(_interface, signature=u"s",
891
def last_checked_ok_dbus_property(self, value=None):
2107
# LastCheckedOK - property
2108
@dbus_service_property(_interface,
2111
def LastCheckedOK_dbus_property(self, value=None):
892
2112
if value is not None:
893
2113
self.checked_ok()
895
if self.last_checked_ok is None:
896
return dbus.String(u"")
897
return dbus.String(self._datetime_to_dbus(self
901
@dbus_service_property(_interface, signature=u"t",
903
def timeout_dbus_property(self, value=None):
2115
return datetime_to_dbus(self.last_checked_ok)
2117
# LastCheckerStatus - property
2118
@dbus_service_property(_interface, signature="n", access="read")
2119
def LastCheckerStatus_dbus_property(self):
2120
return dbus.Int16(self.last_checker_status)
2122
# Expires - property
2123
@dbus_service_property(_interface, signature="s", access="read")
2124
def Expires_dbus_property(self):
2125
return datetime_to_dbus(self.expires)
2127
# LastApprovalRequest - property
2128
@dbus_service_property(_interface, signature="s", access="read")
2129
def LastApprovalRequest_dbus_property(self):
2130
return datetime_to_dbus(self.last_approval_request)
2132
# Timeout - property
2133
@dbus_service_property(_interface,
2136
def Timeout_dbus_property(self, value=None):
904
2137
if value is None: # get
905
return dbus.UInt64(self.timeout_milliseconds())
2138
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2139
old_timeout = self.timeout
906
2140
self.timeout = datetime.timedelta(0, 0, 0, value)
908
self.PropertyChanged(dbus.String(u"timeout"),
909
dbus.UInt64(value, variant_level=1))
910
if getattr(self, u"disable_initiator_tag", None) is None:
913
gobject.source_remove(self.disable_initiator_tag)
914
self.disable_initiator_tag = None
916
_timedelta_to_milliseconds((self
922
# The timeout has passed
925
self.disable_initiator_tag = (gobject.timeout_add
926
(time_to_die, self.disable))
928
# interval - property
929
@dbus_service_property(_interface, signature=u"t",
931
def interval_dbus_property(self, value=None):
932
if value is None: # get
933
return dbus.UInt64(self.interval_milliseconds())
2141
# Reschedule disabling
2143
now = datetime.datetime.utcnow()
2144
self.expires += self.timeout - old_timeout
2145
if self.expires <= now:
2146
# The timeout has passed
2149
if (getattr(self, "disable_initiator_tag", None)
2152
GLib.source_remove(self.disable_initiator_tag)
2153
self.disable_initiator_tag = GLib.timeout_add(
2154
int((self.expires - now).total_seconds() * 1000),
2157
# ExtendedTimeout - property
2158
@dbus_service_property(_interface,
2161
def ExtendedTimeout_dbus_property(self, value=None):
2162
if value is None: # get
2163
return dbus.UInt64(self.extended_timeout.total_seconds()
2165
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2167
# Interval - property
2168
@dbus_service_property(_interface,
2171
def Interval_dbus_property(self, value=None):
2172
if value is None: # get
2173
return dbus.UInt64(self.interval.total_seconds() * 1000)
934
2174
self.interval = datetime.timedelta(0, 0, 0, value)
936
self.PropertyChanged(dbus.String(u"interval"),
937
dbus.UInt64(value, variant_level=1))
938
if getattr(self, u"checker_initiator_tag", None) is None:
2175
if getattr(self, "checker_initiator_tag", None) is None:
940
# Reschedule checker run
941
gobject.source_remove(self.checker_initiator_tag)
942
self.checker_initiator_tag = (gobject.timeout_add
943
(value, self.start_checker))
944
self.start_checker() # Start one now, too
2178
# Reschedule checker run
2179
GLib.source_remove(self.checker_initiator_tag)
2180
self.checker_initiator_tag = GLib.timeout_add(
2181
value, self.start_checker)
2182
self.start_checker() # Start one now, too
947
@dbus_service_property(_interface, signature=u"s",
949
def checker_dbus_property(self, value=None):
2184
# Checker - property
2185
@dbus_service_property(_interface,
2188
def Checker_dbus_property(self, value=None):
950
2189
if value is None: # get
951
2190
return dbus.String(self.checker_command)
952
self.checker_command = value
954
self.PropertyChanged(dbus.String(u"checker"),
955
dbus.String(self.checker_command,
958
# checker_running - property
959
@dbus_service_property(_interface, signature=u"b",
961
def checker_running_dbus_property(self, value=None):
2191
self.checker_command = str(value)
2193
# CheckerRunning - property
2194
@dbus_service_property(_interface,
2197
def CheckerRunning_dbus_property(self, value=None):
962
2198
if value is None: # get
963
2199
return dbus.Boolean(self.checker is not None)
965
2201
self.start_checker()
967
2203
self.stop_checker()
969
# object_path - property
970
@dbus_service_property(_interface, signature=u"o", access=u"read")
971
def object_path_dbus_property(self):
972
return self.dbus_object_path # is already a dbus.ObjectPath
975
@dbus_service_property(_interface, signature=u"ay",
976
access=u"write", byte_arrays=True)
977
def secret_dbus_property(self, value):
978
self.secret = str(value)
2205
# ObjectPath - property
2207
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2208
"org.freedesktop.DBus.Deprecated": "true"})
2209
@dbus_service_property(_interface, signature="o", access="read")
2210
def ObjectPath_dbus_property(self):
2211
return self.dbus_object_path # is already a dbus.ObjectPath
2215
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2217
@dbus_service_property(_interface,
2221
def Secret_dbus_property(self, value):
2222
self.secret = bytes(value)
2228
def __init__(self, child_pipe, key_id, fpr, address):
2229
self._pipe = child_pipe
2230
self._pipe.send(('init', key_id, fpr, address))
2231
if not self._pipe.recv():
2232
raise KeyError(key_id or fpr)
2234
def __getattribute__(self, name):
2236
return super(ProxyClient, self).__getattribute__(name)
2237
self._pipe.send(('getattr', name))
2238
data = self._pipe.recv()
2239
if data[0] == 'data':
2241
if data[0] == 'function':
2243
def func(*args, **kwargs):
2244
self._pipe.send(('funcall', name, args, kwargs))
2245
return self._pipe.recv()[1]
2249
def __setattr__(self, name, value):
2251
return super(ProxyClient, self).__setattr__(name, value)
2252
self._pipe.send(('setattr', name, value))
983
2255
class ClientHandler(socketserver.BaseRequestHandler, object):
984
2256
"""A class to handle client connections.
986
2258
Instantiated once for each connection to handle it.
987
2259
Note: This will run in its own forked process."""
989
2261
def handle(self):
990
logger.info(u"TCP connection from: %s",
991
unicode(self.client_address))
992
logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
993
# Open IPC pipe to parent process
994
with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
995
session = (gnutls.connection
996
.ClientSession(self.request,
1000
line = self.request.makefile().readline()
1001
logger.debug(u"Protocol version: %r", line)
1003
if int(line.strip().split()[0]) > 1:
1005
except (ValueError, IndexError, RuntimeError), error:
1006
logger.error(u"Unknown protocol version: %s", error)
1009
# Note: gnutls.connection.X509Credentials is really a
1010
# generic GnuTLS certificate credentials object so long as
1011
# no X.509 keys are added to it. Therefore, we can use it
1012
# here despite using OpenPGP certificates.
1014
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1015
# u"+AES-256-CBC", u"+SHA1",
1016
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2262
with contextlib.closing(self.server.child_pipe) as child_pipe:
2263
logger.info("TCP connection from: %s",
2264
str(self.client_address))
2265
logger.debug("Pipe FD: %d",
2266
self.server.child_pipe.fileno())
2268
session = gnutls.ClientSession(self.request)
2270
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2271
# "+AES-256-CBC", "+SHA1",
2272
# "+COMP-NULL", "+CTYPE-OPENPGP",
1018
2274
# Use a fallback default, since this MUST be set.
1019
2275
priority = self.server.gnutls_priority
1020
2276
if priority is None:
1021
priority = u"NORMAL"
1022
(gnutls.library.functions
1023
.gnutls_priority_set_direct(session._c_object,
2278
gnutls.priority_set_direct(session._c_object,
2279
priority.encode("utf-8"),
2282
# Start communication using the Mandos protocol
2283
# Get protocol number
2284
line = self.request.makefile().readline()
2285
logger.debug("Protocol version: %r", line)
2287
if int(line.strip().split()[0]) > 1:
2288
raise RuntimeError(line)
2289
except (ValueError, IndexError, RuntimeError) as error:
2290
logger.error("Unknown protocol version: %s", error)
2293
# Start GnuTLS connection
1027
2295
session.handshake()
1028
except gnutls.errors.GNUTLSError, error:
1029
logger.warning(u"Handshake failed: %s", error)
2296
except gnutls.Error as error:
2297
logger.warning("Handshake failed: %s", error)
1030
2298
# Do not run session.bye() here: the session is not
1031
2299
# established. Just abandon the request.
1033
logger.debug(u"Handshake succeeded")
2301
logger.debug("Handshake succeeded")
2303
approval_required = False
1035
fpr = self.fingerprint(self.peer_certificate(session))
1036
except (TypeError, gnutls.errors.GNUTLSError), error:
1037
logger.warning(u"Bad certificate: %s", error)
1040
logger.debug(u"Fingerprint: %s", fpr)
1042
for c in self.server.clients:
1043
if c.fingerprint == fpr:
1047
ipc.write(u"NOTFOUND %s %s\n"
1048
% (fpr, unicode(self.client_address)))
1051
# Have to check if client.still_valid(), since it is
1052
# possible that the client timed out while establishing
1053
# the GnuTLS session.
1054
if not client.still_valid():
1055
ipc.write(u"INVALID %s\n" % client.name)
1058
ipc.write(u"SENDING %s\n" % client.name)
1060
while sent_size < len(client.secret):
1061
sent = session.send(client.secret[sent_size:])
1062
logger.debug(u"Sent: %d, remaining: %d",
1063
sent, len(client.secret)
1064
- (sent_size + sent))
2305
if gnutls.has_rawpk:
2308
key_id = self.key_id(
2309
self.peer_certificate(session))
2310
except (TypeError, gnutls.Error) as error:
2311
logger.warning("Bad certificate: %s", error)
2313
logger.debug("Key ID: %s", key_id)
2318
fpr = self.fingerprint(
2319
self.peer_certificate(session))
2320
except (TypeError, gnutls.Error) as error:
2321
logger.warning("Bad certificate: %s", error)
2323
logger.debug("Fingerprint: %s", fpr)
2326
client = ProxyClient(child_pipe, key_id, fpr,
2327
self.client_address)
2331
if client.approval_delay:
2332
delay = client.approval_delay
2333
client.approvals_pending += 1
2334
approval_required = True
2337
if not client.enabled:
2338
logger.info("Client %s is disabled",
2340
if self.server.use_dbus:
2342
client.Rejected("Disabled")
2345
if client.approved or not client.approval_delay:
2346
# We are approved or approval is disabled
2348
elif client.approved is None:
2349
logger.info("Client %s needs approval",
2351
if self.server.use_dbus:
2353
client.NeedApproval(
2354
client.approval_delay.total_seconds()
2355
* 1000, client.approved_by_default)
2357
logger.warning("Client %s was not approved",
2359
if self.server.use_dbus:
2361
client.Rejected("Denied")
2364
# wait until timeout or approved
2365
time = datetime.datetime.now()
2366
client.changedstate.acquire()
2367
client.changedstate.wait(delay.total_seconds())
2368
client.changedstate.release()
2369
time2 = datetime.datetime.now()
2370
if (time2 - time) >= delay:
2371
if not client.approved_by_default:
2372
logger.warning("Client %s timed out while"
2373
" waiting for approval",
2375
if self.server.use_dbus:
2377
client.Rejected("Approval timed out")
2382
delay -= time2 - time
2385
session.send(client.secret)
2386
except gnutls.Error as error:
2387
logger.warning("gnutls send failed",
2391
logger.info("Sending secret to %s", client.name)
2392
# bump the timeout using extended_timeout
2393
client.bump_timeout(client.extended_timeout)
2394
if self.server.use_dbus:
2399
if approval_required:
2400
client.approvals_pending -= 1
2403
except gnutls.Error as error:
2404
logger.warning("GnuTLS bye failed",
1069
2408
def peer_certificate(session):
1070
"Return the peer's OpenPGP certificate as a bytestring"
1071
# If not an OpenPGP certificate...
1072
if (gnutls.library.functions
1073
.gnutls_certificate_type_get(session._c_object)
1074
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1075
# ...do the normal thing
1076
return session.peer_certificate
2409
"Return the peer's certificate as a bytestring"
2411
cert_type = gnutls.certificate_type_get2(session._c_object,
2413
except AttributeError:
2414
cert_type = gnutls.certificate_type_get(session._c_object)
2415
if gnutls.has_rawpk:
2416
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2418
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2419
# If not a valid certificate type...
2420
if cert_type not in valid_cert_types:
2421
logger.info("Cert type %r not in %r", cert_type,
2423
# ...return invalid data
1077
2425
list_size = ctypes.c_uint(1)
1078
cert_list = (gnutls.library.functions
1079
.gnutls_certificate_get_peers
2426
cert_list = (gnutls.certificate_get_peers
1080
2427
(session._c_object, ctypes.byref(list_size)))
1081
2428
if not bool(cert_list) and list_size.value != 0:
1082
raise gnutls.errors.GNUTLSError(u"error getting peer"
2429
raise gnutls.Error("error getting peer certificate")
1084
2430
if list_size.value == 0:
1086
2432
cert = cert_list[0]
1087
2433
return ctypes.string_at(cert.data, cert.size)
2436
def key_id(certificate):
2437
"Convert a certificate bytestring to a hexdigit key ID"
2438
# New GnuTLS "datum" with the public key
2439
datum = gnutls.datum_t(
2440
ctypes.cast(ctypes.c_char_p(certificate),
2441
ctypes.POINTER(ctypes.c_ubyte)),
2442
ctypes.c_uint(len(certificate)))
2443
# XXX all these need to be created in the gnutls "module"
2444
# New empty GnuTLS certificate
2445
pubkey = gnutls.pubkey_t()
2446
gnutls.pubkey_init(ctypes.byref(pubkey))
2447
# Import the raw public key into the certificate
2448
gnutls.pubkey_import(pubkey,
2449
ctypes.byref(datum),
2450
gnutls.X509_FMT_DER)
2451
# New buffer for the key ID
2452
buf = ctypes.create_string_buffer(32)
2453
buf_len = ctypes.c_size_t(len(buf))
2454
# Get the key ID from the raw public key into the buffer
2455
gnutls.pubkey_get_key_id(pubkey,
2456
gnutls.KEYID_USE_SHA256,
2457
ctypes.cast(ctypes.byref(buf),
2458
ctypes.POINTER(ctypes.c_ubyte)),
2459
ctypes.byref(buf_len))
2460
# Deinit the certificate
2461
gnutls.pubkey_deinit(pubkey)
2463
# Convert the buffer to a Python bytestring
2464
key_id = ctypes.string_at(buf, buf_len.value)
2465
# Convert the bytestring to hexadecimal notation
2466
hex_key_id = binascii.hexlify(key_id).upper()
1090
2470
def fingerprint(openpgp):
1091
2471
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1092
2472
# New GnuTLS "datum" with the OpenPGP public key
1093
datum = (gnutls.library.types
1094
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1097
ctypes.c_uint(len(openpgp))))
2473
datum = gnutls.datum_t(
2474
ctypes.cast(ctypes.c_char_p(openpgp),
2475
ctypes.POINTER(ctypes.c_ubyte)),
2476
ctypes.c_uint(len(openpgp)))
1098
2477
# New empty GnuTLS certificate
1099
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1100
(gnutls.library.functions
1101
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2478
crt = gnutls.openpgp_crt_t()
2479
gnutls.openpgp_crt_init(ctypes.byref(crt))
1102
2480
# Import the OpenPGP public key into the certificate
1103
(gnutls.library.functions
1104
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1105
gnutls.library.constants
1106
.GNUTLS_OPENPGP_FMT_RAW))
2481
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2482
gnutls.OPENPGP_FMT_RAW)
1107
2483
# Verify the self signature in the key
1108
2484
crtverify = ctypes.c_uint()
1109
(gnutls.library.functions
1110
.gnutls_openpgp_crt_verify_self(crt, 0,
1111
ctypes.byref(crtverify)))
2485
gnutls.openpgp_crt_verify_self(crt, 0,
2486
ctypes.byref(crtverify))
1112
2487
if crtverify.value != 0:
1113
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1114
raise (gnutls.errors.CertificateSecurityError
2488
gnutls.openpgp_crt_deinit(crt)
2489
raise gnutls.CertificateSecurityError(code
1116
2491
# New buffer for the fingerprint
1117
2492
buf = ctypes.create_string_buffer(20)
1118
2493
buf_len = ctypes.c_size_t()
1119
2494
# Get the fingerprint from the certificate into the buffer
1120
(gnutls.library.functions
1121
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1122
ctypes.byref(buf_len)))
2495
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2496
ctypes.byref(buf_len))
1123
2497
# Deinit the certificate
1124
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2498
gnutls.openpgp_crt_deinit(crt)
1125
2499
# Convert the buffer to a Python bytestring
1126
2500
fpr = ctypes.string_at(buf, buf_len.value)
1127
2501
# Convert the bytestring to hexadecimal notation
1128
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2502
hex_fpr = binascii.hexlify(fpr).upper()
1132
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
1133
"""Like socketserver.ForkingMixIn, but also pass a pipe."""
2506
class MultiprocessingMixIn:
2507
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2509
def sub_process_main(self, request, address):
2511
self.finish_request(request, address)
2513
self.handle_error(request, address)
2514
self.close_request(request)
2516
def process_request(self, request, address):
2517
"""Start a new process to process the request."""
2518
proc = multiprocessing.Process(target=self.sub_process_main,
2519
args=(request, address))
2524
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2525
""" adds a pipe to the MixIn """
1134
2527
def process_request(self, request, client_address):
1135
2528
"""Overrides and wraps the original process_request().
1137
2530
This function creates a new pipe in self.pipe
1139
self.pipe = os.pipe()
1140
super(ForkingMixInWithPipe,
1141
self).process_request(request, client_address)
1142
os.close(self.pipe[1]) # close write end
1143
self.add_pipe(self.pipe[0])
1144
def add_pipe(self, pipe):
2532
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2534
proc = MultiprocessingMixIn.process_request(self, request,
2536
self.child_pipe.close()
2537
self.add_pipe(parent_pipe, proc)
2539
def add_pipe(self, parent_pipe, proc):
1145
2540
"""Dummy function; override as necessary"""
1149
class IPv6_TCPServer(ForkingMixInWithPipe,
1150
socketserver.TCPServer, object):
2541
raise NotImplementedError()
2544
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2545
socketserver.TCPServer):
1151
2546
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1154
2549
enabled: Boolean; whether this server is activated yet
1155
2550
interface: None or a network interface name (string)
1156
2551
use_ipv6: Boolean; to use IPv6 or not
1158
2554
def __init__(self, server_address, RequestHandlerClass,
1159
interface=None, use_ipv6=True):
2558
"""If socketfd is set, use that file descriptor instead of
2559
creating a new one with socket.socket().
1160
2561
self.interface = interface
1162
2563
self.address_family = socket.AF_INET6
2564
if socketfd is not None:
2565
# Save the file descriptor
2566
self.socketfd = socketfd
2567
# Save the original socket.socket() function
2568
self.socket_socket = socket.socket
2570
# To implement --socket, we monkey patch socket.socket.
2572
# (When socketserver.TCPServer is a new-style class, we
2573
# could make self.socket into a property instead of monkey
2574
# patching socket.socket.)
2576
# Create a one-time-only replacement for socket.socket()
2577
@functools.wraps(socket.socket)
2578
def socket_wrapper(*args, **kwargs):
2579
# Restore original function so subsequent calls are
2581
socket.socket = self.socket_socket
2582
del self.socket_socket
2583
# This time only, return a new socket object from the
2584
# saved file descriptor.
2585
return socket.fromfd(self.socketfd, *args, **kwargs)
2586
# Replace socket.socket() function with wrapper
2587
socket.socket = socket_wrapper
2588
# The socketserver.TCPServer.__init__ will call
2589
# socket.socket(), which might be our replacement,
2590
# socket_wrapper(), if socketfd was set.
1163
2591
socketserver.TCPServer.__init__(self, server_address,
1164
2592
RequestHandlerClass)
1165
2594
def server_bind(self):
1166
2595
"""This overrides the normal server_bind() function
1167
2596
to bind to an interface if one was specified, and also NOT to
1168
2597
bind to an address or port if they were not specified."""
2598
global SO_BINDTODEVICE
1169
2599
if self.interface is not None:
1170
2600
if SO_BINDTODEVICE is None:
1171
logger.error(u"SO_BINDTODEVICE does not exist;"
1172
u" cannot bind to interface %s",
1176
self.socket.setsockopt(socket.SOL_SOCKET,
1180
except socket.error, error:
1181
if error[0] == errno.EPERM:
1182
logger.error(u"No permission to"
1183
u" bind to interface %s",
1185
elif error[0] == errno.ENOPROTOOPT:
1186
logger.error(u"SO_BINDTODEVICE not available;"
1187
u" cannot bind to interface %s",
2601
# Fall back to a hard-coded value which seems to be
2603
logger.warning("SO_BINDTODEVICE not found, trying 25")
2604
SO_BINDTODEVICE = 25
2606
self.socket.setsockopt(
2607
socket.SOL_SOCKET, SO_BINDTODEVICE,
2608
(self.interface + "\0").encode("utf-8"))
2609
except socket.error as error:
2610
if error.errno == errno.EPERM:
2611
logger.error("No permission to bind to"
2612
" interface %s", self.interface)
2613
elif error.errno == errno.ENOPROTOOPT:
2614
logger.error("SO_BINDTODEVICE not available;"
2615
" cannot bind to interface %s",
2617
elif error.errno == errno.ENODEV:
2618
logger.error("Interface %s does not exist,"
2619
" cannot bind", self.interface)
1191
2622
# Only bind(2) the socket if we really need to.
1192
2623
if self.server_address[0] or self.server_address[1]:
2624
if self.server_address[1]:
2625
self.allow_reuse_address = True
1193
2626
if not self.server_address[0]:
1194
2627
if self.address_family == socket.AF_INET6:
1195
any_address = u"::" # in6addr_any
2628
any_address = "::" # in6addr_any
1197
any_address = socket.INADDR_ANY
2630
any_address = "0.0.0.0" # INADDR_ANY
1198
2631
self.server_address = (any_address,
1199
2632
self.server_address[1])
1200
2633
elif not self.server_address[1]:
1201
self.server_address = (self.server_address[0],
2634
self.server_address = (self.server_address[0], 0)
1203
2635
# if self.interface:
1204
2636
# self.server_address = (self.server_address[0],
1212
2644
class MandosServer(IPv6_TCPServer):
1213
2645
"""Mandos server.
1216
2648
clients: set of Client objects
1217
2649
gnutls_priority GnuTLS priority string
1218
2650
use_dbus: Boolean; to emit D-Bus signals or not
1220
Assumes a gobject.MainLoop event loop.
2652
Assumes a GLib.MainLoop event loop.
1222
2655
def __init__(self, server_address, RequestHandlerClass,
1223
interface=None, use_ipv6=True, clients=None,
1224
gnutls_priority=None, use_dbus=True):
2659
gnutls_priority=None,
1225
2662
self.enabled = False
1226
2663
self.clients = clients
1227
2664
if self.clients is None:
1228
self.clients = set()
1229
2666
self.use_dbus = use_dbus
1230
2667
self.gnutls_priority = gnutls_priority
1231
2668
IPv6_TCPServer.__init__(self, server_address,
1232
2669
RequestHandlerClass,
1233
interface = interface,
1234
use_ipv6 = use_ipv6)
2670
interface=interface,
1235
2674
def server_activate(self):
1236
2675
if self.enabled:
1237
2676
return socketserver.TCPServer.server_activate(self)
1238
2678
def enable(self):
1239
2679
self.enabled = True
1240
def add_pipe(self, pipe):
2681
def add_pipe(self, parent_pipe, proc):
1241
2682
# Call "handle_ipc" for both data and EOF events
1242
gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1244
def handle_ipc(self, source, condition, file_objects={}):
1246
gobject.IO_IN: u"IN", # There is data to read.
1247
gobject.IO_OUT: u"OUT", # Data can be written (without
1249
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1250
gobject.IO_ERR: u"ERR", # Error condition.
1251
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1252
# broken, usually for pipes and
1255
conditions_string = ' | '.join(name
1257
condition_names.iteritems()
1258
if cond & condition)
1259
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1262
# Turn the pipe file descriptor into a Python file object
1263
if source not in file_objects:
1264
file_objects[source] = os.fdopen(source, u"r", 1)
1266
# Read a line from the file object
1267
cmdline = file_objects[source].readline()
1268
if not cmdline: # Empty line means end of file
1269
# close the IPC pipe
1270
file_objects[source].close()
1271
del file_objects[source]
1273
# Stop calling this function
1276
logger.debug(u"IPC command: %r", cmdline)
1278
# Parse and act on command
1279
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1281
if cmd == u"NOTFOUND":
1282
logger.warning(u"Client not found for fingerprint: %s",
1286
mandos_dbus_service.ClientNotFound(args)
1287
elif cmd == u"INVALID":
1288
for client in self.clients:
1289
if client.name == args:
1290
logger.warning(u"Client %s is invalid", args)
1296
logger.error(u"Unknown client %s is invalid", args)
1297
elif cmd == u"SENDING":
1298
for client in self.clients:
1299
if client.name == args:
1300
logger.info(u"Sending secret to %s", client.name)
1307
logger.error(u"Sending secret to unknown client %s",
2684
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2685
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2686
functools.partial(self.handle_ipc,
2687
parent_pipe=parent_pipe,
2690
def handle_ipc(self, source, condition,
2693
client_object=None):
2694
# error, or the other end of multiprocessing.Pipe has closed
2695
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2696
# Wait for other process to exit
2700
# Read a request from the child
2701
request = parent_pipe.recv()
2702
command = request[0]
2704
if command == 'init':
2705
key_id = request[1].decode("ascii")
2706
fpr = request[2].decode("ascii")
2707
address = request[3]
2709
for c in self.clients.values():
2710
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2712
if key_id and c.key_id == key_id:
2715
if fpr and c.fingerprint == fpr:
2719
logger.info("Client not found for key ID: %s, address"
2720
": %s", key_id or fpr, address)
2723
mandos_dbus_service.ClientNotFound(key_id or fpr,
2725
parent_pipe.send(False)
2729
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2730
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2731
functools.partial(self.handle_ipc,
2732
parent_pipe=parent_pipe,
2734
client_object=client))
2735
parent_pipe.send(True)
2736
# remove the old hook in favor of the new above hook on
2739
if command == 'funcall':
2740
funcname = request[1]
2744
parent_pipe.send(('data', getattr(client_object,
2748
if command == 'getattr':
2749
attrname = request[1]
2750
if isinstance(client_object.__getattribute__(attrname),
2751
collections.Callable):
2752
parent_pipe.send(('function', ))
2755
'data', client_object.__getattribute__(attrname)))
2757
if command == 'setattr':
2758
attrname = request[1]
2760
setattr(client_object, attrname, value)
2765
def rfc3339_duration_to_delta(duration):
2766
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2768
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2770
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2772
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2774
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2776
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2778
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2780
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2784
# Parsing an RFC 3339 duration with regular expressions is not
2785
# possible - there would have to be multiple places for the same
2786
# values, like seconds. The current code, while more esoteric, is
2787
# cleaner without depending on a parsing library. If Python had a
2788
# built-in library for parsing we would use it, but we'd like to
2789
# avoid excessive use of external libraries.
2791
# New type for defining tokens, syntax, and semantics all-in-one
2792
Token = collections.namedtuple("Token", (
2793
"regexp", # To match token; if "value" is not None, must have
2794
# a "group" containing digits
2795
"value", # datetime.timedelta or None
2796
"followers")) # Tokens valid after this token
2797
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2798
# the "duration" ABNF definition in RFC 3339, Appendix A.
2799
token_end = Token(re.compile(r"$"), None, frozenset())
2800
token_second = Token(re.compile(r"(\d+)S"),
2801
datetime.timedelta(seconds=1),
2802
frozenset((token_end, )))
2803
token_minute = Token(re.compile(r"(\d+)M"),
2804
datetime.timedelta(minutes=1),
2805
frozenset((token_second, token_end)))
2806
token_hour = Token(re.compile(r"(\d+)H"),
2807
datetime.timedelta(hours=1),
2808
frozenset((token_minute, token_end)))
2809
token_time = Token(re.compile(r"T"),
2811
frozenset((token_hour, token_minute,
2813
token_day = Token(re.compile(r"(\d+)D"),
2814
datetime.timedelta(days=1),
2815
frozenset((token_time, token_end)))
2816
token_month = Token(re.compile(r"(\d+)M"),
2817
datetime.timedelta(weeks=4),
2818
frozenset((token_day, token_end)))
2819
token_year = Token(re.compile(r"(\d+)Y"),
2820
datetime.timedelta(weeks=52),
2821
frozenset((token_month, token_end)))
2822
token_week = Token(re.compile(r"(\d+)W"),
2823
datetime.timedelta(weeks=1),
2824
frozenset((token_end, )))
2825
token_duration = Token(re.compile(r"P"), None,
2826
frozenset((token_year, token_month,
2827
token_day, token_time,
2829
# Define starting values:
2831
value = datetime.timedelta()
2833
# Following valid tokens
2834
followers = frozenset((token_duration, ))
2835
# String left to parse
2837
# Loop until end token is found
2838
while found_token is not token_end:
2839
# Search for any currently valid tokens
2840
for token in followers:
2841
match = token.regexp.match(s)
2842
if match is not None:
2844
if token.value is not None:
2845
# Value found, parse digits
2846
factor = int(match.group(1), 10)
2847
# Add to value so far
2848
value += factor * token.value
2849
# Strip token from string
2850
s = token.regexp.sub("", s, 1)
2853
# Set valid next tokens
2854
followers = found_token.followers
1310
logger.error(u"Unknown IPC command: %r", cmdline)
1312
# Keep calling this function
2857
# No currently valid tokens were found
2858
raise ValueError("Invalid RFC 3339 duration: {!r}"
1316
2864
def string_to_delta(interval):
1317
2865
"""Parse a string and return a datetime.timedelta
1319
>>> string_to_delta(u'7d')
1320
datetime.timedelta(7)
1321
>>> string_to_delta(u'60s')
1322
datetime.timedelta(0, 60)
1323
>>> string_to_delta(u'60m')
1324
datetime.timedelta(0, 3600)
1325
>>> string_to_delta(u'24h')
1326
datetime.timedelta(1)
1327
>>> string_to_delta(u'1w')
1328
datetime.timedelta(7)
1329
>>> string_to_delta(u'5m 30s')
1330
datetime.timedelta(0, 330)
2867
>>> string_to_delta('7d') == datetime.timedelta(7)
2869
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2871
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2873
>>> string_to_delta('24h') == datetime.timedelta(1)
2875
>>> string_to_delta('1w') == datetime.timedelta(7)
2877
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2882
return rfc3339_duration_to_delta(interval)
1332
2886
timevalue = datetime.timedelta(0)
1333
2887
for s in interval.split():
1335
suffix = unicode(s[-1])
1336
2890
value = int(s[:-1])
1338
2892
delta = datetime.timedelta(value)
1339
elif suffix == u"s":
1340
2894
delta = datetime.timedelta(0, value)
1341
elif suffix == u"m":
1342
2896
delta = datetime.timedelta(0, 0, 0, 0, value)
1343
elif suffix == u"h":
1344
2898
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1345
elif suffix == u"w":
1346
2900
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1349
except (ValueError, IndexError):
2902
raise ValueError("Unknown suffix {!r}".format(suffix))
2903
except IndexError as e:
2904
raise ValueError(*(e.args))
1351
2905
timevalue += delta
1352
2906
return timevalue
1355
def if_nametoindex(interface):
1356
"""Call the C function if_nametoindex(), or equivalent
1358
Note: This function cannot accept a unicode string."""
1359
global if_nametoindex
1361
if_nametoindex = (ctypes.cdll.LoadLibrary
1362
(ctypes.util.find_library(u"c"))
1364
except (OSError, AttributeError):
1365
logger.warning(u"Doing if_nametoindex the hard way")
1366
def if_nametoindex(interface):
1367
"Get an interface index the hard way, i.e. using fcntl()"
1368
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1369
with closing(socket.socket()) as s:
1370
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1371
struct.pack(str(u"16s16x"),
1373
interface_index = struct.unpack(str(u"I"),
1375
return interface_index
1376
return if_nametoindex(interface)
1379
def daemon(nochdir = False, noclose = False):
2909
def daemon(nochdir=False, noclose=False):
1380
2910
"""See daemon(3). Standard BSD Unix function.
1382
2912
This should really exist as os.daemon, but it doesn't (yet)."""
1386
2916
if not nochdir:
1390
2920
if not noclose:
1391
2921
# Close all standard open file descriptors
1392
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2922
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1393
2923
if not stat.S_ISCHR(os.fstat(null).st_mode):
1394
2924
raise OSError(errno.ENODEV,
1395
u"%s not a character device"
2925
"{} not a character device"
2926
.format(os.devnull))
1397
2927
os.dup2(null, sys.stdin.fileno())
1398
2928
os.dup2(null, sys.stdout.fileno())
1399
2929
os.dup2(null, sys.stderr.fileno())
1406
2936
##################################################################
1407
2937
# Parsing of options, both command line and config file
1409
parser = optparse.OptionParser(version = "%%prog %s" % version)
1410
parser.add_option("-i", u"--interface", type=u"string",
1411
metavar="IF", help=u"Bind to interface IF")
1412
parser.add_option("-a", u"--address", type=u"string",
1413
help=u"Address to listen for requests on")
1414
parser.add_option("-p", u"--port", type=u"int",
1415
help=u"Port number to receive requests on")
1416
parser.add_option("--check", action=u"store_true",
1417
help=u"Run self-test")
1418
parser.add_option("--debug", action=u"store_true",
1419
help=u"Debug mode; run in foreground and log to"
1421
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1422
u" priority string (see GnuTLS documentation)")
1423
parser.add_option("--servicename", type=u"string",
1424
metavar=u"NAME", help=u"Zeroconf service name")
1425
parser.add_option("--configdir", type=u"string",
1426
default=u"/etc/mandos", metavar=u"DIR",
1427
help=u"Directory to search for configuration"
1429
parser.add_option("--no-dbus", action=u"store_false",
1430
dest=u"use_dbus", help=u"Do not provide D-Bus"
1431
u" system bus interface")
1432
parser.add_option("--no-ipv6", action=u"store_false",
1433
dest=u"use_ipv6", help=u"Do not use IPv6")
1434
options = parser.parse_args()[0]
2939
parser = argparse.ArgumentParser()
2940
parser.add_argument("-v", "--version", action="version",
2941
version="%(prog)s {}".format(version),
2942
help="show version number and exit")
2943
parser.add_argument("-i", "--interface", metavar="IF",
2944
help="Bind to interface IF")
2945
parser.add_argument("-a", "--address",
2946
help="Address to listen for requests on")
2947
parser.add_argument("-p", "--port", type=int,
2948
help="Port number to receive requests on")
2949
parser.add_argument("--check", action="store_true",
2950
help="Run self-test")
2951
parser.add_argument("--debug", action="store_true",
2952
help="Debug mode; run in foreground and log"
2953
" to terminal", default=None)
2954
parser.add_argument("--debuglevel", metavar="LEVEL",
2955
help="Debug level for stdout output")
2956
parser.add_argument("--priority", help="GnuTLS"
2957
" priority string (see GnuTLS documentation)")
2958
parser.add_argument("--servicename",
2959
metavar="NAME", help="Zeroconf service name")
2960
parser.add_argument("--configdir",
2961
default="/etc/mandos", metavar="DIR",
2962
help="Directory to search for configuration"
2964
parser.add_argument("--no-dbus", action="store_false",
2965
dest="use_dbus", help="Do not provide D-Bus"
2966
" system bus interface", default=None)
2967
parser.add_argument("--no-ipv6", action="store_false",
2968
dest="use_ipv6", help="Do not use IPv6",
2970
parser.add_argument("--no-restore", action="store_false",
2971
dest="restore", help="Do not restore stored"
2972
" state", default=None)
2973
parser.add_argument("--socket", type=int,
2974
help="Specify a file descriptor to a network"
2975
" socket to use instead of creating one")
2976
parser.add_argument("--statedir", metavar="DIR",
2977
help="Directory to save/restore state in")
2978
parser.add_argument("--foreground", action="store_true",
2979
help="Run in foreground", default=None)
2980
parser.add_argument("--no-zeroconf", action="store_false",
2981
dest="zeroconf", help="Do not use Zeroconf",
2984
options = parser.parse_args()
1441
2986
# Default values for config file for server-global settings
1442
server_defaults = { u"interface": u"",
1447
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1448
u"servicename": u"Mandos",
1449
u"use_dbus": u"True",
1450
u"use_ipv6": u"True",
2987
if gnutls.has_rawpk:
2988
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2989
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2991
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2992
":+SIGN-DSA-SHA256")
2993
server_defaults = {"interface": "",
2997
"priority": priority,
2998
"servicename": "Mandos",
3004
"statedir": "/var/lib/mandos",
3005
"foreground": "False",
1453
3010
# Parse config file for server-global settings
1454
server_config = configparser.SafeConfigParser(server_defaults)
3011
server_config = configparser.ConfigParser(server_defaults)
1455
3012
del server_defaults
1456
server_config.read(os.path.join(options.configdir,
1458
# Convert the SafeConfigParser object to a dict
3013
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3014
# Convert the ConfigParser object to a dict
1459
3015
server_settings = server_config.defaults()
1460
3016
# Use the appropriate methods on the non-string config options
1461
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1462
server_settings[option] = server_config.getboolean(u"DEFAULT",
3017
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3018
"foreground", "zeroconf"):
3019
server_settings[option] = server_config.getboolean("DEFAULT",
1464
3021
if server_settings["port"]:
1465
server_settings["port"] = server_config.getint(u"DEFAULT",
3022
server_settings["port"] = server_config.getint("DEFAULT",
3024
if server_settings["socket"]:
3025
server_settings["socket"] = server_config.getint("DEFAULT",
3027
# Later, stdin will, and stdout and stderr might, be dup'ed
3028
# over with an opened os.devnull. But we don't want this to
3029
# happen with a supplied network socket.
3030
if 0 <= server_settings["socket"] <= 2:
3031
server_settings["socket"] = os.dup(server_settings
1467
3033
del server_config
1469
3035
# Override the settings from the config file with command line
1470
3036
# options, if set.
1471
for option in (u"interface", u"address", u"port", u"debug",
1472
u"priority", u"servicename", u"configdir",
1473
u"use_dbus", u"use_ipv6"):
3037
for option in ("interface", "address", "port", "debug",
3038
"priority", "servicename", "configdir", "use_dbus",
3039
"use_ipv6", "debuglevel", "restore", "statedir",
3040
"socket", "foreground", "zeroconf"):
1474
3041
value = getattr(options, option)
1475
3042
if value is not None:
1476
3043
server_settings[option] = value
1478
3045
# Force all strings to be unicode
1479
3046
for option in server_settings.keys():
1480
if type(server_settings[option]) is str:
1481
server_settings[option] = unicode(server_settings[option])
3047
if isinstance(server_settings[option], bytes):
3048
server_settings[option] = (server_settings[option]
3050
# Force all boolean options to be boolean
3051
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3052
"foreground", "zeroconf"):
3053
server_settings[option] = bool(server_settings[option])
3054
# Debug implies foreground
3055
if server_settings["debug"]:
3056
server_settings["foreground"] = True
1482
3057
# Now we have our good server settings in "server_settings"
1484
3059
##################################################################
3061
if (not server_settings["zeroconf"]
3062
and not (server_settings["port"]
3063
or server_settings["socket"] != "")):
3064
parser.error("Needs port or socket to work without Zeroconf")
1486
3066
# For convenience
1487
debug = server_settings[u"debug"]
1488
use_dbus = server_settings[u"use_dbus"]
1489
use_ipv6 = server_settings[u"use_ipv6"]
1492
syslogger.setLevel(logging.WARNING)
1493
console.setLevel(logging.WARNING)
1495
if server_settings[u"servicename"] != u"Mandos":
1496
syslogger.setFormatter(logging.Formatter
1497
(u'Mandos (%s) [%%(process)d]:'
1498
u' %%(levelname)s: %%(message)s'
1499
% server_settings[u"servicename"]))
3067
debug = server_settings["debug"]
3068
debuglevel = server_settings["debuglevel"]
3069
use_dbus = server_settings["use_dbus"]
3070
use_ipv6 = server_settings["use_ipv6"]
3071
stored_state_path = os.path.join(server_settings["statedir"],
3073
foreground = server_settings["foreground"]
3074
zeroconf = server_settings["zeroconf"]
3077
initlogger(debug, logging.DEBUG)
3082
level = getattr(logging, debuglevel.upper())
3083
initlogger(debug, level)
3085
if server_settings["servicename"] != "Mandos":
3086
syslogger.setFormatter(
3087
logging.Formatter('Mandos ({}) [%(process)d]:'
3088
' %(levelname)s: %(message)s'.format(
3089
server_settings["servicename"])))
1501
3091
# Parse config file with clients
1502
client_defaults = { u"timeout": u"1h",
1504
u"checker": u"fping -q -- %%(host)s",
1507
client_config = configparser.SafeConfigParser(client_defaults)
1508
client_config.read(os.path.join(server_settings[u"configdir"],
3092
client_config = configparser.ConfigParser(Client.client_defaults)
3093
client_config.read(os.path.join(server_settings["configdir"],
1511
3096
global mandos_dbus_service
1512
3097
mandos_dbus_service = None
1514
tcp_server = MandosServer((server_settings[u"address"],
1515
server_settings[u"port"]),
1517
interface=server_settings[u"interface"],
1520
server_settings[u"priority"],
1522
pidfilename = u"/var/run/mandos.pid"
1524
pidfile = open(pidfilename, u"w")
1526
logger.error(u"Could not open file %r", pidfilename)
1529
uid = pwd.getpwnam(u"_mandos").pw_uid
1530
gid = pwd.getpwnam(u"_mandos").pw_gid
1533
uid = pwd.getpwnam(u"mandos").pw_uid
1534
gid = pwd.getpwnam(u"mandos").pw_gid
3100
if server_settings["socket"] != "":
3101
socketfd = server_settings["socket"]
3102
tcp_server = MandosServer(
3103
(server_settings["address"], server_settings["port"]),
3105
interface=(server_settings["interface"] or None),
3107
gnutls_priority=server_settings["priority"],
3111
pidfilename = "/run/mandos.pid"
3112
if not os.path.isdir("/run/."):
3113
pidfilename = "/var/run/mandos.pid"
3116
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3117
except IOError as e:
3118
logger.error("Could not open file %r", pidfilename,
3121
for name, group in (("_mandos", "_mandos"),
3122
("mandos", "mandos"),
3123
("nobody", "nogroup")):
3125
uid = pwd.getpwnam(name).pw_uid
3126
gid = pwd.getpwnam(group).pw_gid
1535
3128
except KeyError:
1537
uid = pwd.getpwnam(u"nobody").pw_uid
1538
gid = pwd.getpwnam(u"nobody").pw_gid
1545
except OSError, error:
1546
if error[0] != errno.EPERM:
1549
# Enable all possible GnuTLS debugging
3137
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3139
except OSError as error:
3140
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3141
.format(uid, gid, os.strerror(error.errno)))
3142
if error.errno != errno.EPERM:
3146
# Enable all possible GnuTLS debugging
1551
3148
# "Use a log level over 10 to enable all debugging options."
1552
3149
# - GnuTLS manual
1553
gnutls.library.functions.gnutls_global_set_log_level(11)
1555
@gnutls.library.types.gnutls_log_func
3150
gnutls.global_set_log_level(11)
1556
3153
def debug_gnutls(level, string):
1557
logger.debug(u"GnuTLS: %s", string[:-1])
1559
(gnutls.library.functions
1560
.gnutls_global_set_log_function(debug_gnutls))
3154
logger.debug("GnuTLS: %s", string[:-1])
3156
gnutls.global_set_log_function(debug_gnutls)
3158
# Redirect stdin so all checkers get /dev/null
3159
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3160
os.dup2(null, sys.stdin.fileno())
3164
# Need to fork before connecting to D-Bus
3166
# Close all input and output, do double fork, etc.
3169
if gi.version_info < (3, 10, 2):
3170
# multiprocessing will use threads, so before we use GLib we
3171
# need to inform GLib that threads will be used.
1562
3174
global main_loop
1563
3175
# From the Avahi example code
1564
DBusGMainLoop(set_as_default=True )
1565
main_loop = gobject.MainLoop()
3176
DBusGMainLoop(set_as_default=True)
3177
main_loop = GLib.MainLoop()
1566
3178
bus = dbus.SystemBus()
1567
3179
# End of Avahi example code
1569
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1570
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1571
service = AvahiService(name = server_settings[u"servicename"],
1572
servicetype = u"_mandos._tcp",
1573
protocol = protocol, bus = bus)
1574
if server_settings["interface"]:
1575
service.interface = (if_nametoindex
1576
(str(server_settings[u"interface"])))
3182
bus_name = dbus.service.BusName("se.recompile.Mandos",
3185
old_bus_name = dbus.service.BusName(
3186
"se.bsnet.fukt.Mandos", bus,
3188
except dbus.exceptions.DBusException as e:
3189
logger.error("Disabling D-Bus:", exc_info=e)
3191
server_settings["use_dbus"] = False
3192
tcp_server.use_dbus = False
3194
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3195
service = AvahiServiceToSyslog(
3196
name=server_settings["servicename"],
3197
servicetype="_mandos._tcp",
3200
if server_settings["interface"]:
3201
service.interface = if_nametoindex(
3202
server_settings["interface"].encode("utf-8"))
3204
global multiprocessing_manager
3205
multiprocessing_manager = multiprocessing.Manager()
1578
3207
client_class = Client
1580
client_class = functools.partial(ClientDBus, bus = bus)
1581
tcp_server.clients.update(set(
1582
client_class(name = section,
1583
config= dict(client_config.items(section)))
1584
for section in client_config.sections()))
3209
client_class = functools.partial(ClientDBus, bus=bus)
3211
client_settings = Client.config_parser(client_config)
3212
old_client_settings = {}
3215
# This is used to redirect stdout and stderr for checker processes
3217
wnull = open(os.devnull, "w") # A writable /dev/null
3218
# Only used if server is running in foreground but not in debug
3220
if debug or not foreground:
3223
# Get client data and settings from last running state.
3224
if server_settings["restore"]:
3226
with open(stored_state_path, "rb") as stored_state:
3227
if sys.version_info.major == 2:
3228
clients_data, old_client_settings = pickle.load(
3231
bytes_clients_data, bytes_old_client_settings = (
3232
pickle.load(stored_state, encoding="bytes"))
3233
# Fix bytes to strings
3236
clients_data = {(key.decode("utf-8")
3237
if isinstance(key, bytes)
3240
bytes_clients_data.items()}
3241
del bytes_clients_data
3242
for key in clients_data:
3243
value = {(k.decode("utf-8")
3244
if isinstance(k, bytes) else k): v
3246
clients_data[key].items()}
3247
clients_data[key] = value
3249
value["client_structure"] = [
3251
if isinstance(s, bytes)
3253
value["client_structure"]]
3254
# .name, .host, and .checker_command
3255
for k in ("name", "host", "checker_command"):
3256
if isinstance(value[k], bytes):
3257
value[k] = value[k].decode("utf-8")
3258
if "key_id" not in value:
3259
value["key_id"] = ""
3260
elif "fingerprint" not in value:
3261
value["fingerprint"] = ""
3262
# old_client_settings
3264
old_client_settings = {
3265
(key.decode("utf-8")
3266
if isinstance(key, bytes)
3269
bytes_old_client_settings.items()}
3270
del bytes_old_client_settings
3271
# .host and .checker_command
3272
for value in old_client_settings.values():
3273
for attribute in ("host", "checker_command"):
3274
if isinstance(value[attribute], bytes):
3275
value[attribute] = (value[attribute]
3277
os.remove(stored_state_path)
3278
except IOError as e:
3279
if e.errno == errno.ENOENT:
3280
logger.warning("Could not load persistent state:"
3281
" {}".format(os.strerror(e.errno)))
3283
logger.critical("Could not load persistent state:",
3286
except EOFError as e:
3287
logger.warning("Could not load persistent state: "
3291
with PGPEngine() as pgp:
3292
for client_name, client in clients_data.items():
3293
# Skip removed clients
3294
if client_name not in client_settings:
3297
# Decide which value to use after restoring saved state.
3298
# We have three different values: Old config file,
3299
# new config file, and saved state.
3300
# New config value takes precedence if it differs from old
3301
# config value, otherwise use saved state.
3302
for name, value in client_settings[client_name].items():
3304
# For each value in new config, check if it
3305
# differs from the old config value (Except for
3306
# the "secret" attribute)
3307
if (name != "secret"
3309
old_client_settings[client_name][name])):
3310
client[name] = value
3314
# Clients who has passed its expire date can still be
3315
# enabled if its last checker was successful. A Client
3316
# whose checker succeeded before we stored its state is
3317
# assumed to have successfully run all checkers during
3319
if client["enabled"]:
3320
if datetime.datetime.utcnow() >= client["expires"]:
3321
if not client["last_checked_ok"]:
3323
"disabling client {} - Client never "
3324
"performed a successful checker".format(
3326
client["enabled"] = False
3327
elif client["last_checker_status"] != 0:
3329
"disabling client {} - Client last"
3330
" checker failed with error code"
3333
client["last_checker_status"]))
3334
client["enabled"] = False
3336
client["expires"] = (
3337
datetime.datetime.utcnow()
3338
+ client["timeout"])
3339
logger.debug("Last checker succeeded,"
3340
" keeping {} enabled".format(
3343
client["secret"] = pgp.decrypt(
3344
client["encrypted_secret"],
3345
client_settings[client_name]["secret"])
3347
# If decryption fails, we use secret from new settings
3348
logger.debug("Failed to decrypt {} old secret".format(
3350
client["secret"] = (client_settings[client_name]
3353
# Add/remove clients based on new changes made to config
3354
for client_name in (set(old_client_settings)
3355
- set(client_settings)):
3356
del clients_data[client_name]
3357
for client_name in (set(client_settings)
3358
- set(old_client_settings)):
3359
clients_data[client_name] = client_settings[client_name]
3361
# Create all client objects
3362
for client_name, client in clients_data.items():
3363
tcp_server.clients[client_name] = client_class(
3366
server_settings=server_settings)
1585
3368
if not tcp_server.clients:
1586
logger.warning(u"No clients defined")
1589
# Redirect stdin so all checkers get /dev/null
1590
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1591
os.dup2(null, sys.stdin.fileno())
1595
# No console logging
1596
logger.removeHandler(console)
1597
# Close all input and output, do double fork, etc.
1601
with closing(pidfile):
3369
logger.warning("No clients defined")
3372
if pidfile is not None:
1602
3373
pid = os.getpid()
1603
pidfile.write(str(pid) + "\n")
3376
print(pid, file=pidfile)
3378
logger.error("Could not write to file %r with PID %d",
1606
logger.error(u"Could not write to file %r with PID %d",
1609
# "pidfile" was never created
1614
"Cleanup function; run on exit"
1617
while tcp_server.clients:
1618
client = tcp_server.clients.pop()
1619
client.disable_hook = None
1622
atexit.register(cleanup)
1625
signal.signal(signal.SIGINT, signal.SIG_IGN)
1626
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1627
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3383
for termsig in (signal.SIGHUP, signal.SIGTERM):
3384
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3385
lambda: main_loop.quit() and False)
1630
class MandosDBusService(dbus.service.Object):
3389
@alternate_dbus_interfaces(
3390
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3391
class MandosDBusService(DBusObjectWithObjectManager):
1631
3392
"""A D-Bus proxy object"""
1632
3394
def __init__(self):
1633
dbus.service.Object.__init__(self, bus, u"/")
1634
_interface = u"se.bsnet.fukt.Mandos"
1636
@dbus.service.signal(_interface, signature=u"oa{sv}")
1637
def ClientAdded(self, objpath, properties):
1641
@dbus.service.signal(_interface, signature=u"s")
1642
def ClientNotFound(self, fingerprint):
1646
@dbus.service.signal(_interface, signature=u"os")
3395
dbus.service.Object.__init__(self, bus, "/")
3397
_interface = "se.recompile.Mandos"
3399
@dbus.service.signal(_interface, signature="o")
3400
def ClientAdded(self, objpath):
3404
@dbus.service.signal(_interface, signature="ss")
3405
def ClientNotFound(self, key_id, address):
3409
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3411
@dbus.service.signal(_interface, signature="os")
1647
3412
def ClientRemoved(self, objpath, name):
1651
@dbus.service.method(_interface, out_signature=u"ao")
3416
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3418
@dbus.service.method(_interface, out_signature="ao")
1652
3419
def GetAllClients(self):
1654
return dbus.Array(c.dbus_object_path
1655
for c in tcp_server.clients)
3421
return dbus.Array(c.dbus_object_path for c in
3422
tcp_server.clients.values())
3424
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1657
3426
@dbus.service.method(_interface,
1658
out_signature=u"a{oa{sv}}")
3427
out_signature="a{oa{sv}}")
1659
3428
def GetAllClientsWithProperties(self):
1661
3430
return dbus.Dictionary(
1662
((c.dbus_object_path, c.GetAll(u""))
1663
for c in tcp_server.clients),
1664
signature=u"oa{sv}")
1666
@dbus.service.method(_interface, in_signature=u"o")
3431
{c.dbus_object_path: c.GetAll(
3432
"se.recompile.Mandos.Client")
3433
for c in tcp_server.clients.values()},
3436
@dbus.service.method(_interface, in_signature="o")
1667
3437
def RemoveClient(self, object_path):
1669
for c in tcp_server.clients:
3439
for c in tcp_server.clients.values():
1670
3440
if c.dbus_object_path == object_path:
1671
tcp_server.clients.remove(c)
3441
del tcp_server.clients[c.name]
1672
3442
c.remove_from_connection()
1673
# Don't signal anything except ClientRemoved
1674
c.disable(signal=False)
1676
self.ClientRemoved(object_path, c.name)
3443
# Don't signal the disabling
3444
c.disable(quiet=True)
3445
# Emit D-Bus signal for removal
3446
self.client_removed_signal(c)
3448
raise KeyError(object_path)
3452
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3453
out_signature="a{oa{sa{sv}}}")
3454
def GetManagedObjects(self):
3456
return dbus.Dictionary(
3457
{client.dbus_object_path:
3459
{interface: client.GetAll(interface)
3461
client._get_all_interface_names()})
3462
for client in tcp_server.clients.values()})
3464
def client_added_signal(self, client):
3465
"""Send the new standard signal and the old signal"""
3467
# New standard signal
3468
self.InterfacesAdded(
3469
client.dbus_object_path,
3471
{interface: client.GetAll(interface)
3473
client._get_all_interface_names()}))
3475
self.ClientAdded(client.dbus_object_path)
3477
def client_removed_signal(self, client):
3478
"""Send the new standard signal and the old signal"""
3480
# New standard signal
3481
self.InterfacesRemoved(
3482
client.dbus_object_path,
3483
client._get_all_interface_names())
3485
self.ClientRemoved(client.dbus_object_path,
1682
3488
mandos_dbus_service = MandosDBusService()
1684
for client in tcp_server.clients:
3490
# Save modules to variables to exempt the modules from being
3491
# unloaded before the function registered with atexit() is run.
3492
mp = multiprocessing
3496
"Cleanup function; run on exit"
3500
mp.active_children()
3502
if not (tcp_server.clients or client_settings):
3505
# Store client before exiting. Secrets are encrypted with key
3506
# based on what config file has. If config file is
3507
# removed/edited, old secret will thus be unrecovable.
3509
with PGPEngine() as pgp:
3510
for client in tcp_server.clients.values():
3511
key = client_settings[client.name]["secret"]
3512
client.encrypted_secret = pgp.encrypt(client.secret,
3516
# A list of attributes that can not be pickled
3518
exclude = {"bus", "changedstate", "secret",
3519
"checker", "server_settings"}
3520
for name, typ in inspect.getmembers(dbus.service
3524
client_dict["encrypted_secret"] = (client
3526
for attr in client.client_structure:
3527
if attr not in exclude:
3528
client_dict[attr] = getattr(client, attr)
3530
clients[client.name] = client_dict
3531
del client_settings[client.name]["secret"]
3534
with tempfile.NamedTemporaryFile(
3538
dir=os.path.dirname(stored_state_path),
3539
delete=False) as stored_state:
3540
pickle.dump((clients, client_settings), stored_state,
3542
tempname = stored_state.name
3543
os.rename(tempname, stored_state_path)
3544
except (IOError, OSError) as e:
3550
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3551
logger.warning("Could not save persistent state: {}"
3552
.format(os.strerror(e.errno)))
3554
logger.warning("Could not save persistent state:",
3558
# Delete all clients, and settings from config
3559
while tcp_server.clients:
3560
name, client = tcp_server.clients.popitem()
3562
client.remove_from_connection()
3563
# Don't signal the disabling
3564
client.disable(quiet=True)
3565
# Emit D-Bus signal for removal
3567
mandos_dbus_service.client_removed_signal(client)
3568
client_settings.clear()
3570
atexit.register(cleanup)
3572
for client in tcp_server.clients.values():
1687
mandos_dbus_service.ClientAdded(client.dbus_object_path,
3574
# Emit D-Bus signal for adding
3575
mandos_dbus_service.client_added_signal(client)
3576
# Need to initiate checking of clients
3578
client.init_checker()
1691
3580
tcp_server.enable()
1692
3581
tcp_server.server_activate()
1694
3583
# Find out what port we got
1695
service.port = tcp_server.socket.getsockname()[1]
3585
service.port = tcp_server.socket.getsockname()[1]
1697
logger.info(u"Now listening on address %r, port %d,"
1698
" flowinfo %d, scope_id %d"
1699
% tcp_server.socket.getsockname())
3587
logger.info("Now listening on address %r, port %d,"
3588
" flowinfo %d, scope_id %d",
3589
*tcp_server.socket.getsockname())
1701
logger.info(u"Now listening on address %r, port %d"
1702
% tcp_server.socket.getsockname())
1704
#service.interface = tcp_server.socket.getsockname()[3]
3591
logger.info("Now listening on address %r, port %d",
3592
*tcp_server.socket.getsockname())
3594
# service.interface = tcp_server.socket.getsockname()[3]
1707
# From the Avahi example code
1710
except dbus.exceptions.DBusException, error:
1711
logger.critical(u"DBusException: %s", error)
1713
# End of Avahi example code
1715
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1716
lambda *args, **kwargs:
1717
(tcp_server.handle_request
1718
(*args[2:], **kwargs) or True))
1720
logger.debug(u"Starting main loop")
3598
# From the Avahi example code
3601
except dbus.exceptions.DBusException as error:
3602
logger.critical("D-Bus Exception", exc_info=error)
3605
# End of Avahi example code
3608
GLib.IOChannel.unix_new(tcp_server.fileno()),
3609
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3610
lambda *args, **kwargs: (tcp_server.handle_request
3611
(*args[2:], **kwargs) or True))
3613
logger.debug("Starting main loop")
1721
3614
main_loop.run()
1722
except AvahiError, error:
1723
logger.critical(u"AvahiError: %s", error)
3615
except AvahiError as error:
3616
logger.critical("Avahi Error", exc_info=error)
1725
3619
except KeyboardInterrupt:
1728
logger.debug(u"Server received KeyboardInterrupt")
1729
logger.debug(u"Server exiting")
3621
print("", file=sys.stderr)
3622
logger.debug("Server received KeyboardInterrupt")
3623
logger.debug("Server exiting")
3624
# Must run before the D-Bus bus name gets deregistered
3628
def should_only_run_tests():
3629
parser = argparse.ArgumentParser(add_help=False)
3630
parser.add_argument("--check", action='store_true')
3631
args, unknown_args = parser.parse_known_args()
3632
run_tests = args.check
3634
# Remove --check argument from sys.argv
3635
sys.argv[1:] = unknown_args
3638
# Add all tests from doctest strings
3639
def load_tests(loader, tests, none):
3641
tests.addTests(doctest.DocTestSuite())
1731
3644
if __name__ == '__main__':
3646
if should_only_run_tests():
3647
# Call using ./mandos --check [--verbose]