447
193
dbus.UInt16(self.port),
448
194
avahi.string_array_to_txt_array(self.TXT))
449
195
self.group.Commit()
451
196
def entry_group_state_changed(self, state, error):
452
197
"""Derived from the Avahi example code"""
453
logger.debug("Avahi entry group state change: %i", state)
198
logger.debug(u"Avahi state change: %i", state)
455
200
if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
logger.debug("Zeroconf service established.")
201
logger.debug(u"Zeroconf service established.")
457
202
elif state == avahi.ENTRY_GROUP_COLLISION:
458
logger.info("Zeroconf service name collision.")
203
logger.warning(u"Zeroconf service name collision.")
460
205
elif state == avahi.ENTRY_GROUP_FAILURE:
461
logger.critical("Avahi: Error in group state changed %s",
463
raise AvahiGroupError("State changed: {!s}".format(error))
206
logger.critical(u"Avahi: Error in group state changed %s",
208
raise AvahiGroupError(u"State changed: %s"
465
210
def cleanup(self):
466
211
"""Derived from the Avahi example code"""
467
212
if self.group is not None:
470
except (dbus.exceptions.UnknownMethodException,
471
dbus.exceptions.DBusException):
473
214
self.group = None
476
def server_state_changed(self, state, error=None):
215
def server_state_changed(self, state):
477
216
"""Derived from the Avahi example code"""
478
logger.debug("Avahi server state change: %i", state)
480
avahi.SERVER_INVALID: "Zeroconf server invalid",
481
avahi.SERVER_REGISTERING: None,
482
avahi.SERVER_COLLISION: "Zeroconf server name collision",
483
avahi.SERVER_FAILURE: "Zeroconf server failure",
485
if state in bad_states:
486
if bad_states[state] is not None:
488
logger.error(bad_states[state])
490
logger.error(bad_states[state] + ": %r", error)
217
if state == avahi.SERVER_COLLISION:
218
logger.error(u"Zeroconf server name collision")
492
220
elif state == avahi.SERVER_RUNNING:
495
except dbus.exceptions.DBusException as error:
496
if (error.get_dbus_name()
497
== "org.freedesktop.Avahi.CollisionError"):
498
logger.info("Local Zeroconf service name"
500
return self.rename(remove=False)
502
logger.critical("D-Bus Exception", exc_info=error)
507
logger.debug("Unknown state: %r", state)
509
logger.debug("Unknown state: %r: %r", state, error)
511
222
def activate(self):
512
223
"""Derived from the Avahi example code"""
513
224
if self.server is None:
514
225
self.server = dbus.Interface(
515
226
self.bus.get_object(avahi.DBUS_NAME,
516
avahi.DBUS_PATH_SERVER,
517
follow_name_owner_changes=True),
227
avahi.DBUS_PATH_SERVER),
518
228
avahi.DBUS_INTERFACE_SERVER)
519
self.server.connect_to_signal("StateChanged",
520
self.server_state_changed)
229
self.server.connect_to_signal(u"StateChanged",
230
self.server_state_changed)
521
231
self.server_state_changed(self.server.GetState())
524
class AvahiServiceToSyslog(AvahiService):
525
def rename(self, *args, **kwargs):
526
"""Add the new name to the syslog messages"""
527
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
528
syslogger.setFormatter(logging.Formatter(
529
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
534
# Pretend that we have a GnuTLS module
536
"""This isn't so much a class as it is a module-like namespace."""
538
library = ctypes.util.find_library("gnutls")
540
library = ctypes.util.find_library("gnutls-deb0")
541
_library = ctypes.cdll.LoadLibrary(library)
544
# Unless otherwise indicated, the constants and types below are
545
# all from the gnutls/gnutls.h C header file.
556
E_NO_CERTIFICATE_FOUND = -49
561
KEYID_USE_SHA256 = 1 # gnutls/x509.h
562
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
565
class session_int(ctypes.Structure):
567
session_t = ctypes.POINTER(session_int)
569
class certificate_credentials_st(ctypes.Structure):
571
certificate_credentials_t = ctypes.POINTER(
572
certificate_credentials_st)
573
certificate_type_t = ctypes.c_int
575
class datum_t(ctypes.Structure):
576
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
577
('size', ctypes.c_uint)]
579
class openpgp_crt_int(ctypes.Structure):
581
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
582
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
583
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
credentials_type_t = ctypes.c_int
585
transport_ptr_t = ctypes.c_void_p
586
close_request_t = ctypes.c_int
589
class Error(Exception):
590
def __init__(self, message=None, code=None, args=()):
591
# Default usage is by a message string, but if a return
592
# code is passed, convert it to a string with
595
if message is None and code is not None:
596
message = gnutls.strerror(code)
597
return super(gnutls.Error, self).__init__(
600
class CertificateSecurityError(Error):
606
self._c_object = gnutls.certificate_credentials_t()
607
gnutls.certificate_allocate_credentials(
608
ctypes.byref(self._c_object))
609
self.type = gnutls.CRD_CERTIFICATE
612
gnutls.certificate_free_credentials(self._c_object)
615
def __init__(self, socket, credentials=None):
616
self._c_object = gnutls.session_t()
617
gnutls_flags = gnutls.CLIENT
618
if gnutls.check_version(b"3.5.6"):
619
gnutls_flags |= gnutls.NO_TICKETS
621
gnutls_flags |= gnutls.ENABLE_RAWPK
622
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
624
gnutls.set_default_priority(self._c_object)
625
gnutls.transport_set_ptr(self._c_object, socket.fileno())
626
gnutls.handshake_set_private_extensions(self._c_object,
629
if credentials is None:
630
credentials = gnutls.Credentials()
631
gnutls.credentials_set(self._c_object, credentials.type,
632
ctypes.cast(credentials._c_object,
634
self.credentials = credentials
637
gnutls.deinit(self._c_object)
640
return gnutls.handshake(self._c_object)
642
def send(self, data):
646
data_len -= gnutls.record_send(self._c_object,
651
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
653
# Error handling functions
654
def _error_code(result):
655
"""A function to raise exceptions on errors, suitable
656
for the 'restype' attribute on ctypes functions"""
659
if result == gnutls.E_NO_CERTIFICATE_FOUND:
660
raise gnutls.CertificateSecurityError(code=result)
661
raise gnutls.Error(code=result)
663
def _retry_on_error(result, func, arguments):
664
"""A function to retry on some errors, suitable
665
for the 'errcheck' attribute on ctypes functions"""
667
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
668
return _error_code(result)
669
result = func(*arguments)
672
# Unless otherwise indicated, the function declarations below are
673
# all from the gnutls/gnutls.h C header file.
676
priority_set_direct = _library.gnutls_priority_set_direct
677
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
678
ctypes.POINTER(ctypes.c_char_p)]
679
priority_set_direct.restype = _error_code
681
init = _library.gnutls_init
682
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
683
init.restype = _error_code
685
set_default_priority = _library.gnutls_set_default_priority
686
set_default_priority.argtypes = [session_t]
687
set_default_priority.restype = _error_code
689
record_send = _library.gnutls_record_send
690
record_send.argtypes = [session_t, ctypes.c_void_p,
692
record_send.restype = ctypes.c_ssize_t
693
record_send.errcheck = _retry_on_error
695
certificate_allocate_credentials = (
696
_library.gnutls_certificate_allocate_credentials)
697
certificate_allocate_credentials.argtypes = [
698
ctypes.POINTER(certificate_credentials_t)]
699
certificate_allocate_credentials.restype = _error_code
701
certificate_free_credentials = (
702
_library.gnutls_certificate_free_credentials)
703
certificate_free_credentials.argtypes = [
704
certificate_credentials_t]
705
certificate_free_credentials.restype = None
707
handshake_set_private_extensions = (
708
_library.gnutls_handshake_set_private_extensions)
709
handshake_set_private_extensions.argtypes = [session_t,
711
handshake_set_private_extensions.restype = None
713
credentials_set = _library.gnutls_credentials_set
714
credentials_set.argtypes = [session_t, credentials_type_t,
716
credentials_set.restype = _error_code
718
strerror = _library.gnutls_strerror
719
strerror.argtypes = [ctypes.c_int]
720
strerror.restype = ctypes.c_char_p
722
certificate_type_get = _library.gnutls_certificate_type_get
723
certificate_type_get.argtypes = [session_t]
724
certificate_type_get.restype = _error_code
726
certificate_get_peers = _library.gnutls_certificate_get_peers
727
certificate_get_peers.argtypes = [session_t,
728
ctypes.POINTER(ctypes.c_uint)]
729
certificate_get_peers.restype = ctypes.POINTER(datum_t)
731
global_set_log_level = _library.gnutls_global_set_log_level
732
global_set_log_level.argtypes = [ctypes.c_int]
733
global_set_log_level.restype = None
735
global_set_log_function = _library.gnutls_global_set_log_function
736
global_set_log_function.argtypes = [log_func]
737
global_set_log_function.restype = None
739
deinit = _library.gnutls_deinit
740
deinit.argtypes = [session_t]
741
deinit.restype = None
743
handshake = _library.gnutls_handshake
744
handshake.argtypes = [session_t]
745
handshake.restype = _error_code
746
handshake.errcheck = _retry_on_error
748
transport_set_ptr = _library.gnutls_transport_set_ptr
749
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
750
transport_set_ptr.restype = None
752
bye = _library.gnutls_bye
753
bye.argtypes = [session_t, close_request_t]
754
bye.restype = _error_code
755
bye.errcheck = _retry_on_error
757
check_version = _library.gnutls_check_version
758
check_version.argtypes = [ctypes.c_char_p]
759
check_version.restype = ctypes.c_char_p
761
_need_version = b"3.3.0"
762
if check_version(_need_version) is None:
763
raise self.Error("Needs GnuTLS {} or later"
764
.format(_need_version))
766
_tls_rawpk_version = b"3.6.6"
767
has_rawpk = bool(check_version(_tls_rawpk_version))
771
class pubkey_st(ctypes.Structure):
773
pubkey_t = ctypes.POINTER(pubkey_st)
775
x509_crt_fmt_t = ctypes.c_int
777
# All the function declarations below are from gnutls/abstract.h
778
pubkey_init = _library.gnutls_pubkey_init
779
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
780
pubkey_init.restype = _error_code
782
pubkey_import = _library.gnutls_pubkey_import
783
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
785
pubkey_import.restype = _error_code
787
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
788
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
789
ctypes.POINTER(ctypes.c_ubyte),
790
ctypes.POINTER(ctypes.c_size_t)]
791
pubkey_get_key_id.restype = _error_code
793
pubkey_deinit = _library.gnutls_pubkey_deinit
794
pubkey_deinit.argtypes = [pubkey_t]
795
pubkey_deinit.restype = None
797
# All the function declarations below are from gnutls/openpgp.h
799
openpgp_crt_init = _library.gnutls_openpgp_crt_init
800
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
801
openpgp_crt_init.restype = _error_code
803
openpgp_crt_import = _library.gnutls_openpgp_crt_import
804
openpgp_crt_import.argtypes = [openpgp_crt_t,
805
ctypes.POINTER(datum_t),
807
openpgp_crt_import.restype = _error_code
809
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
810
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
811
ctypes.POINTER(ctypes.c_uint)]
812
openpgp_crt_verify_self.restype = _error_code
814
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
815
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
816
openpgp_crt_deinit.restype = None
818
openpgp_crt_get_fingerprint = (
819
_library.gnutls_openpgp_crt_get_fingerprint)
820
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
824
openpgp_crt_get_fingerprint.restype = _error_code
826
if check_version(b"3.6.4"):
827
certificate_type_get2 = _library.gnutls_certificate_type_get2
828
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
829
certificate_type_get2.restype = _error_code
831
# Remove non-public functions
832
del _error_code, _retry_on_error
835
def call_pipe(connection, # : multiprocessing.Connection
836
func, *args, **kwargs):
837
"""This function is meant to be called by multiprocessing.Process
839
This function runs func(*args, **kwargs), and writes the resulting
840
return value on the provided multiprocessing.Connection.
842
connection.send(func(*args, **kwargs))
235
# approved_by_default (Config option for each client)
236
# approved_delay (config option for each client)
237
# approved_duration (config option for each client)
238
class Client(object):
847
239
"""A representation of a client host served by this server.
850
approved: bool(); 'None' if not yet approved/disapproved
851
approval_delay: datetime.timedelta(); Time to wait for approval
852
approval_duration: datetime.timedelta(); Duration of one approval
853
checker: multiprocessing.Process(); a running checker process used
854
to see if the client lives. 'None' if no process is
856
checker_callback_tag: a GLib event source tag, or None
857
checker_command: string; External command which is run to check
858
if client lives. %() expansions are done at
859
runtime with vars(self) as dict, so that for
860
instance %(name)s can be used in the command.
861
checker_initiator_tag: a GLib event source tag, or None
242
name: string; from the config file, used in log messages and
244
fingerprint: string (40 or 32 hexadecimal digits); used to
245
uniquely identify the client
246
secret: bytestring; sent verbatim (over TLS) to client
247
host: string; available for use by the checker command
862
248
created: datetime.datetime(); (UTC) object creation
863
client_structure: Object describing what attributes a client has
864
and is used for storing the client at exit
865
current_checker_command: string; current running checker_command
866
disable_initiator_tag: a GLib event source tag, or None
249
last_enabled: datetime.datetime(); (UTC)
868
fingerprint: string (40 or 32 hexadecimal digits); used to
869
uniquely identify an OpenPGP client
870
key_id: string (64 hexadecimal digits); used to uniquely identify
871
a client using raw public keys
872
host: string; available for use by the checker command
873
interval: datetime.timedelta(); How often to start a new checker
874
last_approval_request: datetime.datetime(); (UTC) or None
875
251
last_checked_ok: datetime.datetime(); (UTC) or None
876
last_checker_status: integer between 0 and 255 reflecting exit
877
status of last checker. -1 reflects crashed
878
checker, -2 means no checker completed yet.
879
last_checker_signal: The signal which killed the last checker, if
880
last_checker_status is -1
881
last_enabled: datetime.datetime(); (UTC) or None
882
name: string; from the config file, used in log messages and
884
secret: bytestring; sent verbatim (over TLS) to client
885
252
timeout: datetime.timedelta(); How long from last_checked_ok
886
253
until this client is disabled
887
extended_timeout: extra long timeout when secret has been sent
888
runtime_expansions: Allowed attributes for runtime expansion.
889
expires: datetime.datetime(); time (UTC) when a client will be
891
server_settings: The server_settings dict from main()
254
interval: datetime.timedelta(); How often to start a new checker
255
disable_hook: If set, called by disable() as disable_hook(self)
256
checker: subprocess.Popen(); a running checker process used
257
to see if the client lives.
258
'None' if no process is running.
259
checker_initiator_tag: a gobject event source tag, or None
260
disable_initiator_tag: - '' -
261
checker_callback_tag: - '' -
262
checker_command: string; External command which is run to check if
263
client lives. %() expansions are done at
264
runtime with vars(self) as dict, so that for
265
instance %(name)s can be used in the command.
266
current_checker_command: string; current running checker_command
267
approved_delay: datetime.timedelta(); Time to wait for approval
268
_approved: bool(); 'None' if not yet approved/disapproved
269
approved_duration: datetime.timedelta(); Duration of one approval
894
runtime_expansions = ("approval_delay", "approval_duration",
895
"created", "enabled", "expires", "key_id",
896
"fingerprint", "host", "interval",
897
"last_approval_request", "last_checked_ok",
898
"last_enabled", "name", "timeout")
901
"extended_timeout": "PT15M",
903
"checker": "fping -q -- %%(host)s",
905
"approval_delay": "PT0S",
906
"approval_duration": "PT1S",
907
"approved_by_default": "True",
912
def config_parser(config):
913
"""Construct a new dict of client settings of this form:
914
{ client_name: {setting_name: value, ...}, ...}
915
with exceptions for any special settings as defined above.
916
NOTE: Must be a pure function. Must return the same result
917
value given the same arguments.
920
for client_name in config.sections():
921
section = dict(config.items(client_name))
922
client = settings[client_name] = {}
924
client["host"] = section["host"]
925
# Reformat values from string types to Python types
926
client["approved_by_default"] = config.getboolean(
927
client_name, "approved_by_default")
928
client["enabled"] = config.getboolean(client_name,
931
# Uppercase and remove spaces from key_id and fingerprint
932
# for later comparison purposes with return value from the
933
# key_id() and fingerprint() functions
934
client["key_id"] = (section.get("key_id", "").upper()
936
client["fingerprint"] = (section["fingerprint"].upper()
938
if "secret" in section:
939
client["secret"] = codecs.decode(section["secret"]
942
elif "secfile" in section:
943
with open(os.path.expanduser(os.path.expandvars
944
(section["secfile"])),
946
client["secret"] = secfile.read()
948
raise TypeError("No secret or secfile for section {}"
950
client["timeout"] = string_to_delta(section["timeout"])
951
client["extended_timeout"] = string_to_delta(
952
section["extended_timeout"])
953
client["interval"] = string_to_delta(section["interval"])
954
client["approval_delay"] = string_to_delta(
955
section["approval_delay"])
956
client["approval_duration"] = string_to_delta(
957
section["approval_duration"])
958
client["checker_command"] = section["checker"]
959
client["last_approval_request"] = None
960
client["last_checked_ok"] = None
961
client["last_checker_status"] = -2
965
def __init__(self, settings, name=None, server_settings=None):
273
def _timedelta_to_milliseconds(td):
274
"Convert a datetime.timedelta() to milliseconds"
275
return ((td.days * 24 * 60 * 60 * 1000)
276
+ (td.seconds * 1000)
277
+ (td.microseconds // 1000))
279
def timeout_milliseconds(self):
280
"Return the 'timeout' attribute in milliseconds"
281
return self._timedelta_to_milliseconds(self.timeout)
283
def interval_milliseconds(self):
284
"Return the 'interval' attribute in milliseconds"
285
return self._timedelta_to_milliseconds(self.interval)
287
def approved_delay_milliseconds(self):
288
return self._timedelta_to_milliseconds(self.approved_delay)
290
def __init__(self, name = None, disable_hook=None, config=None):
291
"""Note: the 'checker' key in 'config' sets the
292
'checker_command' attribute and *not* the 'checker'
967
if server_settings is None:
969
self.server_settings = server_settings
970
# adding all client settings
971
for setting, value in settings.items():
972
setattr(self, setting, value)
975
if not hasattr(self, "last_enabled"):
976
self.last_enabled = datetime.datetime.utcnow()
977
if not hasattr(self, "expires"):
978
self.expires = (datetime.datetime.utcnow()
297
logger.debug(u"Creating client %r", self.name)
298
# Uppercase and remove spaces from fingerprint for later
299
# comparison purposes with return value from the fingerprint()
301
self.fingerprint = (config[u"fingerprint"].upper()
303
logger.debug(u" Fingerprint: %s", self.fingerprint)
304
if u"secret" in config:
305
self.secret = config[u"secret"].decode(u"base64")
306
elif u"secfile" in config:
307
with open(os.path.expanduser(os.path.expandvars
308
(config[u"secfile"])),
310
self.secret = secfile.read()
981
self.last_enabled = None
984
logger.debug("Creating client %r", self.name)
985
logger.debug(" Key ID: %s", self.key_id)
986
logger.debug(" Fingerprint: %s", self.fingerprint)
987
self.created = settings.get("created",
988
datetime.datetime.utcnow())
990
# attributes specific for this server instance
312
#XXX Need to allow secret on demand!
313
raise TypeError(u"No secret or secfile for client %s"
315
self.host = config.get(u"host", u"")
316
self.created = datetime.datetime.utcnow()
318
self.last_enabled = None
319
self.last_checked_ok = None
320
self.timeout = string_to_delta(config[u"timeout"])
321
self.interval = string_to_delta(config[u"interval"])
322
self.disable_hook = disable_hook
991
323
self.checker = None
992
324
self.checker_initiator_tag = None
993
325
self.disable_initiator_tag = None
994
326
self.checker_callback_tag = None
327
self.checker_command = config[u"checker"]
995
328
self.current_checker_command = None
997
self.approvals_pending = 0
998
self.changedstate = multiprocessing_manager.Condition(
999
multiprocessing_manager.Lock())
1000
self.client_structure = [attr
1001
for attr in self.__dict__.keys()
1002
if not attr.startswith("_")]
1003
self.client_structure.append("client_structure")
1005
for name, t in inspect.getmembers(
1006
type(self), lambda obj: isinstance(obj, property)):
1007
if not name.startswith("_"):
1008
self.client_structure.append(name)
1010
# Send notice to process children that client state has changed
329
self.last_connect = None
330
self._approved = None
331
self.approved_by_default = config.get(u"approved_by_default",
333
self.approved_delay = string_to_delta(
334
config[u"approved_delay"])
335
self.approved_duration = string_to_delta(
336
config[u"approved_duration"])
337
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
1011
339
def send_changedstate(self):
1012
with self.changedstate:
1013
self.changedstate.notify_all()
340
self.changedstate.acquire()
341
self.changedstate.notify_all()
342
self.changedstate.release()
1015
344
def enable(self):
1016
345
"""Start this client's checker and timeout hooks"""
1017
if getattr(self, "enabled", False):
346
if getattr(self, u"enabled", False):
1018
347
# Already enabled
1020
self.expires = datetime.datetime.utcnow() + self.timeout
349
self.send_changedstate()
1022
350
self.last_enabled = datetime.datetime.utcnow()
1024
self.send_changedstate()
351
# Schedule a new checker to be started an 'interval' from now,
352
# and every interval from then on.
353
self.checker_initiator_tag = (gobject.timeout_add
354
(self.interval_milliseconds(),
356
# Schedule a disable() when 'timeout' has passed
357
self.disable_initiator_tag = (gobject.timeout_add
358
(self.timeout_milliseconds(),
361
# Also start a new checker *right now*.
1026
364
def disable(self, quiet=True):
1027
365
"""Disable this client."""
1028
366
if not getattr(self, "enabled", False):
1031
logger.info("Disabling client %s", self.name)
1032
if getattr(self, "disable_initiator_tag", None) is not None:
1033
GLib.source_remove(self.disable_initiator_tag)
369
self.send_changedstate()
371
logger.info(u"Disabling client %s", self.name)
372
if getattr(self, u"disable_initiator_tag", False):
373
gobject.source_remove(self.disable_initiator_tag)
1034
374
self.disable_initiator_tag = None
1036
if getattr(self, "checker_initiator_tag", None) is not None:
1037
GLib.source_remove(self.checker_initiator_tag)
375
if getattr(self, u"checker_initiator_tag", False):
376
gobject.source_remove(self.checker_initiator_tag)
1038
377
self.checker_initiator_tag = None
1039
378
self.stop_checker()
379
if self.disable_hook:
380
self.disable_hook(self)
1040
381
self.enabled = False
1042
self.send_changedstate()
1043
# Do not run this again if called by a GLib.timeout_add
382
# Do not run this again if called by a gobject.timeout_add
1046
385
def __del__(self):
386
self.disable_hook = None
1049
def init_checker(self):
1050
# Schedule a new checker to be started an 'interval' from now,
1051
# and every interval from then on.
1052
if self.checker_initiator_tag is not None:
1053
GLib.source_remove(self.checker_initiator_tag)
1054
self.checker_initiator_tag = GLib.timeout_add(
1055
random.randrange(int(self.interval.total_seconds() * 1000
1058
# Schedule a disable() when 'timeout' has passed
1059
if self.disable_initiator_tag is not None:
1060
GLib.source_remove(self.disable_initiator_tag)
1061
self.disable_initiator_tag = GLib.timeout_add(
1062
int(self.timeout.total_seconds() * 1000), self.disable)
1063
# Also start a new checker *right now*.
1064
self.start_checker()
1066
def checker_callback(self, source, condition, connection,
389
def checker_callback(self, pid, condition, command):
1068
390
"""The checker has completed, so take appropriate actions."""
1069
# Read return code from connection (see call_pipe)
1070
returncode = connection.recv()
1072
if self.checker is not None:
1074
391
self.checker_callback_tag = None
1075
392
self.checker = None
1078
self.last_checker_status = returncode
1079
self.last_checker_signal = None
1080
if self.last_checker_status == 0:
1081
logger.info("Checker for %(name)s succeeded",
393
if os.WIFEXITED(condition):
394
exitstatus = os.WEXITSTATUS(condition)
396
logger.info(u"Checker for %(name)s succeeded",
1083
398
self.checked_ok()
1085
logger.info("Checker for %(name)s failed", vars(self))
400
logger.info(u"Checker for %(name)s failed",
1087
self.last_checker_status = -1
1088
self.last_checker_signal = -returncode
1089
logger.warning("Checker for %(name)s crashed?",
403
logger.warning(u"Checker for %(name)s crashed?",
1093
406
def checked_ok(self):
1094
"""Assert that the client has been seen, alive and well."""
407
"""Bump up the timeout for this client.
409
This should only be called when the client has been seen,
1095
412
self.last_checked_ok = datetime.datetime.utcnow()
1096
self.last_checker_status = 0
1097
self.last_checker_signal = None
1100
def bump_timeout(self, timeout=None):
1101
"""Bump up the timeout for this client."""
1103
timeout = self.timeout
1104
if self.disable_initiator_tag is not None:
1105
GLib.source_remove(self.disable_initiator_tag)
1106
self.disable_initiator_tag = None
1107
if getattr(self, "enabled", False):
1108
self.disable_initiator_tag = GLib.timeout_add(
1109
int(timeout.total_seconds() * 1000), self.disable)
1110
self.expires = datetime.datetime.utcnow() + timeout
1112
def need_approval(self):
1113
self.last_approval_request = datetime.datetime.utcnow()
413
gobject.source_remove(self.disable_initiator_tag)
414
self.disable_initiator_tag = (gobject.timeout_add
415
(self.timeout_milliseconds(),
1115
418
def start_checker(self):
1116
419
"""Start a new checker subprocess if one is not running.
1118
421
If a checker already exists, leave it running and do
1120
423
# The reason for not killing a running checker is that if we
1121
# did that, and if a checker (for some reason) started running
1122
# slowly and taking more than 'interval' time, then the client
1123
# would inevitably timeout, since no checker would get a
1124
# chance to run to completion. If we instead leave running
424
# did that, then if a checker (for some reason) started
425
# running slowly and taking more than 'interval' time, the
426
# client would inevitably timeout, since no checker would get
427
# a chance to run to completion. If we instead leave running
1125
428
# checkers alone, the checker would have to take more time
1126
429
# than 'timeout' for the client to be disabled, which is as it
1129
if self.checker is not None and not self.checker.is_alive():
1130
logger.warning("Checker was not alive; joining")
432
# If a checker exists, make sure it is not a zombie
434
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
435
except (AttributeError, OSError), error:
436
if (isinstance(error, OSError)
437
and error.errno != errno.ECHILD):
441
logger.warning(u"Checker was a zombie")
442
gobject.source_remove(self.checker_callback_tag)
443
self.checker_callback(pid, status,
444
self.current_checker_command)
1133
445
# Start a new checker if needed
1134
446
if self.checker is None:
1135
# Escape attributes for the shell
1137
attr: shlex.quote(str(getattr(self, attr)))
1138
for attr in self.runtime_expansions}
1140
command = self.checker_command % escaped_attrs
1141
except TypeError as error:
1142
logger.error('Could not format string "%s"',
1143
self.checker_command,
1145
return True # Try again later
448
# In case checker_command has exactly one % operator
449
command = self.checker_command % self.host
451
# Escape attributes for the shell
452
escaped_attrs = dict((key,
453
re.escape(unicode(str(val),
457
vars(self).iteritems())
459
command = self.checker_command % escaped_attrs
460
except TypeError, error:
461
logger.error(u'Could not format string "%s":'
462
u' %s', self.checker_command, error)
463
return True # Try again later
1146
464
self.current_checker_command = command
1147
logger.info("Starting checker %r for %s", command,
1149
# We don't need to redirect stdout and stderr, since
1150
# in normal mode, that is already done by daemon(),
1151
# and in debug mode we don't want to. (Stdin is
1152
# always replaced by /dev/null.)
1153
# The exception is when not debugging but nevertheless
1154
# running in the foreground; use the previously
1156
popen_args = {"close_fds": True,
1159
if (not self.server_settings["debug"]
1160
and self.server_settings["foreground"]):
1161
popen_args.update({"stdout": wnull,
1163
pipe = multiprocessing.Pipe(duplex=False)
1164
self.checker = multiprocessing.Process(
1166
args=(pipe[1], subprocess.call, command),
1168
self.checker.start()
1169
self.checker_callback_tag = GLib.io_add_watch(
1170
GLib.IOChannel.unix_new(pipe[0].fileno()),
1171
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1172
self.checker_callback, pipe[0], command)
1173
# Re-run this periodically if run by GLib.timeout_add
466
logger.info(u"Starting checker %r for %s",
468
# We don't need to redirect stdout and stderr, since
469
# in normal mode, that is already done by daemon(),
470
# and in debug mode we don't want to. (Stdin is
471
# always replaced by /dev/null.)
472
self.checker = subprocess.Popen(command,
474
shell=True, cwd=u"/")
475
self.checker_callback_tag = (gobject.child_watch_add
477
self.checker_callback,
479
# The checker may have completed before the gobject
480
# watch was added. Check for this.
481
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
483
gobject.source_remove(self.checker_callback_tag)
484
self.checker_callback(pid, status, command)
485
except OSError, error:
486
logger.error(u"Failed to start subprocess: %s",
488
# Re-run this periodically if run by gobject.timeout_add
1176
491
def stop_checker(self):
1177
492
"""Force the checker process, if any, to stop."""
1178
493
if self.checker_callback_tag:
1179
GLib.source_remove(self.checker_callback_tag)
494
gobject.source_remove(self.checker_callback_tag)
1180
495
self.checker_callback_tag = None
1181
if getattr(self, "checker", None) is None:
496
if getattr(self, u"checker", None) is None:
1183
logger.debug("Stopping checker for %(name)s", vars(self))
1184
self.checker.terminate()
498
logger.debug(u"Stopping checker for %(name)s", vars(self))
500
os.kill(self.checker.pid, signal.SIGTERM)
502
#if self.checker.poll() is None:
503
# os.kill(self.checker.pid, signal.SIGKILL)
504
except OSError, error:
505
if error.errno != errno.ESRCH: # No such process
1185
507
self.checker = None
1188
def dbus_service_property(dbus_interface,
509
def dbus_service_property(dbus_interface, signature=u"v",
510
access=u"readwrite", byte_arrays=False):
1192
511
"""Decorators for marking methods of a DBusObjectWithProperties to
1193
512
become properties on the D-Bus.
1195
514
The decorated method will be called with no arguments by "Get"
1196
515
and with one argument by "Set".
1198
517
The parameters, where they are supported, are the same as
1199
518
dbus.service.method, except there is only "signature", since the
1200
519
type from Get() and the type sent to Set() is the same.
1202
521
# Encoding deeply encoded byte arrays is not supported yet by the
1203
522
# "Set" method, so we fail early here:
1204
if byte_arrays and signature != "ay":
1205
raise ValueError("Byte arrays not supported for non-'ay'"
1206
" signature {!r}".format(signature))
523
if byte_arrays and signature != u"ay":
524
raise ValueError(u"Byte arrays not supported for non-'ay'"
525
u" signature %r" % signature)
1208
526
def decorator(func):
1209
527
func._dbus_is_property = True
1210
528
func._dbus_interface = dbus_interface
1211
529
func._dbus_signature = signature
1212
530
func._dbus_access = access
1213
531
func._dbus_name = func.__name__
1214
if func._dbus_name.endswith("_dbus_property"):
532
if func._dbus_name.endswith(u"_dbus_property"):
1215
533
func._dbus_name = func._dbus_name[:-14]
1216
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1222
def dbus_interface_annotations(dbus_interface):
1223
"""Decorator for marking functions returning interface annotations
1227
@dbus_interface_annotations("org.example.Interface")
1228
def _foo(self): # Function name does not matter
1229
return {"org.freedesktop.DBus.Deprecated": "true",
1230
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1234
def decorator(func):
1235
func._dbus_is_interface = True
1236
func._dbus_interface = dbus_interface
1237
func._dbus_name = dbus_interface
1243
def dbus_annotations(annotations):
1244
"""Decorator to annotate D-Bus methods, signals or properties
1247
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1248
"org.freedesktop.DBus.Property."
1249
"EmitsChangedSignal": "false"})
1250
@dbus_service_property("org.example.Interface", signature="b",
1252
def Property_dbus_property(self):
1253
return dbus.Boolean(False)
1255
See also the DBusObjectWithAnnotations class.
1258
def decorator(func):
1259
func._dbus_annotations = annotations
534
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1262
536
return decorator
1265
539
class DBusPropertyException(dbus.exceptions.DBusException):
1266
540
"""A base class for D-Bus property-related exceptions
542
def __unicode__(self):
543
return unicode(str(self))
1271
546
class DBusPropertyAccessException(DBusPropertyException):
1283
class DBusObjectWithAnnotations(dbus.service.Object):
1284
"""A D-Bus object with annotations.
1286
Classes inheriting from this can use the dbus_annotations
1287
decorator to add annotations to methods or signals.
1291
def _is_dbus_thing(thing):
1292
"""Returns a function testing if an attribute is a D-Bus thing
1294
If called like _is_dbus_thing("method") it returns a function
1295
suitable for use as predicate to inspect.getmembers().
1297
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1300
def _get_all_dbus_things(self, thing):
1301
"""Returns a generator of (name, attribute) pairs
1303
return ((getattr(athing.__get__(self), "_dbus_name", name),
1304
athing.__get__(self))
1305
for cls in self.__class__.__mro__
1307
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1309
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1311
path_keyword='object_path',
1312
connection_keyword='connection')
1313
def Introspect(self, object_path, connection):
1314
"""Overloading of standard D-Bus method.
1316
Inserts annotation tags on methods and signals.
1318
xmlstring = dbus.service.Object.Introspect(self, object_path,
1321
document = xml.dom.minidom.parseString(xmlstring)
1323
for if_tag in document.getElementsByTagName("interface"):
1324
# Add annotation tags
1325
for typ in ("method", "signal"):
1326
for tag in if_tag.getElementsByTagName(typ):
1328
for name, prop in (self.
1329
_get_all_dbus_things(typ)):
1330
if (name == tag.getAttribute("name")
1331
and prop._dbus_interface
1332
== if_tag.getAttribute("name")):
1333
annots.update(getattr(
1334
prop, "_dbus_annotations", {}))
1335
for name, value in annots.items():
1336
ann_tag = document.createElement(
1338
ann_tag.setAttribute("name", name)
1339
ann_tag.setAttribute("value", value)
1340
tag.appendChild(ann_tag)
1341
# Add interface annotation tags
1342
for annotation, value in dict(
1343
itertools.chain.from_iterable(
1344
annotations().items()
1345
for name, annotations
1346
in self._get_all_dbus_things("interface")
1347
if name == if_tag.getAttribute("name")
1349
ann_tag = document.createElement("annotation")
1350
ann_tag.setAttribute("name", annotation)
1351
ann_tag.setAttribute("value", value)
1352
if_tag.appendChild(ann_tag)
1353
# Fix argument name for the Introspect method itself
1354
if (if_tag.getAttribute("name")
1355
== dbus.INTROSPECTABLE_IFACE):
1356
for cn in if_tag.getElementsByTagName("method"):
1357
if cn.getAttribute("name") == "Introspect":
1358
for arg in cn.getElementsByTagName("arg"):
1359
if (arg.getAttribute("direction")
1361
arg.setAttribute("name",
1363
xmlstring = document.toxml("utf-8")
1365
except (AttributeError, xml.dom.DOMException,
1366
xml.parsers.expat.ExpatError) as error:
1367
logger.error("Failed to override Introspection method",
1372
class DBusObjectWithProperties(DBusObjectWithAnnotations):
558
class DBusObjectWithProperties(dbus.service.Object):
1373
559
"""A D-Bus object with properties.
1375
561
Classes inheriting from this can use the dbus_service_property
1376
562
decorator to expose methods as D-Bus properties. It exposes the
1377
563
standard Get(), Set(), and GetAll() methods on the D-Bus.
567
def _is_dbus_property(obj):
568
return getattr(obj, u"_dbus_is_property", False)
570
def _get_all_dbus_properties(self):
571
"""Returns a generator of (name, attribute) pairs
573
return ((prop._dbus_name, prop)
575
inspect.getmembers(self, self._is_dbus_property))
1380
577
def _get_dbus_property(self, interface_name, property_name):
1381
578
"""Returns a bound method if one exists which is a D-Bus
1382
579
property with the specified name and interface.
1384
for cls in self.__class__.__mro__:
1385
for name, value in inspect.getmembers(
1386
cls, self._is_dbus_thing("property")):
1387
if (value._dbus_name == property_name
1388
and value._dbus_interface == interface_name):
1389
return value.__get__(self)
581
for name in (property_name,
582
property_name + u"_dbus_property"):
583
prop = getattr(self, name, None)
585
or not self._is_dbus_property(prop)
586
or prop._dbus_name != property_name
587
or (interface_name and prop._dbus_interface
588
and interface_name != prop._dbus_interface)):
1391
591
# No such property
1392
raise DBusPropertyNotFound("{}:{}.{}".format(
1393
self.dbus_object_path, interface_name, property_name))
1396
def _get_all_interface_names(cls):
1397
"""Get a sequence of all interfaces supported by an object"""
1398
return (name for name in set(getattr(getattr(x, attr),
1399
"_dbus_interface", None)
1400
for x in (inspect.getmro(cls))
1402
if name is not None)
1404
@dbus.service.method(dbus.PROPERTIES_IFACE,
592
raise DBusPropertyNotFound(self.dbus_object_path + u":"
593
+ interface_name + u"."
596
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1407
598
def Get(self, interface_name, property_name):
1408
599
"""Standard D-Bus property Get() method, see D-Bus standard.
1410
601
prop = self._get_dbus_property(interface_name, property_name)
1411
if prop._dbus_access == "write":
602
if prop._dbus_access == u"write":
1412
603
raise DBusPropertyAccessException(property_name)
1414
if not hasattr(value, "variant_level"):
605
if not hasattr(value, u"variant_level"):
1416
607
return type(value)(value, variant_level=value.variant_level+1)
1418
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
609
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1419
610
def Set(self, interface_name, property_name, value):
1420
611
"""Standard D-Bus property Set() method, see D-Bus standard.
1422
613
prop = self._get_dbus_property(interface_name, property_name)
1423
if prop._dbus_access == "read":
614
if prop._dbus_access == u"read":
1424
615
raise DBusPropertyAccessException(property_name)
1425
if prop._dbus_get_args_options["byte_arrays"]:
616
if prop._dbus_get_args_options[u"byte_arrays"]:
1426
617
# The byte_arrays option is not supported yet on
1427
618
# signatures other than "ay".
1428
if prop._dbus_signature != "ay":
1429
raise ValueError("Byte arrays not supported for non-"
1430
"'ay' signature {!r}"
1431
.format(prop._dbus_signature))
1432
value = dbus.ByteArray(bytes(value))
619
if prop._dbus_signature != u"ay":
621
value = dbus.ByteArray(''.join(unichr(byte)
1435
@dbus.service.method(dbus.PROPERTIES_IFACE,
1437
out_signature="a{sv}")
625
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
626
out_signature=u"a{sv}")
1438
627
def GetAll(self, interface_name):
1439
628
"""Standard D-Bus property GetAll() method, see D-Bus
1442
631
Note: Will not include properties with access="write".
1445
for name, prop in self._get_all_dbus_things("property"):
634
for name, prop in self._get_all_dbus_properties():
1446
635
if (interface_name
1447
636
and interface_name != prop._dbus_interface):
1448
637
# Interface non-empty but did not match
1450
639
# Ignore write-only properties
1451
if prop._dbus_access == "write":
640
if prop._dbus_access == u"write":
1454
if not hasattr(value, "variant_level"):
1455
properties[name] = value
643
if not hasattr(value, u"variant_level"):
1457
properties[name] = type(value)(
1458
value, variant_level=value.variant_level + 1)
1459
return dbus.Dictionary(properties, signature="sv")
1461
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1462
def PropertiesChanged(self, interface_name, changed_properties,
1463
invalidated_properties):
1464
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
646
all[name] = type(value)(value, variant_level=
647
value.variant_level+1)
648
return dbus.Dictionary(all, signature=u"sv")
1469
650
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1471
652
path_keyword='object_path',
1472
653
connection_keyword='connection')
1473
654
def Introspect(self, object_path, connection):
1474
"""Overloading of standard D-Bus method.
1476
Inserts property tags and interface annotation tags.
655
"""Standard D-Bus method, overloaded to insert property tags.
1478
xmlstring = DBusObjectWithAnnotations.Introspect(self,
657
xmlstring = dbus.service.Object.Introspect(self, object_path,
1482
660
document = xml.dom.minidom.parseString(xmlstring)
1484
661
def make_tag(document, name, prop):
1485
e = document.createElement("property")
1486
e.setAttribute("name", name)
1487
e.setAttribute("type", prop._dbus_signature)
1488
e.setAttribute("access", prop._dbus_access)
662
e = document.createElement(u"property")
663
e.setAttribute(u"name", name)
664
e.setAttribute(u"type", prop._dbus_signature)
665
e.setAttribute(u"access", prop._dbus_access)
1491
for if_tag in document.getElementsByTagName("interface"):
667
for if_tag in document.getElementsByTagName(u"interface"):
1493
668
for tag in (make_tag(document, name, prop)
1495
in self._get_all_dbus_things("property")
670
in self._get_all_dbus_properties()
1496
671
if prop._dbus_interface
1497
== if_tag.getAttribute("name")):
672
== if_tag.getAttribute(u"name")):
1498
673
if_tag.appendChild(tag)
1499
# Add annotation tags for properties
1500
for tag in if_tag.getElementsByTagName("property"):
1502
for name, prop in self._get_all_dbus_things(
1504
if (name == tag.getAttribute("name")
1505
and prop._dbus_interface
1506
== if_tag.getAttribute("name")):
1507
annots.update(getattr(
1508
prop, "_dbus_annotations", {}))
1509
for name, value in annots.items():
1510
ann_tag = document.createElement(
1512
ann_tag.setAttribute("name", name)
1513
ann_tag.setAttribute("value", value)
1514
tag.appendChild(ann_tag)
1515
674
# Add the names to the return values for the
1516
675
# "org.freedesktop.DBus.Properties" methods
1517
if (if_tag.getAttribute("name")
1518
== "org.freedesktop.DBus.Properties"):
1519
for cn in if_tag.getElementsByTagName("method"):
1520
if cn.getAttribute("name") == "Get":
1521
for arg in cn.getElementsByTagName("arg"):
1522
if (arg.getAttribute("direction")
1524
arg.setAttribute("name", "value")
1525
elif cn.getAttribute("name") == "GetAll":
1526
for arg in cn.getElementsByTagName("arg"):
1527
if (arg.getAttribute("direction")
1529
arg.setAttribute("name", "props")
1530
xmlstring = document.toxml("utf-8")
1532
except (AttributeError, xml.dom.DOMException,
1533
xml.parsers.expat.ExpatError) as error:
1534
logger.error("Failed to override Introspection method",
1540
dbus.OBJECT_MANAGER_IFACE
1541
except AttributeError:
1542
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1545
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1546
"""A D-Bus object with an ObjectManager.
1548
Classes inheriting from this exposes the standard
1549
GetManagedObjects call and the InterfacesAdded and
1550
InterfacesRemoved signals on the standard
1551
"org.freedesktop.DBus.ObjectManager" interface.
1553
Note: No signals are sent automatically; they must be sent
1556
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1557
out_signature="a{oa{sa{sv}}}")
1558
def GetManagedObjects(self):
1559
"""This function must be overridden"""
1560
raise NotImplementedError()
1562
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1563
signature="oa{sa{sv}}")
1564
def InterfacesAdded(self, object_path, interfaces_and_properties):
1567
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1568
def InterfacesRemoved(self, object_path, interfaces):
1571
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1573
path_keyword='object_path',
1574
connection_keyword='connection')
1575
def Introspect(self, object_path, connection):
1576
"""Overloading of standard D-Bus method.
1578
Override return argument name of GetManagedObjects to be
1579
"objpath_interfaces_and_properties"
1581
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1585
document = xml.dom.minidom.parseString(xmlstring)
1587
for if_tag in document.getElementsByTagName("interface"):
1588
# Fix argument name for the GetManagedObjects method
1589
if (if_tag.getAttribute("name")
1590
== dbus.OBJECT_MANAGER_IFACE):
1591
for cn in if_tag.getElementsByTagName("method"):
1592
if (cn.getAttribute("name")
1593
== "GetManagedObjects"):
1594
for arg in cn.getElementsByTagName("arg"):
1595
if (arg.getAttribute("direction")
1599
"objpath_interfaces"
1601
xmlstring = document.toxml("utf-8")
1603
except (AttributeError, xml.dom.DOMException,
1604
xml.parsers.expat.ExpatError) as error:
1605
logger.error("Failed to override Introspection method",
1610
def datetime_to_dbus(dt, variant_level=0):
1611
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1613
return dbus.String("", variant_level=variant_level)
1614
return dbus.String(dt.isoformat(), variant_level=variant_level)
1617
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1618
"""A class decorator; applied to a subclass of
1619
dbus.service.Object, it will add alternate D-Bus attributes with
1620
interface names according to the "alt_interface_names" mapping.
1623
@alternate_dbus_interfaces({"org.example.Interface":
1624
"net.example.AlternateInterface"})
1625
class SampleDBusObject(dbus.service.Object):
1626
@dbus.service.method("org.example.Interface")
1627
def SampleDBusMethod():
1630
The above "SampleDBusMethod" on "SampleDBusObject" will be
1631
reachable via two interfaces: "org.example.Interface" and
1632
"net.example.AlternateInterface", the latter of which will have
1633
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1634
"true", unless "deprecate" is passed with a False value.
1636
This works for methods and signals, and also for D-Bus properties
1637
(from DBusObjectWithProperties) and interfaces (from the
1638
dbus_interface_annotations decorator).
1642
for orig_interface_name, alt_interface_name in (
1643
alt_interface_names.items()):
1645
interface_names = set()
1646
# Go though all attributes of the class
1647
for attrname, attribute in inspect.getmembers(cls):
1648
# Ignore non-D-Bus attributes, and D-Bus attributes
1649
# with the wrong interface name
1650
if (not hasattr(attribute, "_dbus_interface")
1651
or not attribute._dbus_interface.startswith(
1652
orig_interface_name)):
1654
# Create an alternate D-Bus interface name based on
1656
alt_interface = attribute._dbus_interface.replace(
1657
orig_interface_name, alt_interface_name)
1658
interface_names.add(alt_interface)
1659
# Is this a D-Bus signal?
1660
if getattr(attribute, "_dbus_is_signal", False):
1661
# Extract the original non-method undecorated
1662
# function by black magic
1663
if sys.version_info.major == 2:
1664
nonmethod_func = (dict(
1665
zip(attribute.func_code.co_freevars,
1666
attribute.__closure__))
1667
["func"].cell_contents)
1669
nonmethod_func = (dict(
1670
zip(attribute.__code__.co_freevars,
1671
attribute.__closure__))
1672
["func"].cell_contents)
1673
# Create a new, but exactly alike, function
1674
# object, and decorate it to be a new D-Bus signal
1675
# with the alternate D-Bus interface name
1676
new_function = copy_function(nonmethod_func)
1677
new_function = (dbus.service.signal(
1679
attribute._dbus_signature)(new_function))
1680
# Copy annotations, if any
1682
new_function._dbus_annotations = dict(
1683
attribute._dbus_annotations)
1684
except AttributeError:
1687
# Define a creator of a function to call both the
1688
# original and alternate functions, so both the
1689
# original and alternate signals gets sent when
1690
# the function is called
1691
def fixscope(func1, func2):
1692
"""This function is a scope container to pass
1693
func1 and func2 to the "call_both" function
1694
outside of its arguments"""
1696
@functools.wraps(func2)
1697
def call_both(*args, **kwargs):
1698
"""This function will emit two D-Bus
1699
signals by calling func1 and func2"""
1700
func1(*args, **kwargs)
1701
func2(*args, **kwargs)
1702
# Make wrapper function look like a D-Bus
1704
for name, attr in inspect.getmembers(func2):
1705
if name.startswith("_dbus_"):
1706
setattr(call_both, name, attr)
1709
# Create the "call_both" function and add it to
1711
attr[attrname] = fixscope(attribute, new_function)
1712
# Is this a D-Bus method?
1713
elif getattr(attribute, "_dbus_is_method", False):
1714
# Create a new, but exactly alike, function
1715
# object. Decorate it to be a new D-Bus method
1716
# with the alternate D-Bus interface name. Add it
1719
dbus.service.method(
1721
attribute._dbus_in_signature,
1722
attribute._dbus_out_signature)
1723
(copy_function(attribute)))
1724
# Copy annotations, if any
1726
attr[attrname]._dbus_annotations = dict(
1727
attribute._dbus_annotations)
1728
except AttributeError:
1730
# Is this a D-Bus property?
1731
elif getattr(attribute, "_dbus_is_property", False):
1732
# Create a new, but exactly alike, function
1733
# object, and decorate it to be a new D-Bus
1734
# property with the alternate D-Bus interface
1735
# name. Add it to the class.
1736
attr[attrname] = (dbus_service_property(
1737
alt_interface, attribute._dbus_signature,
1738
attribute._dbus_access,
1739
attribute._dbus_get_args_options
1741
(copy_function(attribute)))
1742
# Copy annotations, if any
1744
attr[attrname]._dbus_annotations = dict(
1745
attribute._dbus_annotations)
1746
except AttributeError:
1748
# Is this a D-Bus interface?
1749
elif getattr(attribute, "_dbus_is_interface", False):
1750
# Create a new, but exactly alike, function
1751
# object. Decorate it to be a new D-Bus interface
1752
# with the alternate D-Bus interface name. Add it
1755
dbus_interface_annotations(alt_interface)
1756
(copy_function(attribute)))
1758
# Deprecate all alternate interfaces
1759
iname = "_AlternateDBusNames_interface_annotation{}"
1760
for interface_name in interface_names:
1762
@dbus_interface_annotations(interface_name)
1764
return {"org.freedesktop.DBus.Deprecated":
1766
# Find an unused name
1767
for aname in (iname.format(i)
1768
for i in itertools.count()):
1769
if aname not in attr:
1773
# Replace the class with a new subclass of it with
1774
# methods, signals, etc. as created above.
1775
if sys.version_info.major == 2:
1776
cls = type(b"{}Alternate".format(cls.__name__),
1779
cls = type("{}Alternate".format(cls.__name__),
1786
@alternate_dbus_interfaces({"se.recompile.Mandos":
1787
"se.bsnet.fukt.Mandos"})
676
if (if_tag.getAttribute(u"name")
677
== u"org.freedesktop.DBus.Properties"):
678
for cn in if_tag.getElementsByTagName(u"method"):
679
if cn.getAttribute(u"name") == u"Get":
680
for arg in cn.getElementsByTagName(u"arg"):
681
if (arg.getAttribute(u"direction")
683
arg.setAttribute(u"name", u"value")
684
elif cn.getAttribute(u"name") == u"GetAll":
685
for arg in cn.getElementsByTagName(u"arg"):
686
if (arg.getAttribute(u"direction")
688
arg.setAttribute(u"name", u"props")
689
xmlstring = document.toxml(u"utf-8")
691
except (AttributeError, xml.dom.DOMException,
692
xml.parsers.expat.ExpatError), error:
693
logger.error(u"Failed to override Introspection method",
1788
698
class ClientDBus(Client, DBusObjectWithProperties):
1789
699
"""A Client class using D-Bus
1792
702
dbus_object_path: dbus.ObjectPath
1793
703
bus: dbus.SystemBus()
1796
runtime_expansions = (Client.runtime_expansions
1797
+ ("dbus_object_path", ))
1799
_interface = "se.recompile.Mandos.Client"
1801
705
# dbus.service.Object doesn't use super(), so we can't either.
1803
def __init__(self, bus=None, *args, **kwargs):
707
def __init__(self, bus = None, *args, **kwargs):
1805
709
Client.__init__(self, *args, **kwargs)
1806
710
# Only now, when this client is initialized, can it show up on
1808
client_object_name = str(self.name).translate(
1809
{ord("."): ord("_"),
1810
ord("-"): ord("_")})
1811
self.dbus_object_path = dbus.ObjectPath(
1812
"/clients/" + client_object_name)
712
self.dbus_object_path = (dbus.ObjectPath
714
+ self.name.replace(u".", u"_")))
1813
715
DBusObjectWithProperties.__init__(self, self.bus,
1814
716
self.dbus_object_path)
1816
def notifychangeproperty(transform_func, dbus_name,
1817
type_func=lambda x: x,
1819
invalidate_only=False,
1820
_interface=_interface):
1821
""" Modify a variable so that it's a property which announces
1822
its changes to DBus.
1824
transform_fun: Function that takes a value and a variant_level
1825
and transforms it to a D-Bus type.
1826
dbus_name: D-Bus name of the variable
1827
type_func: Function that transform the value before sending it
1828
to the D-Bus. Default: no transform
1829
variant_level: D-Bus variant level. Default: 1
1831
attrname = "_{}".format(dbus_name)
1833
def setter(self, value):
1834
if hasattr(self, "dbus_object_path"):
1835
if (not hasattr(self, attrname) or
1836
type_func(getattr(self, attrname, None))
1837
!= type_func(value)):
1839
self.PropertiesChanged(
1840
_interface, dbus.Dictionary(),
1841
dbus.Array((dbus_name, )))
1843
dbus_value = transform_func(
1845
variant_level=variant_level)
1846
self.PropertyChanged(dbus.String(dbus_name),
1848
self.PropertiesChanged(
1850
dbus.Dictionary({dbus.String(dbus_name):
1853
setattr(self, attrname, value)
1855
return property(lambda self: getattr(self, attrname), setter)
1857
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1858
approvals_pending = notifychangeproperty(dbus.Boolean,
1861
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1862
last_enabled = notifychangeproperty(datetime_to_dbus,
1864
checker = notifychangeproperty(
1865
dbus.Boolean, "CheckerRunning",
1866
type_func=lambda checker: checker is not None)
1867
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1869
last_checker_status = notifychangeproperty(dbus.Int16,
1870
"LastCheckerStatus")
1871
last_approval_request = notifychangeproperty(
1872
datetime_to_dbus, "LastApprovalRequest")
1873
approved_by_default = notifychangeproperty(dbus.Boolean,
1874
"ApprovedByDefault")
1875
approval_delay = notifychangeproperty(
1876
dbus.UInt64, "ApprovalDelay",
1877
type_func=lambda td: td.total_seconds() * 1000)
1878
approval_duration = notifychangeproperty(
1879
dbus.UInt64, "ApprovalDuration",
1880
type_func=lambda td: td.total_seconds() * 1000)
1881
host = notifychangeproperty(dbus.String, "Host")
1882
timeout = notifychangeproperty(
1883
dbus.UInt64, "Timeout",
1884
type_func=lambda td: td.total_seconds() * 1000)
1885
extended_timeout = notifychangeproperty(
1886
dbus.UInt64, "ExtendedTimeout",
1887
type_func=lambda td: td.total_seconds() * 1000)
1888
interval = notifychangeproperty(
1889
dbus.UInt64, "Interval",
1890
type_func=lambda td: td.total_seconds() * 1000)
1891
checker_command = notifychangeproperty(dbus.String, "Checker")
1892
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1893
invalidate_only=True)
1895
del notifychangeproperty
719
def _datetime_to_dbus(dt, variant_level=0):
720
"""Convert a UTC datetime.datetime() to a D-Bus type."""
721
return dbus.String(dt.isoformat(),
722
variant_level=variant_level)
725
oldstate = getattr(self, u"enabled", False)
726
r = Client.enable(self)
727
if oldstate != self.enabled:
729
self.PropertyChanged(dbus.String(u"enabled"),
730
dbus.Boolean(True, variant_level=1))
731
self.PropertyChanged(
732
dbus.String(u"last_enabled"),
733
self._datetime_to_dbus(self.last_enabled,
737
def disable(self, quiet = False):
738
oldstate = getattr(self, u"enabled", False)
739
r = Client.disable(self, quiet=quiet)
740
if not quiet and oldstate != self.enabled:
742
self.PropertyChanged(dbus.String(u"enabled"),
743
dbus.Boolean(False, variant_level=1))
1897
746
def __del__(self, *args, **kwargs):
1899
748
self.remove_from_connection()
1900
749
except LookupError:
1902
if hasattr(DBusObjectWithProperties, "__del__"):
751
if hasattr(DBusObjectWithProperties, u"__del__"):
1903
752
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1904
753
Client.__del__(self, *args, **kwargs)
1906
def checker_callback(self, source, condition,
1907
connection, command, *args, **kwargs):
1908
ret = Client.checker_callback(self, source, condition,
1909
connection, command, *args,
1911
exitstatus = self.last_checker_status
755
def checker_callback(self, pid, condition, command,
757
self.checker_callback_tag = None
760
self.PropertyChanged(dbus.String(u"checker_running"),
761
dbus.Boolean(False, variant_level=1))
762
if os.WIFEXITED(condition):
763
exitstatus = os.WEXITSTATUS(condition)
1913
764
# Emit D-Bus signal
1914
765
self.CheckerCompleted(dbus.Int16(exitstatus),
1915
# This is specific to GNU libC
1916
dbus.Int64(exitstatus << 8),
766
dbus.Int64(condition),
1917
767
dbus.String(command))
1919
769
# Emit D-Bus signal
1920
770
self.CheckerCompleted(dbus.Int16(-1),
1922
# This is specific to GNU libC
1924
| self.last_checker_signal),
771
dbus.Int64(condition),
1925
772
dbus.String(command))
774
return Client.checker_callback(self, pid, condition, command,
777
def checked_ok(self, *args, **kwargs):
778
r = Client.checked_ok(self, *args, **kwargs)
780
self.PropertyChanged(
781
dbus.String(u"last_checked_ok"),
782
(self._datetime_to_dbus(self.last_checked_ok,
1928
786
def start_checker(self, *args, **kwargs):
1929
old_checker_pid = getattr(self.checker, "pid", None)
787
old_checker = self.checker
788
if self.checker is not None:
789
old_checker_pid = self.checker.pid
791
old_checker_pid = None
1930
792
r = Client.start_checker(self, *args, **kwargs)
1931
793
# Only if new checker process was started
1932
794
if (self.checker is not None
1933
795
and old_checker_pid != self.checker.pid):
1934
796
# Emit D-Bus signal
1935
797
self.CheckerStarted(self.current_checker_command)
798
self.PropertyChanged(
799
dbus.String(u"checker_running"),
800
dbus.Boolean(True, variant_level=1))
803
def stop_checker(self, *args, **kwargs):
804
old_checker = getattr(self, u"checker", None)
805
r = Client.stop_checker(self, *args, **kwargs)
806
if (old_checker is not None
807
and getattr(self, u"checker", None) is None):
808
self.PropertyChanged(dbus.String(u"checker_running"),
809
dbus.Boolean(False, variant_level=1))
1938
812
def _reset_approved(self):
1939
self.approved = None
813
self._approved = None
1942
816
def approve(self, value=True):
1943
self.approved = value
1944
GLib.timeout_add(int(self.approval_duration.total_seconds()
1945
* 1000), self._reset_approved)
1946
self.send_changedstate()
1948
# D-Bus methods, signals & properties
817
self._approved = value
818
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration, self._reset_approved))
820
## D-Bus methods, signals & properties
821
_interface = u"se.bsnet.fukt.Mandos.Client"
1954
825
# CheckerCompleted - signal
1955
@dbus.service.signal(_interface, signature="nxs")
826
@dbus.service.signal(_interface, signature=u"nxs")
1956
827
def CheckerCompleted(self, exitcode, waitstatus, command):
1960
831
# CheckerStarted - signal
1961
@dbus.service.signal(_interface, signature="s")
832
@dbus.service.signal(_interface, signature=u"s")
1962
833
def CheckerStarted(self, command):
1966
837
# PropertyChanged - signal
1967
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1968
@dbus.service.signal(_interface, signature="sv")
838
@dbus.service.signal(_interface, signature=u"sv")
1969
839
def PropertyChanged(self, property, value):
1973
843
# GotSecret - signal
1974
844
@dbus.service.signal(_interface)
1975
845
def GotSecret(self):
1977
Is sent after a successful transfer of secret from the Mandos
1978
server to mandos-client
1982
849
# Rejected - signal
1983
@dbus.service.signal(_interface, signature="s")
850
@dbus.service.signal(_interface, signature=u"s")
1984
851
def Rejected(self, reason):
1988
855
# NeedApproval - signal
1989
@dbus.service.signal(_interface, signature="tb")
856
@dbus.service.signal(_interface, signature=u"db")
1990
857
def NeedApproval(self, timeout, default):
1992
return self.need_approval()
1996
863
# Approve - method
1997
@dbus.service.method(_interface, in_signature="b")
864
@dbus.service.method(_interface, in_signature=u"b")
1998
865
def Approve(self, value):
1999
866
self.approve(value)
2001
868
# CheckedOK - method
2002
869
@dbus.service.method(_interface)
2003
870
def CheckedOK(self):
871
return self.checked_ok()
2006
873
# Enable - method
2007
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2008
874
@dbus.service.method(_interface)
2009
875
def Enable(self):
2013
879
# StartChecker - method
2014
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2015
880
@dbus.service.method(_interface)
2016
881
def StartChecker(self):
2018
883
self.start_checker()
2020
885
# Disable - method
2021
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2022
886
@dbus.service.method(_interface)
2023
887
def Disable(self):
2027
891
# StopChecker - method
2028
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2029
892
@dbus.service.method(_interface)
2030
893
def StopChecker(self):
2031
894
self.stop_checker()
2035
# ApprovalPending - property
2036
@dbus_service_property(_interface, signature="b", access="read")
2037
def ApprovalPending_dbus_property(self):
2038
return dbus.Boolean(bool(self.approvals_pending))
2040
# ApprovedByDefault - property
2041
@dbus_service_property(_interface,
2044
def ApprovedByDefault_dbus_property(self, value=None):
2045
if value is None: # get
2046
return dbus.Boolean(self.approved_by_default)
2047
self.approved_by_default = bool(value)
2049
# ApprovalDelay - property
2050
@dbus_service_property(_interface,
2053
def ApprovalDelay_dbus_property(self, value=None):
2054
if value is None: # get
2055
return dbus.UInt64(self.approval_delay.total_seconds()
2057
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2059
# ApprovalDuration - property
2060
@dbus_service_property(_interface,
2063
def ApprovalDuration_dbus_property(self, value=None):
2064
if value is None: # get
2065
return dbus.UInt64(self.approval_duration.total_seconds()
2067
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2071
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2072
@dbus_service_property(_interface, signature="s", access="read")
2073
def Name_dbus_property(self):
898
# xxx 3 new properties
901
@dbus_service_property(_interface, signature=u"s", access=u"read")
902
def name_dbus_property(self):
2074
903
return dbus.String(self.name)
2078
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2079
@dbus_service_property(_interface, signature="s", access="read")
2080
def KeyID_dbus_property(self):
2081
return dbus.String(self.key_id)
2083
# Fingerprint - property
2085
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2086
@dbus_service_property(_interface, signature="s", access="read")
2087
def Fingerprint_dbus_property(self):
905
# fingerprint - property
906
@dbus_service_property(_interface, signature=u"s", access=u"read")
907
def fingerprint_dbus_property(self):
2088
908
return dbus.String(self.fingerprint)
2091
@dbus_service_property(_interface,
2094
def Host_dbus_property(self, value=None):
911
@dbus_service_property(_interface, signature=u"s",
913
def host_dbus_property(self, value=None):
2095
914
if value is None: # get
2096
915
return dbus.String(self.host)
2097
self.host = str(value)
2099
# Created - property
2101
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2102
@dbus_service_property(_interface, signature="s", access="read")
2103
def Created_dbus_property(self):
2104
return datetime_to_dbus(self.created)
2106
# LastEnabled - property
2107
@dbus_service_property(_interface, signature="s", access="read")
2108
def LastEnabled_dbus_property(self):
2109
return datetime_to_dbus(self.last_enabled)
2111
# Enabled - property
2112
@dbus_service_property(_interface,
2115
def Enabled_dbus_property(self, value=None):
918
self.PropertyChanged(dbus.String(u"host"),
919
dbus.String(value, variant_level=1))
922
@dbus_service_property(_interface, signature=u"s", access=u"read")
923
def created_dbus_property(self):
924
return dbus.String(self._datetime_to_dbus(self.created))
926
# last_enabled - property
927
@dbus_service_property(_interface, signature=u"s", access=u"read")
928
def last_enabled_dbus_property(self):
929
if self.last_enabled is None:
930
return dbus.String(u"")
931
return dbus.String(self._datetime_to_dbus(self.last_enabled))
934
@dbus_service_property(_interface, signature=u"b",
936
def enabled_dbus_property(self, value=None):
2116
937
if value is None: # get
2117
938
return dbus.Boolean(self.enabled)
2123
# LastCheckedOK - property
2124
@dbus_service_property(_interface,
2127
def LastCheckedOK_dbus_property(self, value=None):
944
# last_checked_ok - property
945
@dbus_service_property(_interface, signature=u"s",
947
def last_checked_ok_dbus_property(self, value=None):
2128
948
if value is not None:
2129
949
self.checked_ok()
2131
return datetime_to_dbus(self.last_checked_ok)
2133
# LastCheckerStatus - property
2134
@dbus_service_property(_interface, signature="n", access="read")
2135
def LastCheckerStatus_dbus_property(self):
2136
return dbus.Int16(self.last_checker_status)
2138
# Expires - property
2139
@dbus_service_property(_interface, signature="s", access="read")
2140
def Expires_dbus_property(self):
2141
return datetime_to_dbus(self.expires)
2143
# LastApprovalRequest - property
2144
@dbus_service_property(_interface, signature="s", access="read")
2145
def LastApprovalRequest_dbus_property(self):
2146
return datetime_to_dbus(self.last_approval_request)
2148
# Timeout - property
2149
@dbus_service_property(_interface,
2152
def Timeout_dbus_property(self, value=None):
951
if self.last_checked_ok is None:
952
return dbus.String(u"")
953
return dbus.String(self._datetime_to_dbus(self
957
@dbus_service_property(_interface, signature=u"t",
959
def timeout_dbus_property(self, value=None):
2153
960
if value is None: # get
2154
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2155
old_timeout = self.timeout
961
return dbus.UInt64(self.timeout_milliseconds())
2156
962
self.timeout = datetime.timedelta(0, 0, 0, value)
2157
# Reschedule disabling
2159
now = datetime.datetime.utcnow()
2160
self.expires += self.timeout - old_timeout
2161
if self.expires <= now:
2162
# The timeout has passed
2165
if (getattr(self, "disable_initiator_tag", None)
2168
GLib.source_remove(self.disable_initiator_tag)
2169
self.disable_initiator_tag = GLib.timeout_add(
2170
int((self.expires - now).total_seconds() * 1000),
2173
# ExtendedTimeout - property
2174
@dbus_service_property(_interface,
2177
def ExtendedTimeout_dbus_property(self, value=None):
2178
if value is None: # get
2179
return dbus.UInt64(self.extended_timeout.total_seconds()
2181
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2183
# Interval - property
2184
@dbus_service_property(_interface,
2187
def Interval_dbus_property(self, value=None):
2188
if value is None: # get
2189
return dbus.UInt64(self.interval.total_seconds() * 1000)
964
self.PropertyChanged(dbus.String(u"timeout"),
965
dbus.UInt64(value, variant_level=1))
966
if getattr(self, u"disable_initiator_tag", None) is None:
969
gobject.source_remove(self.disable_initiator_tag)
970
self.disable_initiator_tag = None
972
_timedelta_to_milliseconds((self
978
# The timeout has passed
981
self.disable_initiator_tag = (gobject.timeout_add
982
(time_to_die, self.disable))
984
# interval - property
985
@dbus_service_property(_interface, signature=u"t",
987
def interval_dbus_property(self, value=None):
988
if value is None: # get
989
return dbus.UInt64(self.interval_milliseconds())
2190
990
self.interval = datetime.timedelta(0, 0, 0, value)
2191
if getattr(self, "checker_initiator_tag", None) is None:
992
self.PropertyChanged(dbus.String(u"interval"),
993
dbus.UInt64(value, variant_level=1))
994
if getattr(self, u"checker_initiator_tag", None) is None:
2194
# Reschedule checker run
2195
GLib.source_remove(self.checker_initiator_tag)
2196
self.checker_initiator_tag = GLib.timeout_add(
2197
value, self.start_checker)
2198
self.start_checker() # Start one now, too
996
# Reschedule checker run
997
gobject.source_remove(self.checker_initiator_tag)
998
self.checker_initiator_tag = (gobject.timeout_add
999
(value, self.start_checker))
1000
self.start_checker() # Start one now, too
2200
# Checker - property
2201
@dbus_service_property(_interface,
2204
def Checker_dbus_property(self, value=None):
1002
# checker - property
1003
@dbus_service_property(_interface, signature=u"s",
1004
access=u"readwrite")
1005
def checker_dbus_property(self, value=None):
2205
1006
if value is None: # get
2206
1007
return dbus.String(self.checker_command)
2207
self.checker_command = str(value)
2209
# CheckerRunning - property
2210
@dbus_service_property(_interface,
2213
def CheckerRunning_dbus_property(self, value=None):
1008
self.checker_command = value
1010
self.PropertyChanged(dbus.String(u"checker"),
1011
dbus.String(self.checker_command,
1014
# checker_running - property
1015
@dbus_service_property(_interface, signature=u"b",
1016
access=u"readwrite")
1017
def checker_running_dbus_property(self, value=None):
2214
1018
if value is None: # get
2215
1019
return dbus.Boolean(self.checker is not None)
2217
1021
self.start_checker()
2219
1023
self.stop_checker()
2221
# ObjectPath - property
2223
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2224
"org.freedesktop.DBus.Deprecated": "true"})
2225
@dbus_service_property(_interface, signature="o", access="read")
2226
def ObjectPath_dbus_property(self):
2227
return self.dbus_object_path # is already a dbus.ObjectPath
2231
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2233
@dbus_service_property(_interface,
2237
def Secret_dbus_property(self, value):
2238
self.secret = bytes(value)
1025
# object_path - property
1026
@dbus_service_property(_interface, signature=u"o", access=u"read")
1027
def object_path_dbus_property(self):
1028
return self.dbus_object_path # is already a dbus.ObjectPath
1031
@dbus_service_property(_interface, signature=u"ay",
1032
access=u"write", byte_arrays=True)
1033
def secret_dbus_property(self, value):
1034
self.secret = str(value)
2244
def __init__(self, child_pipe, key_id, fpr, address):
1039
class ProxyClient(object):
1040
def __init__(self, child_pipe, fpr, address):
2245
1041
self._pipe = child_pipe
2246
self._pipe.send(('init', key_id, fpr, address))
1042
self._pipe.send(('init', fpr, address))
2247
1043
if not self._pipe.recv():
2248
raise KeyError(key_id or fpr)
2250
1046
def __getattribute__(self, name):
1047
if(name == '_pipe'):
2252
1048
return super(ProxyClient, self).__getattribute__(name)
2253
1049
self._pipe.send(('getattr', name))
2254
1050
data = self._pipe.recv()
2255
1051
if data[0] == 'data':
2257
1053
if data[0] == 'function':
2259
1054
def func(*args, **kwargs):
2260
1055
self._pipe.send(('funcall', name, args, kwargs))
2261
1056
return self._pipe.recv()[1]
2265
1059
def __setattr__(self, name, value):
1060
if(name == '_pipe'):
2267
1061
return super(ProxyClient, self).__setattr__(name, value)
2268
1062
self._pipe.send(('setattr', name, value))
2271
1065
class ClientHandler(socketserver.BaseRequestHandler, object):
2272
1066
"""A class to handle client connections.
2274
1068
Instantiated once for each connection to handle it.
2275
1069
Note: This will run in its own forked process."""
2277
1071
def handle(self):
2278
1072
with contextlib.closing(self.server.child_pipe) as child_pipe:
2279
logger.info("TCP connection from: %s",
2280
str(self.client_address))
2281
logger.debug("Pipe FD: %d",
1073
logger.info(u"TCP connection from: %s",
1074
unicode(self.client_address))
1075
logger.debug(u"Pipe FD: %d",
2282
1076
self.server.child_pipe.fileno())
2284
session = gnutls.ClientSession(self.request)
2286
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2287
# "+AES-256-CBC", "+SHA1",
2288
# "+COMP-NULL", "+CTYPE-OPENPGP",
1078
session = (gnutls.connection
1079
.ClientSession(self.request,
1081
.X509Credentials()))
1083
# Note: gnutls.connection.X509Credentials is really a
1084
# generic GnuTLS certificate credentials object so long as
1085
# no X.509 keys are added to it. Therefore, we can use it
1086
# here despite using OpenPGP certificates.
1088
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1089
# u"+AES-256-CBC", u"+SHA1",
1090
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2290
1092
# Use a fallback default, since this MUST be set.
2291
1093
priority = self.server.gnutls_priority
2292
1094
if priority is None:
2294
gnutls.priority_set_direct(session._c_object,
2295
priority.encode("utf-8"),
1095
priority = u"NORMAL"
1096
(gnutls.library.functions
1097
.gnutls_priority_set_direct(session._c_object,
2298
1100
# Start communication using the Mandos protocol
2299
1101
# Get protocol number
2300
1102
line = self.request.makefile().readline()
2301
logger.debug("Protocol version: %r", line)
1103
logger.debug(u"Protocol version: %r", line)
2303
1105
if int(line.strip().split()[0]) > 1:
2304
raise RuntimeError(line)
2305
except (ValueError, IndexError, RuntimeError) as error:
2306
logger.error("Unknown protocol version: %s", error)
1107
except (ValueError, IndexError, RuntimeError), error:
1108
logger.error(u"Unknown protocol version: %s", error)
2309
1111
# Start GnuTLS connection
2311
1113
session.handshake()
2312
except gnutls.Error as error:
2313
logger.warning("Handshake failed: %s", error)
1114
except gnutls.errors.GNUTLSError, error:
1115
logger.warning(u"Handshake failed: %s", error)
2314
1116
# Do not run session.bye() here: the session is not
2315
1117
# established. Just abandon the request.
2317
logger.debug("Handshake succeeded")
2319
approval_required = False
1119
logger.debug(u"Handshake succeeded")
2321
if gnutls.has_rawpk:
2324
key_id = self.key_id(
2325
self.peer_certificate(session))
2326
except (TypeError, gnutls.Error) as error:
2327
logger.warning("Bad certificate: %s", error)
2329
logger.debug("Key ID: %s", key_id)
2334
fpr = self.fingerprint(
2335
self.peer_certificate(session))
2336
except (TypeError, gnutls.Error) as error:
2337
logger.warning("Bad certificate: %s", error)
2339
logger.debug("Fingerprint: %s", fpr)
2342
client = ProxyClient(child_pipe, key_id, fpr,
1122
fpr = self.fingerprint(self.peer_certificate
1124
except (TypeError, gnutls.errors.GNUTLSError), error:
1125
logger.warning(u"Bad certificate: %s", error)
1127
logger.debug(u"Fingerprint: %s", fpr)
1130
client = ProxyClient(child_pipe, fpr,
2343
1131
self.client_address)
2344
1132
except KeyError:
2347
if client.approval_delay:
2348
delay = client.approval_delay
2349
client.approvals_pending += 1
2350
approval_required = True
1135
delay = client.approved_delay
2353
1137
if not client.enabled:
2354
logger.info("Client %s is disabled",
1138
logger.warning(u"Client %s is disabled",
1140
if self.server.use_dbus:
1142
client.Rejected("Disabled")
1144
if client._approved is None:
1145
logger.info(u"Client %s need approval",
2356
1147
if self.server.use_dbus:
2357
1148
# Emit D-Bus signal
2358
client.Rejected("Disabled")
2361
if client.approved or not client.approval_delay:
2362
# We are approved or approval is disabled
1149
client.NeedApproval(
1150
client.approved_delay_milliseconds(),
1151
client.approved_by_default)
1152
elif client._approved:
1153
#We have a password and are approved
2364
elif client.approved is None:
2365
logger.info("Client %s needs approval",
2367
if self.server.use_dbus:
2369
client.NeedApproval(
2370
client.approval_delay.total_seconds()
2371
* 1000, client.approved_by_default)
2373
logger.warning("Client %s was not approved",
1156
logger.warning(u"Client %s was not approved",
2375
1158
if self.server.use_dbus:
2377
client.Rejected("Denied")
1160
client.Rejected("Disapproved")
2380
# wait until timeout or approved
1163
#wait until timeout or approved
1164
#x = float(client._timedelta_to_milliseconds(delay))
2381
1165
time = datetime.datetime.now()
2382
1166
client.changedstate.acquire()
2383
client.changedstate.wait(delay.total_seconds())
1167
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
2384
1168
client.changedstate.release()
2385
1169
time2 = datetime.datetime.now()
2386
1170
if (time2 - time) >= delay:
2391
1175
if self.server.use_dbus:
2392
1176
# Emit D-Bus signal
2393
client.Rejected("Approval timed out")
1177
client.Rejected("Time out")
2398
1182
delay -= time2 - time
2401
session.send(client.secret)
2402
except gnutls.Error as error:
2403
logger.warning("gnutls send failed",
2407
logger.info("Sending secret to %s", client.name)
2408
# bump the timeout using extended_timeout
2409
client.bump_timeout(client.extended_timeout)
1185
while sent_size < len(client.secret):
1186
# XXX handle session exception
1187
sent = session.send(client.secret[sent_size:])
1188
logger.debug(u"Sent: %d, remaining: %d",
1189
sent, len(client.secret)
1190
- (sent_size + sent))
1193
logger.info(u"Sending secret to %s", client.name)
1194
# bump the timeout as if seen
2410
1196
if self.server.use_dbus:
2411
1197
# Emit D-Bus signal
2412
1198
client.GotSecret()
2415
if approval_required:
2416
client.approvals_pending -= 1
2419
except gnutls.Error as error:
2420
logger.warning("GnuTLS bye failed",
2424
1204
def peer_certificate(session):
2425
"Return the peer's certificate as a bytestring"
2427
cert_type = gnutls.certificate_type_get2(session._c_object,
2429
except AttributeError:
2430
cert_type = gnutls.certificate_type_get(session._c_object)
2431
if gnutls.has_rawpk:
2432
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2434
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2435
# If not a valid certificate type...
2436
if cert_type not in valid_cert_types:
2437
logger.info("Cert type %r not in %r", cert_type,
2439
# ...return invalid data
1205
"Return the peer's OpenPGP certificate as a bytestring"
1206
# If not an OpenPGP certificate...
1207
if (gnutls.library.functions
1208
.gnutls_certificate_type_get(session._c_object)
1209
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1210
# ...do the normal thing
1211
return session.peer_certificate
2441
1212
list_size = ctypes.c_uint(1)
2442
cert_list = (gnutls.certificate_get_peers
1213
cert_list = (gnutls.library.functions
1214
.gnutls_certificate_get_peers
2443
1215
(session._c_object, ctypes.byref(list_size)))
2444
1216
if not bool(cert_list) and list_size.value != 0:
2445
raise gnutls.Error("error getting peer certificate")
1217
raise gnutls.errors.GNUTLSError(u"error getting peer"
2446
1219
if list_size.value == 0:
2448
1221
cert = cert_list[0]
2449
1222
return ctypes.string_at(cert.data, cert.size)
2452
def key_id(certificate):
2453
"Convert a certificate bytestring to a hexdigit key ID"
2454
# New GnuTLS "datum" with the public key
2455
datum = gnutls.datum_t(
2456
ctypes.cast(ctypes.c_char_p(certificate),
2457
ctypes.POINTER(ctypes.c_ubyte)),
2458
ctypes.c_uint(len(certificate)))
2459
# XXX all these need to be created in the gnutls "module"
2460
# New empty GnuTLS certificate
2461
pubkey = gnutls.pubkey_t()
2462
gnutls.pubkey_init(ctypes.byref(pubkey))
2463
# Import the raw public key into the certificate
2464
gnutls.pubkey_import(pubkey,
2465
ctypes.byref(datum),
2466
gnutls.X509_FMT_DER)
2467
# New buffer for the key ID
2468
buf = ctypes.create_string_buffer(32)
2469
buf_len = ctypes.c_size_t(len(buf))
2470
# Get the key ID from the raw public key into the buffer
2471
gnutls.pubkey_get_key_id(pubkey,
2472
gnutls.KEYID_USE_SHA256,
2473
ctypes.cast(ctypes.byref(buf),
2474
ctypes.POINTER(ctypes.c_ubyte)),
2475
ctypes.byref(buf_len))
2476
# Deinit the certificate
2477
gnutls.pubkey_deinit(pubkey)
2479
# Convert the buffer to a Python bytestring
2480
key_id = ctypes.string_at(buf, buf_len.value)
2481
# Convert the bytestring to hexadecimal notation
2482
hex_key_id = binascii.hexlify(key_id).upper()
2486
1225
def fingerprint(openpgp):
2487
1226
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2488
1227
# New GnuTLS "datum" with the OpenPGP public key
2489
datum = gnutls.datum_t(
2490
ctypes.cast(ctypes.c_char_p(openpgp),
2491
ctypes.POINTER(ctypes.c_ubyte)),
2492
ctypes.c_uint(len(openpgp)))
1228
datum = (gnutls.library.types
1229
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1232
ctypes.c_uint(len(openpgp))))
2493
1233
# New empty GnuTLS certificate
2494
crt = gnutls.openpgp_crt_t()
2495
gnutls.openpgp_crt_init(ctypes.byref(crt))
1234
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1235
(gnutls.library.functions
1236
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2496
1237
# Import the OpenPGP public key into the certificate
2497
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2498
gnutls.OPENPGP_FMT_RAW)
1238
(gnutls.library.functions
1239
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1240
gnutls.library.constants
1241
.GNUTLS_OPENPGP_FMT_RAW))
2499
1242
# Verify the self signature in the key
2500
1243
crtverify = ctypes.c_uint()
2501
gnutls.openpgp_crt_verify_self(crt, 0,
2502
ctypes.byref(crtverify))
1244
(gnutls.library.functions
1245
.gnutls_openpgp_crt_verify_self(crt, 0,
1246
ctypes.byref(crtverify)))
2503
1247
if crtverify.value != 0:
2504
gnutls.openpgp_crt_deinit(crt)
2505
raise gnutls.CertificateSecurityError(code
1248
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1249
raise (gnutls.errors.CertificateSecurityError
2507
1251
# New buffer for the fingerprint
2508
1252
buf = ctypes.create_string_buffer(20)
2509
1253
buf_len = ctypes.c_size_t()
2510
1254
# Get the fingerprint from the certificate into the buffer
2511
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2512
ctypes.byref(buf_len))
1255
(gnutls.library.functions
1256
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1257
ctypes.byref(buf_len)))
2513
1258
# Deinit the certificate
2514
gnutls.openpgp_crt_deinit(crt)
1259
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2515
1260
# Convert the buffer to a Python bytestring
2516
1261
fpr = ctypes.string_at(buf, buf_len.value)
2517
1262
# Convert the bytestring to hexadecimal notation
2518
hex_fpr = binascii.hexlify(fpr).upper()
1263
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2522
class MultiprocessingMixIn:
1267
class MultiprocessingMixIn(object):
2523
1268
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2525
1269
def sub_process_main(self, request, address):
2527
1271
self.finish_request(request, address)
2529
1273
self.handle_error(request, address)
2530
1274
self.close_request(request)
2532
1276
def process_request(self, request, address):
2533
1277
"""Start a new process to process the request."""
2534
proc = multiprocessing.Process(target=self.sub_process_main,
2535
args=(request, address))
2540
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1278
multiprocessing.Process(target = self.sub_process_main,
1279
args = (request, address)).start()
1281
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2541
1282
""" adds a pipe to the MixIn """
2543
1283
def process_request(self, request, client_address):
2544
1284
"""Overrides and wraps the original process_request().
2546
1286
This function creates a new pipe in self.pipe
2548
1288
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2550
proc = MultiprocessingMixIn.process_request(self, request,
2552
self.child_pipe.close()
2553
self.add_pipe(parent_pipe, proc)
2555
def add_pipe(self, parent_pipe, proc):
1290
super(MultiprocessingMixInWithPipe,
1291
self).process_request(request, client_address)
1292
self.add_pipe(parent_pipe)
1293
def add_pipe(self, parent_pipe):
2556
1294
"""Dummy function; override as necessary"""
2557
raise NotImplementedError()
2560
1297
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2561
socketserver.TCPServer):
1298
socketserver.TCPServer, object):
2562
1299
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2565
1302
enabled: Boolean; whether this server is activated yet
2566
1303
interface: None or a network interface name (string)
2567
1304
use_ipv6: Boolean; to use IPv6 or not
2570
1306
def __init__(self, server_address, RequestHandlerClass,
2574
"""If socketfd is set, use that file descriptor instead of
2575
creating a new one with socket.socket().
1307
interface=None, use_ipv6=True):
2577
1308
self.interface = interface
2579
1310
self.address_family = socket.AF_INET6
2580
if socketfd is not None:
2581
# Save the file descriptor
2582
self.socketfd = socketfd
2583
# Save the original socket.socket() function
2584
self.socket_socket = socket.socket
2586
# To implement --socket, we monkey patch socket.socket.
2588
# (When socketserver.TCPServer is a new-style class, we
2589
# could make self.socket into a property instead of monkey
2590
# patching socket.socket.)
2592
# Create a one-time-only replacement for socket.socket()
2593
@functools.wraps(socket.socket)
2594
def socket_wrapper(*args, **kwargs):
2595
# Restore original function so subsequent calls are
2597
socket.socket = self.socket_socket
2598
del self.socket_socket
2599
# This time only, return a new socket object from the
2600
# saved file descriptor.
2601
return socket.fromfd(self.socketfd, *args, **kwargs)
2602
# Replace socket.socket() function with wrapper
2603
socket.socket = socket_wrapper
2604
# The socketserver.TCPServer.__init__ will call
2605
# socket.socket(), which might be our replacement,
2606
# socket_wrapper(), if socketfd was set.
2607
1311
socketserver.TCPServer.__init__(self, server_address,
2608
1312
RequestHandlerClass)
2610
1313
def server_bind(self):
2611
1314
"""This overrides the normal server_bind() function
2612
1315
to bind to an interface if one was specified, and also NOT to
2613
1316
bind to an address or port if they were not specified."""
2614
global SO_BINDTODEVICE
2615
1317
if self.interface is not None:
2616
1318
if SO_BINDTODEVICE is None:
2617
# Fall back to a hard-coded value which seems to be
2619
logger.warning("SO_BINDTODEVICE not found, trying 25")
2620
SO_BINDTODEVICE = 25
2622
self.socket.setsockopt(
2623
socket.SOL_SOCKET, SO_BINDTODEVICE,
2624
(self.interface + "\0").encode("utf-8"))
2625
except socket.error as error:
2626
if error.errno == errno.EPERM:
2627
logger.error("No permission to bind to"
2628
" interface %s", self.interface)
2629
elif error.errno == errno.ENOPROTOOPT:
2630
logger.error("SO_BINDTODEVICE not available;"
2631
" cannot bind to interface %s",
2633
elif error.errno == errno.ENODEV:
2634
logger.error("Interface %s does not exist,"
2635
" cannot bind", self.interface)
1319
logger.error(u"SO_BINDTODEVICE does not exist;"
1320
u" cannot bind to interface %s",
1324
self.socket.setsockopt(socket.SOL_SOCKET,
1328
except socket.error, error:
1329
if error[0] == errno.EPERM:
1330
logger.error(u"No permission to"
1331
u" bind to interface %s",
1333
elif error[0] == errno.ENOPROTOOPT:
1334
logger.error(u"SO_BINDTODEVICE not available;"
1335
u" cannot bind to interface %s",
2638
1339
# Only bind(2) the socket if we really need to.
2639
1340
if self.server_address[0] or self.server_address[1]:
2640
if self.server_address[1]:
2641
self.allow_reuse_address = True
2642
1341
if not self.server_address[0]:
2643
1342
if self.address_family == socket.AF_INET6:
2644
any_address = "::" # in6addr_any
1343
any_address = u"::" # in6addr_any
2646
any_address = "0.0.0.0" # INADDR_ANY
1345
any_address = socket.INADDR_ANY
2647
1346
self.server_address = (any_address,
2648
1347
self.server_address[1])
2649
1348
elif not self.server_address[1]:
2650
self.server_address = (self.server_address[0], 0)
1349
self.server_address = (self.server_address[0],
2651
1351
# if self.interface:
2652
1352
# self.server_address = (self.server_address[0],
2660
1360
class MandosServer(IPv6_TCPServer):
2661
1361
"""Mandos server.
2664
1364
clients: set of Client objects
2665
1365
gnutls_priority GnuTLS priority string
2666
1366
use_dbus: Boolean; to emit D-Bus signals or not
2668
Assumes a GLib.MainLoop event loop.
1368
Assumes a gobject.MainLoop event loop.
2671
1370
def __init__(self, server_address, RequestHandlerClass,
2675
gnutls_priority=None,
1371
interface=None, use_ipv6=True, clients=None,
1372
gnutls_priority=None, use_dbus=True):
2678
1373
self.enabled = False
2679
1374
self.clients = clients
2680
1375
if self.clients is None:
1376
self.clients = set()
2682
1377
self.use_dbus = use_dbus
2683
1378
self.gnutls_priority = gnutls_priority
2684
1379
IPv6_TCPServer.__init__(self, server_address,
2685
1380
RequestHandlerClass,
2686
interface=interface,
1381
interface = interface,
1382
use_ipv6 = use_ipv6)
2690
1383
def server_activate(self):
2691
1384
if self.enabled:
2692
1385
return socketserver.TCPServer.server_activate(self)
2694
1386
def enable(self):
2695
1387
self.enabled = True
2697
def add_pipe(self, parent_pipe, proc):
1388
def add_pipe(self, parent_pipe):
2698
1389
# Call "handle_ipc" for both data and EOF events
2700
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2701
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2702
functools.partial(self.handle_ipc,
2703
parent_pipe=parent_pipe,
2706
def handle_ipc(self, source, condition,
1390
gobject.io_add_watch(parent_pipe.fileno(),
1391
gobject.IO_IN | gobject.IO_HUP,
1392
functools.partial(self.handle_ipc,
1393
parent_pipe = parent_pipe))
1395
def handle_ipc(self, source, condition, parent_pipe=None,
2709
1396
client_object=None):
2710
# error, or the other end of multiprocessing.Pipe has closed
2711
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2712
# Wait for other process to exit
1398
gobject.IO_IN: u"IN", # There is data to read.
1399
gobject.IO_OUT: u"OUT", # Data can be written (without
1401
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1402
gobject.IO_ERR: u"ERR", # Error condition.
1403
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1404
# broken, usually for pipes and
1407
conditions_string = ' | '.join(name
1409
condition_names.iteritems()
1410
if cond & condition)
1411
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
2716
1414
# Read a request from the child
2717
1415
request = parent_pipe.recv()
2718
1416
command = request[0]
2720
1418
if command == 'init':
2721
key_id = request[1].decode("ascii")
2722
fpr = request[2].decode("ascii")
2723
address = request[3]
2725
for c in self.clients.values():
2726
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2728
if key_id and c.key_id == key_id:
2731
if fpr and c.fingerprint == fpr:
1420
address = request[2]
1422
for c in self.clients:
1423
if c.fingerprint == fpr:
2735
logger.info("Client not found for key ID: %s, address"
2736
": %s", key_id or fpr, address)
1427
logger.warning(u"Client not found for fingerprint: %s, ad"
1428
u"dress: %s", fpr, address)
2737
1429
if self.use_dbus:
2738
1430
# Emit D-Bus signal
2739
mandos_dbus_service.ClientNotFound(key_id or fpr,
1431
mandos_dbus_service.ClientNotFound(fpr, address)
2741
1432
parent_pipe.send(False)
2745
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2746
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2747
functools.partial(self.handle_ipc,
2748
parent_pipe=parent_pipe,
2750
client_object=client))
1435
gobject.io_add_watch(parent_pipe.fileno(),
1436
gobject.IO_IN | gobject.IO_HUP,
1437
functools.partial(self.handle_ipc,
1438
parent_pipe = parent_pipe,
1439
client_object = client))
2751
1440
parent_pipe.send(True)
2752
# remove the old hook in favor of the new above hook on
1441
# remove the old hook in favor of the new above hook on same fileno
2755
1443
if command == 'funcall':
2756
1444
funcname = request[1]
2757
1445
args = request[2]
2758
1446
kwargs = request[3]
2760
parent_pipe.send(('data', getattr(client_object,
1448
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2764
1450
if command == 'getattr':
2765
1451
attrname = request[1]
2766
if isinstance(client_object.__getattribute__(attrname),
2767
collections.abc.Callable):
2768
parent_pipe.send(('function', ))
1452
if callable(client_object.__getattribute__(attrname)):
1453
parent_pipe.send(('function',))
2771
'data', client_object.__getattribute__(attrname)))
1455
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2773
1457
if command == 'setattr':
2774
1458
attrname = request[1]
2775
1459
value = request[2]
2776
1460
setattr(client_object, attrname, value)
2781
def rfc3339_duration_to_delta(duration):
2782
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2784
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2786
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2788
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2790
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2792
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2794
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2796
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2800
# Parsing an RFC 3339 duration with regular expressions is not
2801
# possible - there would have to be multiple places for the same
2802
# values, like seconds. The current code, while more esoteric, is
2803
# cleaner without depending on a parsing library. If Python had a
2804
# built-in library for parsing we would use it, but we'd like to
2805
# avoid excessive use of external libraries.
2807
# New type for defining tokens, syntax, and semantics all-in-one
2808
Token = collections.namedtuple("Token", (
2809
"regexp", # To match token; if "value" is not None, must have
2810
# a "group" containing digits
2811
"value", # datetime.timedelta or None
2812
"followers")) # Tokens valid after this token
2813
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2814
# the "duration" ABNF definition in RFC 3339, Appendix A.
2815
token_end = Token(re.compile(r"$"), None, frozenset())
2816
token_second = Token(re.compile(r"(\d+)S"),
2817
datetime.timedelta(seconds=1),
2818
frozenset((token_end, )))
2819
token_minute = Token(re.compile(r"(\d+)M"),
2820
datetime.timedelta(minutes=1),
2821
frozenset((token_second, token_end)))
2822
token_hour = Token(re.compile(r"(\d+)H"),
2823
datetime.timedelta(hours=1),
2824
frozenset((token_minute, token_end)))
2825
token_time = Token(re.compile(r"T"),
2827
frozenset((token_hour, token_minute,
2829
token_day = Token(re.compile(r"(\d+)D"),
2830
datetime.timedelta(days=1),
2831
frozenset((token_time, token_end)))
2832
token_month = Token(re.compile(r"(\d+)M"),
2833
datetime.timedelta(weeks=4),
2834
frozenset((token_day, token_end)))
2835
token_year = Token(re.compile(r"(\d+)Y"),
2836
datetime.timedelta(weeks=52),
2837
frozenset((token_month, token_end)))
2838
token_week = Token(re.compile(r"(\d+)W"),
2839
datetime.timedelta(weeks=1),
2840
frozenset((token_end, )))
2841
token_duration = Token(re.compile(r"P"), None,
2842
frozenset((token_year, token_month,
2843
token_day, token_time,
2845
# Define starting values:
2847
value = datetime.timedelta()
2849
# Following valid tokens
2850
followers = frozenset((token_duration, ))
2851
# String left to parse
2853
# Loop until end token is found
2854
while found_token is not token_end:
2855
# Search for any currently valid tokens
2856
for token in followers:
2857
match = token.regexp.match(s)
2858
if match is not None:
2860
if token.value is not None:
2861
# Value found, parse digits
2862
factor = int(match.group(1), 10)
2863
# Add to value so far
2864
value += factor * token.value
2865
# Strip token from string
2866
s = token.regexp.sub("", s, 1)
2869
# Set valid next tokens
2870
followers = found_token.followers
2873
# No currently valid tokens were found
2874
raise ValueError("Invalid RFC 3339 duration: {!r}"
2880
1465
def string_to_delta(interval):
2881
1466
"""Parse a string and return a datetime.timedelta
2883
>>> string_to_delta('7d') == datetime.timedelta(7)
2885
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2887
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2889
>>> string_to_delta('24h') == datetime.timedelta(1)
2891
>>> string_to_delta('1w') == datetime.timedelta(7)
2893
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
1468
>>> string_to_delta(u'7d')
1469
datetime.timedelta(7)
1470
>>> string_to_delta(u'60s')
1471
datetime.timedelta(0, 60)
1472
>>> string_to_delta(u'60m')
1473
datetime.timedelta(0, 3600)
1474
>>> string_to_delta(u'24h')
1475
datetime.timedelta(1)
1476
>>> string_to_delta(u'1w')
1477
datetime.timedelta(7)
1478
>>> string_to_delta(u'5m 30s')
1479
datetime.timedelta(0, 330)
2898
return rfc3339_duration_to_delta(interval)
2902
1481
timevalue = datetime.timedelta(0)
2903
1482
for s in interval.split():
1484
suffix = unicode(s[-1])
2906
1485
value = int(s[:-1])
2908
1487
delta = datetime.timedelta(value)
1488
elif suffix == u"s":
2910
1489
delta = datetime.timedelta(0, value)
1490
elif suffix == u"m":
2912
1491
delta = datetime.timedelta(0, 0, 0, 0, value)
1492
elif suffix == u"h":
2914
1493
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1494
elif suffix == u"w":
2916
1495
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2918
raise ValueError("Unknown suffix {!r}".format(suffix))
2919
except IndexError as e:
2920
raise ValueError(*(e.args))
1497
raise ValueError(u"Unknown suffix %r" % suffix)
1498
except (ValueError, IndexError), e:
1499
raise ValueError(e.message)
2921
1500
timevalue += delta
2922
1501
return timevalue
2925
def daemon(nochdir=False, noclose=False):
1504
def if_nametoindex(interface):
1505
"""Call the C function if_nametoindex(), or equivalent
1507
Note: This function cannot accept a unicode string."""
1508
global if_nametoindex
1510
if_nametoindex = (ctypes.cdll.LoadLibrary
1511
(ctypes.util.find_library(u"c"))
1513
except (OSError, AttributeError):
1514
logger.warning(u"Doing if_nametoindex the hard way")
1515
def if_nametoindex(interface):
1516
"Get an interface index the hard way, i.e. using fcntl()"
1517
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1518
with contextlib.closing(socket.socket()) as s:
1519
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1520
struct.pack(str(u"16s16x"),
1522
interface_index = struct.unpack(str(u"I"),
1524
return interface_index
1525
return if_nametoindex(interface)
1528
def daemon(nochdir = False, noclose = False):
2926
1529
"""See daemon(3). Standard BSD Unix function.
2928
1531
This should really exist as os.daemon, but it doesn't (yet)."""
2932
1535
if not nochdir:
2936
1539
if not noclose:
2937
1540
# Close all standard open file descriptors
2938
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1541
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2939
1542
if not stat.S_ISCHR(os.fstat(null).st_mode):
2940
1543
raise OSError(errno.ENODEV,
2941
"{} not a character device"
2942
.format(os.devnull))
1544
u"%s not a character device"
2943
1546
os.dup2(null, sys.stdin.fileno())
2944
1547
os.dup2(null, sys.stdout.fileno())
2945
1548
os.dup2(null, sys.stderr.fileno())
2952
1555
##################################################################
2953
1556
# Parsing of options, both command line and config file
2955
parser = argparse.ArgumentParser()
2956
parser.add_argument("-v", "--version", action="version",
2957
version="%(prog)s {}".format(version),
2958
help="show version number and exit")
2959
parser.add_argument("-i", "--interface", metavar="IF",
2960
help="Bind to interface IF")
2961
parser.add_argument("-a", "--address",
2962
help="Address to listen for requests on")
2963
parser.add_argument("-p", "--port", type=int,
2964
help="Port number to receive requests on")
2965
parser.add_argument("--check", action="store_true",
2966
help="Run self-test")
2967
parser.add_argument("--debug", action="store_true",
2968
help="Debug mode; run in foreground and log"
2969
" to terminal", default=None)
2970
parser.add_argument("--debuglevel", metavar="LEVEL",
2971
help="Debug level for stdout output")
2972
parser.add_argument("--priority", help="GnuTLS"
2973
" priority string (see GnuTLS documentation)")
2974
parser.add_argument("--servicename",
2975
metavar="NAME", help="Zeroconf service name")
2976
parser.add_argument("--configdir",
2977
default="/etc/mandos", metavar="DIR",
2978
help="Directory to search for configuration"
2980
parser.add_argument("--no-dbus", action="store_false",
2981
dest="use_dbus", help="Do not provide D-Bus"
2982
" system bus interface", default=None)
2983
parser.add_argument("--no-ipv6", action="store_false",
2984
dest="use_ipv6", help="Do not use IPv6",
2986
parser.add_argument("--no-restore", action="store_false",
2987
dest="restore", help="Do not restore stored"
2988
" state", default=None)
2989
parser.add_argument("--socket", type=int,
2990
help="Specify a file descriptor to a network"
2991
" socket to use instead of creating one")
2992
parser.add_argument("--statedir", metavar="DIR",
2993
help="Directory to save/restore state in")
2994
parser.add_argument("--foreground", action="store_true",
2995
help="Run in foreground", default=None)
2996
parser.add_argument("--no-zeroconf", action="store_false",
2997
dest="zeroconf", help="Do not use Zeroconf",
3000
options = parser.parse_args()
1558
parser = optparse.OptionParser(version = "%%prog %s" % version)
1559
parser.add_option("-i", u"--interface", type=u"string",
1560
metavar="IF", help=u"Bind to interface IF")
1561
parser.add_option("-a", u"--address", type=u"string",
1562
help=u"Address to listen for requests on")
1563
parser.add_option("-p", u"--port", type=u"int",
1564
help=u"Port number to receive requests on")
1565
parser.add_option("--check", action=u"store_true",
1566
help=u"Run self-test")
1567
parser.add_option("--debug", action=u"store_true",
1568
help=u"Debug mode; run in foreground and log to"
1570
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1571
u" priority string (see GnuTLS documentation)")
1572
parser.add_option("--servicename", type=u"string",
1573
metavar=u"NAME", help=u"Zeroconf service name")
1574
parser.add_option("--configdir", type=u"string",
1575
default=u"/etc/mandos", metavar=u"DIR",
1576
help=u"Directory to search for configuration"
1578
parser.add_option("--no-dbus", action=u"store_false",
1579
dest=u"use_dbus", help=u"Do not provide D-Bus"
1580
u" system bus interface")
1581
parser.add_option("--no-ipv6", action=u"store_false",
1582
dest=u"use_ipv6", help=u"Do not use IPv6")
1583
options = parser.parse_args()[0]
3002
1590
# Default values for config file for server-global settings
3003
if gnutls.has_rawpk:
3004
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3005
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3007
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3008
":+SIGN-DSA-SHA256")
3009
server_defaults = {"interface": "",
3013
"priority": priority,
3014
"servicename": "Mandos",
3020
"statedir": "/var/lib/mandos",
3021
"foreground": "False",
1591
server_defaults = { u"interface": u"",
1596
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1597
u"servicename": u"Mandos",
1598
u"use_dbus": u"True",
1599
u"use_ipv6": u"True",
3026
1602
# Parse config file for server-global settings
3027
server_config = configparser.ConfigParser(server_defaults)
1603
server_config = configparser.SafeConfigParser(server_defaults)
3028
1604
del server_defaults
3029
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3030
# Convert the ConfigParser object to a dict
1605
server_config.read(os.path.join(options.configdir,
1607
# Convert the SafeConfigParser object to a dict
3031
1608
server_settings = server_config.defaults()
3032
1609
# Use the appropriate methods on the non-string config options
3033
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3034
"foreground", "zeroconf"):
3035
server_settings[option] = server_config.getboolean("DEFAULT",
1610
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1611
server_settings[option] = server_config.getboolean(u"DEFAULT",
3037
1613
if server_settings["port"]:
3038
server_settings["port"] = server_config.getint("DEFAULT",
3040
if server_settings["socket"]:
3041
server_settings["socket"] = server_config.getint("DEFAULT",
3043
# Later, stdin will, and stdout and stderr might, be dup'ed
3044
# over with an opened os.devnull. But we don't want this to
3045
# happen with a supplied network socket.
3046
if 0 <= server_settings["socket"] <= 2:
3047
server_settings["socket"] = os.dup(server_settings
1614
server_settings["port"] = server_config.getint(u"DEFAULT",
3049
1616
del server_config
3051
1618
# Override the settings from the config file with command line
3052
1619
# options, if set.
3053
for option in ("interface", "address", "port", "debug",
3054
"priority", "servicename", "configdir", "use_dbus",
3055
"use_ipv6", "debuglevel", "restore", "statedir",
3056
"socket", "foreground", "zeroconf"):
1620
for option in (u"interface", u"address", u"port", u"debug",
1621
u"priority", u"servicename", u"configdir",
1622
u"use_dbus", u"use_ipv6"):
3057
1623
value = getattr(options, option)
3058
1624
if value is not None:
3059
1625
server_settings[option] = value
3061
1627
# Force all strings to be unicode
3062
1628
for option in server_settings.keys():
3063
if isinstance(server_settings[option], bytes):
3064
server_settings[option] = (server_settings[option]
3066
# Force all boolean options to be boolean
3067
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3068
"foreground", "zeroconf"):
3069
server_settings[option] = bool(server_settings[option])
3070
# Debug implies foreground
3071
if server_settings["debug"]:
3072
server_settings["foreground"] = True
1629
if type(server_settings[option]) is str:
1630
server_settings[option] = unicode(server_settings[option])
3073
1631
# Now we have our good server settings in "server_settings"
3075
1633
##################################################################
3077
if (not server_settings["zeroconf"]
3078
and not (server_settings["port"]
3079
or server_settings["socket"] != "")):
3080
parser.error("Needs port or socket to work without Zeroconf")
3082
1635
# For convenience
3083
debug = server_settings["debug"]
3084
debuglevel = server_settings["debuglevel"]
3085
use_dbus = server_settings["use_dbus"]
3086
use_ipv6 = server_settings["use_ipv6"]
3087
stored_state_path = os.path.join(server_settings["statedir"],
3089
foreground = server_settings["foreground"]
3090
zeroconf = server_settings["zeroconf"]
3093
initlogger(debug, logging.DEBUG)
3098
level = getattr(logging, debuglevel.upper())
3099
initlogger(debug, level)
3101
if server_settings["servicename"] != "Mandos":
3102
syslogger.setFormatter(
3103
logging.Formatter('Mandos ({}) [%(process)d]:'
3104
' %(levelname)s: %(message)s'.format(
3105
server_settings["servicename"])))
1636
debug = server_settings[u"debug"]
1637
use_dbus = server_settings[u"use_dbus"]
1638
use_ipv6 = server_settings[u"use_ipv6"]
1641
syslogger.setLevel(logging.WARNING)
1642
console.setLevel(logging.WARNING)
1644
if server_settings[u"servicename"] != u"Mandos":
1645
syslogger.setFormatter(logging.Formatter
1646
(u'Mandos (%s) [%%(process)d]:'
1647
u' %%(levelname)s: %%(message)s'
1648
% server_settings[u"servicename"]))
3107
1650
# Parse config file with clients
3108
client_config = configparser.ConfigParser(Client.client_defaults)
3109
client_config.read(os.path.join(server_settings["configdir"],
1651
client_defaults = { u"timeout": u"1h",
1653
u"checker": u"fping -q -- %%(host)s",
1655
u"approved_delay": u"5m",
1656
u"approved_duration": u"1s",
1658
client_config = configparser.SafeConfigParser(client_defaults)
1659
client_config.read(os.path.join(server_settings[u"configdir"],
3112
1662
global mandos_dbus_service
3113
1663
mandos_dbus_service = None
3116
if server_settings["socket"] != "":
3117
socketfd = server_settings["socket"]
3118
tcp_server = MandosServer(
3119
(server_settings["address"], server_settings["port"]),
3121
interface=(server_settings["interface"] or None),
3123
gnutls_priority=server_settings["priority"],
3127
pidfilename = "/run/mandos.pid"
3128
if not os.path.isdir("/run/."):
3129
pidfilename = "/var/run/mandos.pid"
3132
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3133
except IOError as e:
3134
logger.error("Could not open file %r", pidfilename,
3137
for name, group in (("_mandos", "_mandos"),
3138
("mandos", "mandos"),
3139
("nobody", "nogroup")):
3141
uid = pwd.getpwnam(name).pw_uid
3142
gid = pwd.getpwnam(group).pw_gid
1665
tcp_server = MandosServer((server_settings[u"address"],
1666
server_settings[u"port"]),
1668
interface=server_settings[u"interface"],
1671
server_settings[u"priority"],
1673
pidfilename = u"/var/run/mandos.pid"
1675
pidfile = open(pidfilename, u"w")
1677
logger.error(u"Could not open file %r", pidfilename)
1680
uid = pwd.getpwnam(u"_mandos").pw_uid
1681
gid = pwd.getpwnam(u"_mandos").pw_gid
1684
uid = pwd.getpwnam(u"mandos").pw_uid
1685
gid = pwd.getpwnam(u"mandos").pw_gid
3144
1686
except KeyError:
1688
uid = pwd.getpwnam(u"nobody").pw_uid
1689
gid = pwd.getpwnam(u"nobody").pw_gid
3153
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3155
except OSError as error:
3156
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3157
.format(uid, gid, os.strerror(error.errno)))
3158
if error.errno != errno.EPERM:
1696
except OSError, error:
1697
if error[0] != errno.EPERM:
1700
# Enable all possible GnuTLS debugging
3162
# Enable all possible GnuTLS debugging
3164
1702
# "Use a log level over 10 to enable all debugging options."
3165
1703
# - GnuTLS manual
3166
gnutls.global_set_log_level(11)
1704
gnutls.library.functions.gnutls_global_set_log_level(11)
1706
@gnutls.library.types.gnutls_log_func
3169
1707
def debug_gnutls(level, string):
3170
logger.debug("GnuTLS: %s", string[:-1])
3172
gnutls.global_set_log_function(debug_gnutls)
3174
# Redirect stdin so all checkers get /dev/null
3175
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3176
os.dup2(null, sys.stdin.fileno())
3180
# Need to fork before connecting to D-Bus
3182
# Close all input and output, do double fork, etc.
3185
if gi.version_info < (3, 10, 2):
3186
# multiprocessing will use threads, so before we use GLib we
3187
# need to inform GLib that threads will be used.
1708
logger.debug(u"GnuTLS: %s", string[:-1])
1710
(gnutls.library.functions
1711
.gnutls_global_set_log_function(debug_gnutls))
3190
1713
global main_loop
3191
1714
# From the Avahi example code
3192
DBusGMainLoop(set_as_default=True)
3193
main_loop = GLib.MainLoop()
1715
DBusGMainLoop(set_as_default=True )
1716
main_loop = gobject.MainLoop()
3194
1717
bus = dbus.SystemBus()
3195
1718
# End of Avahi example code
3198
bus_name = dbus.service.BusName("se.recompile.Mandos",
3201
old_bus_name = dbus.service.BusName(
3202
"se.bsnet.fukt.Mandos", bus,
3204
except dbus.exceptions.DBusException as e:
3205
logger.error("Disabling D-Bus:", exc_info=e)
1721
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1722
bus, do_not_queue=True)
1723
except dbus.exceptions.NameExistsException, e:
1724
logger.error(unicode(e) + u", disabling D-Bus")
3206
1725
use_dbus = False
3207
server_settings["use_dbus"] = False
1726
server_settings[u"use_dbus"] = False
3208
1727
tcp_server.use_dbus = False
3210
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3211
service = AvahiServiceToSyslog(
3212
name=server_settings["servicename"],
3213
servicetype="_mandos._tcp",
3216
if server_settings["interface"]:
3217
service.interface = if_nametoindex(
3218
server_settings["interface"].encode("utf-8"))
3220
global multiprocessing_manager
3221
multiprocessing_manager = multiprocessing.Manager()
1728
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1729
service = AvahiService(name = server_settings[u"servicename"],
1730
servicetype = u"_mandos._tcp",
1731
protocol = protocol, bus = bus)
1732
if server_settings["interface"]:
1733
service.interface = (if_nametoindex
1734
(str(server_settings[u"interface"])))
3223
1736
client_class = Client
3225
client_class = functools.partial(ClientDBus, bus=bus)
3227
client_settings = Client.config_parser(client_config)
3228
old_client_settings = {}
3231
# This is used to redirect stdout and stderr for checker processes
3233
wnull = open(os.devnull, "w") # A writable /dev/null
3234
# Only used if server is running in foreground but not in debug
3236
if debug or not foreground:
3239
# Get client data and settings from last running state.
3240
if server_settings["restore"]:
3242
with open(stored_state_path, "rb") as stored_state:
3243
if sys.version_info.major == 2:
3244
clients_data, old_client_settings = pickle.load(
3247
bytes_clients_data, bytes_old_client_settings = (
3248
pickle.load(stored_state, encoding="bytes"))
3249
# Fix bytes to strings
3252
clients_data = {(key.decode("utf-8")
3253
if isinstance(key, bytes)
3256
bytes_clients_data.items()}
3257
del bytes_clients_data
3258
for key in clients_data:
3259
value = {(k.decode("utf-8")
3260
if isinstance(k, bytes) else k): v
3262
clients_data[key].items()}
3263
clients_data[key] = value
3265
value["client_structure"] = [
3267
if isinstance(s, bytes)
3269
value["client_structure"]]
3270
# .name, .host, and .checker_command
3271
for k in ("name", "host", "checker_command"):
3272
if isinstance(value[k], bytes):
3273
value[k] = value[k].decode("utf-8")
3274
if "key_id" not in value:
3275
value["key_id"] = ""
3276
elif "fingerprint" not in value:
3277
value["fingerprint"] = ""
3278
# old_client_settings
3280
old_client_settings = {
3281
(key.decode("utf-8")
3282
if isinstance(key, bytes)
3285
bytes_old_client_settings.items()}
3286
del bytes_old_client_settings
3287
# .host and .checker_command
3288
for value in old_client_settings.values():
3289
for attribute in ("host", "checker_command"):
3290
if isinstance(value[attribute], bytes):
3291
value[attribute] = (value[attribute]
3293
os.remove(stored_state_path)
3294
except IOError as e:
3295
if e.errno == errno.ENOENT:
3296
logger.warning("Could not load persistent state:"
3297
" {}".format(os.strerror(e.errno)))
3299
logger.critical("Could not load persistent state:",
3302
except EOFError as e:
3303
logger.warning("Could not load persistent state: "
3307
with PGPEngine() as pgp:
3308
for client_name, client in clients_data.items():
3309
# Skip removed clients
3310
if client_name not in client_settings:
3313
# Decide which value to use after restoring saved state.
3314
# We have three different values: Old config file,
3315
# new config file, and saved state.
3316
# New config value takes precedence if it differs from old
3317
# config value, otherwise use saved state.
3318
for name, value in client_settings[client_name].items():
3320
# For each value in new config, check if it
3321
# differs from the old config value (Except for
3322
# the "secret" attribute)
3323
if (name != "secret"
3325
old_client_settings[client_name][name])):
3326
client[name] = value
3330
# Clients who has passed its expire date can still be
3331
# enabled if its last checker was successful. A Client
3332
# whose checker succeeded before we stored its state is
3333
# assumed to have successfully run all checkers during
3335
if client["enabled"]:
3336
if datetime.datetime.utcnow() >= client["expires"]:
3337
if not client["last_checked_ok"]:
3339
"disabling client {} - Client never "
3340
"performed a successful checker".format(
3342
client["enabled"] = False
3343
elif client["last_checker_status"] != 0:
3345
"disabling client {} - Client last"
3346
" checker failed with error code"
3349
client["last_checker_status"]))
3350
client["enabled"] = False
3352
client["expires"] = (
3353
datetime.datetime.utcnow()
3354
+ client["timeout"])
3355
logger.debug("Last checker succeeded,"
3356
" keeping {} enabled".format(
1738
client_class = functools.partial(ClientDBus, bus = bus)
1739
def client_config_items(config, section):
1740
special_settings = {
1741
"approve_by_default":
1742
lambda: config.getboolean(section,
1743
"approve_by_default"),
1745
for name, value in config.items(section):
3359
client["secret"] = pgp.decrypt(
3360
client["encrypted_secret"],
3361
client_settings[client_name]["secret"])
3363
# If decryption fails, we use secret from new settings
3364
logger.debug("Failed to decrypt {} old secret".format(
3366
client["secret"] = (client_settings[client_name]
3369
# Add/remove clients based on new changes made to config
3370
for client_name in (set(old_client_settings)
3371
- set(client_settings)):
3372
del clients_data[client_name]
3373
for client_name in (set(client_settings)
3374
- set(old_client_settings)):
3375
clients_data[client_name] = client_settings[client_name]
3377
# Create all client objects
3378
for client_name, client in clients_data.items():
3379
tcp_server.clients[client_name] = client_class(
3382
server_settings=server_settings)
1747
yield special_settings[name]()
1751
tcp_server.clients.update(set(
1752
client_class(name = section,
1753
config= dict(client_config_items(
1754
client_config, section)))
1755
for section in client_config.sections()))
3384
1756
if not tcp_server.clients:
3385
logger.warning("No clients defined")
3388
if pidfile is not None:
1757
logger.warning(u"No clients defined")
1760
# Redirect stdin so all checkers get /dev/null
1761
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1762
os.dup2(null, sys.stdin.fileno())
1766
# No console logging
1767
logger.removeHandler(console)
1768
# Close all input and output, do double fork, etc.
3389
1773
pid = os.getpid()
3392
print(pid, file=pidfile)
3394
logger.error("Could not write to file %r with PID %d",
1774
pidfile.write(str(pid) + "\n")
3399
for termsig in (signal.SIGHUP, signal.SIGTERM):
3400
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3401
lambda: main_loop.quit() and False)
1777
logger.error(u"Could not write to file %r with PID %d",
1780
# "pidfile" was never created
1785
signal.signal(signal.SIGINT, signal.SIG_IGN)
1786
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1787
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3405
@alternate_dbus_interfaces(
3406
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3407
class MandosDBusService(DBusObjectWithObjectManager):
1790
class MandosDBusService(dbus.service.Object):
3408
1791
"""A D-Bus proxy object"""
3410
1792
def __init__(self):
3411
dbus.service.Object.__init__(self, bus, "/")
3413
_interface = "se.recompile.Mandos"
3415
@dbus.service.signal(_interface, signature="o")
1793
dbus.service.Object.__init__(self, bus, u"/")
1794
_interface = u"se.bsnet.fukt.Mandos"
1796
@dbus.service.signal(_interface, signature=u"o")
3416
1797
def ClientAdded(self, objpath):
3420
@dbus.service.signal(_interface, signature="ss")
3421
def ClientNotFound(self, key_id, address):
1801
@dbus.service.signal(_interface, signature=u"ss")
1802
def ClientNotFound(self, fingerprint, address):
3425
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3427
@dbus.service.signal(_interface, signature="os")
1806
@dbus.service.signal(_interface, signature=u"os")
3428
1807
def ClientRemoved(self, objpath, name):
3432
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3434
@dbus.service.method(_interface, out_signature="ao")
1811
@dbus.service.method(_interface, out_signature=u"ao")
3435
1812
def GetAllClients(self):
3437
return dbus.Array(c.dbus_object_path for c in
3438
tcp_server.clients.values())
3440
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1814
return dbus.Array(c.dbus_object_path
1815
for c in tcp_server.clients)
3442
1817
@dbus.service.method(_interface,
3443
out_signature="a{oa{sv}}")
1818
out_signature=u"a{oa{sv}}")
3444
1819
def GetAllClientsWithProperties(self):
3446
1821
return dbus.Dictionary(
3447
{c.dbus_object_path: c.GetAll(
3448
"se.recompile.Mandos.Client")
3449
for c in tcp_server.clients.values()},
3452
@dbus.service.method(_interface, in_signature="o")
1822
((c.dbus_object_path, c.GetAll(u""))
1823
for c in tcp_server.clients),
1824
signature=u"oa{sv}")
1826
@dbus.service.method(_interface, in_signature=u"o")
3453
1827
def RemoveClient(self, object_path):
3455
for c in tcp_server.clients.values():
1829
for c in tcp_server.clients:
3456
1830
if c.dbus_object_path == object_path:
3457
del tcp_server.clients[c.name]
1831
tcp_server.clients.remove(c)
3458
1832
c.remove_from_connection()
3459
# Don't signal the disabling
1833
# Don't signal anything except ClientRemoved
3460
1834
c.disable(quiet=True)
3461
# Emit D-Bus signal for removal
3462
self.client_removed_signal(c)
1836
self.ClientRemoved(object_path, c.name)
3464
1838
raise KeyError(object_path)
3468
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3469
out_signature="a{oa{sa{sv}}}")
3470
def GetManagedObjects(self):
3472
return dbus.Dictionary(
3473
{client.dbus_object_path:
3475
{interface: client.GetAll(interface)
3477
client._get_all_interface_names()})
3478
for client in tcp_server.clients.values()})
3480
def client_added_signal(self, client):
3481
"""Send the new standard signal and the old signal"""
3483
# New standard signal
3484
self.InterfacesAdded(
3485
client.dbus_object_path,
3487
{interface: client.GetAll(interface)
3489
client._get_all_interface_names()}))
3491
self.ClientAdded(client.dbus_object_path)
3493
def client_removed_signal(self, client):
3494
"""Send the new standard signal and the old signal"""
3496
# New standard signal
3497
self.InterfacesRemoved(
3498
client.dbus_object_path,
3499
client._get_all_interface_names())
3501
self.ClientRemoved(client.dbus_object_path,
3504
1842
mandos_dbus_service = MandosDBusService()
3506
# Save modules to variables to exempt the modules from being
3507
# unloaded before the function registered with atexit() is run.
3508
mp = multiprocessing
3512
1845
"Cleanup function; run on exit"
3516
mp.active_children()
3518
if not (tcp_server.clients or client_settings):
3521
# Store client before exiting. Secrets are encrypted with key
3522
# based on what config file has. If config file is
3523
# removed/edited, old secret will thus be unrecovable.
3525
with PGPEngine() as pgp:
3526
for client in tcp_server.clients.values():
3527
key = client_settings[client.name]["secret"]
3528
client.encrypted_secret = pgp.encrypt(client.secret,
3532
# A list of attributes that can not be pickled
3534
exclude = {"bus", "changedstate", "secret",
3535
"checker", "server_settings"}
3536
for name, typ in inspect.getmembers(dbus.service
3540
client_dict["encrypted_secret"] = (client
3542
for attr in client.client_structure:
3543
if attr not in exclude:
3544
client_dict[attr] = getattr(client, attr)
3546
clients[client.name] = client_dict
3547
del client_settings[client.name]["secret"]
3550
with tempfile.NamedTemporaryFile(
3554
dir=os.path.dirname(stored_state_path),
3555
delete=False) as stored_state:
3556
pickle.dump((clients, client_settings), stored_state,
3558
tempname = stored_state.name
3559
os.rename(tempname, stored_state_path)
3560
except (IOError, OSError) as e:
3566
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3567
logger.warning("Could not save persistent state: {}"
3568
.format(os.strerror(e.errno)))
3570
logger.warning("Could not save persistent state:",
3574
# Delete all clients, and settings from config
3575
1848
while tcp_server.clients:
3576
name, client = tcp_server.clients.popitem()
1849
client = tcp_server.clients.pop()
3578
1851
client.remove_from_connection()
3579
# Don't signal the disabling
1852
client.disable_hook = None
1853
# Don't signal anything except ClientRemoved
3580
1854
client.disable(quiet=True)
3581
# Emit D-Bus signal for removal
3583
mandos_dbus_service.client_removed_signal(client)
3584
client_settings.clear()
1857
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3586
1860
atexit.register(cleanup)
3588
for client in tcp_server.clients.values():
1862
for client in tcp_server.clients:
3590
# Emit D-Bus signal for adding
3591
mandos_dbus_service.client_added_signal(client)
3592
# Need to initiate checking of clients
3594
client.init_checker()
1865
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3596
1868
tcp_server.enable()
3597
1869
tcp_server.server_activate()
3599
1871
# Find out what port we got
3601
service.port = tcp_server.socket.getsockname()[1]
1872
service.port = tcp_server.socket.getsockname()[1]
3603
logger.info("Now listening on address %r, port %d,"
3604
" flowinfo %d, scope_id %d",
3605
*tcp_server.socket.getsockname())
1874
logger.info(u"Now listening on address %r, port %d,"
1875
" flowinfo %d, scope_id %d"
1876
% tcp_server.socket.getsockname())
3607
logger.info("Now listening on address %r, port %d",
3608
*tcp_server.socket.getsockname())
3610
# service.interface = tcp_server.socket.getsockname()[3]
1878
logger.info(u"Now listening on address %r, port %d"
1879
% tcp_server.socket.getsockname())
1881
#service.interface = tcp_server.socket.getsockname()[3]
3614
# From the Avahi example code
3617
except dbus.exceptions.DBusException as error:
3618
logger.critical("D-Bus Exception", exc_info=error)
3621
# End of Avahi example code
3624
GLib.IOChannel.unix_new(tcp_server.fileno()),
3625
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3626
lambda *args, **kwargs: (tcp_server.handle_request
3627
(*args[2:], **kwargs) or True))
3629
logger.debug("Starting main loop")
1884
# From the Avahi example code
1887
except dbus.exceptions.DBusException, error:
1888
logger.critical(u"DBusException: %s", error)
1891
# End of Avahi example code
1893
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1894
lambda *args, **kwargs:
1895
(tcp_server.handle_request
1896
(*args[2:], **kwargs) or True))
1898
logger.debug(u"Starting main loop")
3630
1899
main_loop.run()
3631
except AvahiError as error:
3632
logger.critical("Avahi Error", exc_info=error)
1900
except AvahiError, error:
1901
logger.critical(u"AvahiError: %s", error)
3635
1904
except KeyboardInterrupt:
3637
print("", file=sys.stderr)
3638
logger.debug("Server received KeyboardInterrupt")
3639
logger.debug("Server exiting")
1907
logger.debug(u"Server received KeyboardInterrupt")
1908
logger.debug(u"Server exiting")
3640
1909
# Must run before the D-Bus bus name gets deregistered
3644
def should_only_run_tests():
3645
parser = argparse.ArgumentParser(add_help=False)
3646
parser.add_argument("--check", action='store_true')
3647
args, unknown_args = parser.parse_known_args()
3648
run_tests = args.check
3650
# Remove --check argument from sys.argv
3651
sys.argv[1:] = unknown_args
3654
# Add all tests from doctest strings
3655
def load_tests(loader, tests, none):
3657
tests.addTests(doctest.DocTestSuite())
3660
1912
if __name__ == '__main__':
3662
if should_only_run_tests():
3663
# Call using ./mandos --check [--verbose]