432
193
dbus.UInt16(self.port),
433
194
avahi.string_array_to_txt_array(self.TXT))
434
195
self.group.Commit()
436
196
def entry_group_state_changed(self, state, error):
437
197
"""Derived from the Avahi example code"""
438
logger.debug("Avahi entry group state change: %i", state)
198
logger.debug(u"Avahi state change: %i", state)
440
200
if state == avahi.ENTRY_GROUP_ESTABLISHED:
441
logger.debug("Zeroconf service established.")
201
logger.debug(u"Zeroconf service established.")
442
202
elif state == avahi.ENTRY_GROUP_COLLISION:
443
logger.info("Zeroconf service name collision.")
203
logger.warning(u"Zeroconf service name collision.")
445
205
elif state == avahi.ENTRY_GROUP_FAILURE:
446
logger.critical("Avahi: Error in group state changed %s",
448
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"
450
210
def cleanup(self):
451
211
"""Derived from the Avahi example code"""
452
212
if self.group is not None:
455
except (dbus.exceptions.UnknownMethodException,
456
dbus.exceptions.DBusException):
458
214
self.group = None
461
def server_state_changed(self, state, error=None):
215
def server_state_changed(self, state):
462
216
"""Derived from the Avahi example code"""
463
logger.debug("Avahi server state change: %i", state)
465
avahi.SERVER_INVALID: "Zeroconf server invalid",
466
avahi.SERVER_REGISTERING: None,
467
avahi.SERVER_COLLISION: "Zeroconf server name collision",
468
avahi.SERVER_FAILURE: "Zeroconf server failure",
470
if state in bad_states:
471
if bad_states[state] is not None:
473
logger.error(bad_states[state])
475
logger.error(bad_states[state] + ": %r", error)
217
if state == avahi.SERVER_COLLISION:
218
logger.error(u"Zeroconf server name collision")
477
220
elif state == avahi.SERVER_RUNNING:
480
except dbus.exceptions.DBusException as error:
481
if (error.get_dbus_name()
482
== "org.freedesktop.Avahi.CollisionError"):
483
logger.info("Local Zeroconf service name"
485
return self.rename(remove=False)
487
logger.critical("D-Bus Exception", exc_info=error)
492
logger.debug("Unknown state: %r", state)
494
logger.debug("Unknown state: %r: %r", state, error)
496
222
def activate(self):
497
223
"""Derived from the Avahi example code"""
498
224
if self.server is None:
499
225
self.server = dbus.Interface(
500
226
self.bus.get_object(avahi.DBUS_NAME,
501
avahi.DBUS_PATH_SERVER,
502
follow_name_owner_changes=True),
227
avahi.DBUS_PATH_SERVER),
503
228
avahi.DBUS_INTERFACE_SERVER)
504
self.server.connect_to_signal("StateChanged",
505
self.server_state_changed)
229
self.server.connect_to_signal(u"StateChanged",
230
self.server_state_changed)
506
231
self.server_state_changed(self.server.GetState())
509
class AvahiServiceToSyslog(AvahiService):
510
def rename(self, *args, **kwargs):
511
"""Add the new name to the syslog messages"""
512
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
513
syslogger.setFormatter(logging.Formatter(
514
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
519
# Pretend that we have a GnuTLS module
521
"""This isn't so much a class as it is a module-like namespace."""
523
library = ctypes.util.find_library("gnutls")
525
library = ctypes.util.find_library("gnutls-deb0")
526
_library = ctypes.cdll.LoadLibrary(library)
529
# Unless otherwise indicated, the constants and types below are
530
# all from the gnutls/gnutls.h C header file.
541
E_NO_CERTIFICATE_FOUND = -49
546
KEYID_USE_SHA256 = 1 # gnutls/x509.h
547
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
550
class session_int(ctypes.Structure):
552
session_t = ctypes.POINTER(session_int)
554
class certificate_credentials_st(ctypes.Structure):
556
certificate_credentials_t = ctypes.POINTER(
557
certificate_credentials_st)
558
certificate_type_t = ctypes.c_int
560
class datum_t(ctypes.Structure):
561
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
562
('size', ctypes.c_uint)]
564
class openpgp_crt_int(ctypes.Structure):
566
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
567
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
568
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
569
credentials_type_t = ctypes.c_int
570
transport_ptr_t = ctypes.c_void_p
571
close_request_t = ctypes.c_int
574
class Error(Exception):
575
def __init__(self, message=None, code=None, args=()):
576
# Default usage is by a message string, but if a return
577
# code is passed, convert it to a string with
580
if message is None and code is not None:
581
message = gnutls.strerror(code)
582
return super(gnutls.Error, self).__init__(
585
class CertificateSecurityError(Error):
591
self._c_object = gnutls.certificate_credentials_t()
592
gnutls.certificate_allocate_credentials(
593
ctypes.byref(self._c_object))
594
self.type = gnutls.CRD_CERTIFICATE
597
gnutls.certificate_free_credentials(self._c_object)
600
def __init__(self, socket, credentials=None):
601
self._c_object = gnutls.session_t()
602
gnutls_flags = gnutls.CLIENT
603
if gnutls.check_version(b"3.5.6"):
604
gnutls_flags |= gnutls.NO_TICKETS
606
gnutls_flags |= gnutls.ENABLE_RAWPK
607
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
609
gnutls.set_default_priority(self._c_object)
610
gnutls.transport_set_ptr(self._c_object, socket.fileno())
611
gnutls.handshake_set_private_extensions(self._c_object,
614
if credentials is None:
615
credentials = gnutls.Credentials()
616
gnutls.credentials_set(self._c_object, credentials.type,
617
ctypes.cast(credentials._c_object,
619
self.credentials = credentials
622
gnutls.deinit(self._c_object)
625
return gnutls.handshake(self._c_object)
627
def send(self, data):
631
data_len -= gnutls.record_send(self._c_object,
636
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
638
# Error handling functions
639
def _error_code(result):
640
"""A function to raise exceptions on errors, suitable
641
for the 'restype' attribute on ctypes functions"""
644
if result == gnutls.E_NO_CERTIFICATE_FOUND:
645
raise gnutls.CertificateSecurityError(code=result)
646
raise gnutls.Error(code=result)
648
def _retry_on_error(result, func, arguments):
649
"""A function to retry on some errors, suitable
650
for the 'errcheck' attribute on ctypes functions"""
652
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
653
return _error_code(result)
654
result = func(*arguments)
657
# Unless otherwise indicated, the function declarations below are
658
# all from the gnutls/gnutls.h C header file.
661
priority_set_direct = _library.gnutls_priority_set_direct
662
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
663
ctypes.POINTER(ctypes.c_char_p)]
664
priority_set_direct.restype = _error_code
666
init = _library.gnutls_init
667
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
668
init.restype = _error_code
670
set_default_priority = _library.gnutls_set_default_priority
671
set_default_priority.argtypes = [session_t]
672
set_default_priority.restype = _error_code
674
record_send = _library.gnutls_record_send
675
record_send.argtypes = [session_t, ctypes.c_void_p,
677
record_send.restype = ctypes.c_ssize_t
678
record_send.errcheck = _retry_on_error
680
certificate_allocate_credentials = (
681
_library.gnutls_certificate_allocate_credentials)
682
certificate_allocate_credentials.argtypes = [
683
ctypes.POINTER(certificate_credentials_t)]
684
certificate_allocate_credentials.restype = _error_code
686
certificate_free_credentials = (
687
_library.gnutls_certificate_free_credentials)
688
certificate_free_credentials.argtypes = [
689
certificate_credentials_t]
690
certificate_free_credentials.restype = None
692
handshake_set_private_extensions = (
693
_library.gnutls_handshake_set_private_extensions)
694
handshake_set_private_extensions.argtypes = [session_t,
696
handshake_set_private_extensions.restype = None
698
credentials_set = _library.gnutls_credentials_set
699
credentials_set.argtypes = [session_t, credentials_type_t,
701
credentials_set.restype = _error_code
703
strerror = _library.gnutls_strerror
704
strerror.argtypes = [ctypes.c_int]
705
strerror.restype = ctypes.c_char_p
707
certificate_type_get = _library.gnutls_certificate_type_get
708
certificate_type_get.argtypes = [session_t]
709
certificate_type_get.restype = _error_code
711
certificate_get_peers = _library.gnutls_certificate_get_peers
712
certificate_get_peers.argtypes = [session_t,
713
ctypes.POINTER(ctypes.c_uint)]
714
certificate_get_peers.restype = ctypes.POINTER(datum_t)
716
global_set_log_level = _library.gnutls_global_set_log_level
717
global_set_log_level.argtypes = [ctypes.c_int]
718
global_set_log_level.restype = None
720
global_set_log_function = _library.gnutls_global_set_log_function
721
global_set_log_function.argtypes = [log_func]
722
global_set_log_function.restype = None
724
deinit = _library.gnutls_deinit
725
deinit.argtypes = [session_t]
726
deinit.restype = None
728
handshake = _library.gnutls_handshake
729
handshake.argtypes = [session_t]
730
handshake.restype = _error_code
731
handshake.errcheck = _retry_on_error
733
transport_set_ptr = _library.gnutls_transport_set_ptr
734
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
735
transport_set_ptr.restype = None
737
bye = _library.gnutls_bye
738
bye.argtypes = [session_t, close_request_t]
739
bye.restype = _error_code
740
bye.errcheck = _retry_on_error
742
check_version = _library.gnutls_check_version
743
check_version.argtypes = [ctypes.c_char_p]
744
check_version.restype = ctypes.c_char_p
746
_need_version = b"3.3.0"
747
if check_version(_need_version) is None:
748
raise self.Error("Needs GnuTLS {} or later"
749
.format(_need_version))
751
_tls_rawpk_version = b"3.6.6"
752
has_rawpk = bool(check_version(_tls_rawpk_version))
756
class pubkey_st(ctypes.Structure):
758
pubkey_t = ctypes.POINTER(pubkey_st)
760
x509_crt_fmt_t = ctypes.c_int
762
# All the function declarations below are from gnutls/abstract.h
763
pubkey_init = _library.gnutls_pubkey_init
764
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
765
pubkey_init.restype = _error_code
767
pubkey_import = _library.gnutls_pubkey_import
768
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
770
pubkey_import.restype = _error_code
772
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
773
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
774
ctypes.POINTER(ctypes.c_ubyte),
775
ctypes.POINTER(ctypes.c_size_t)]
776
pubkey_get_key_id.restype = _error_code
778
pubkey_deinit = _library.gnutls_pubkey_deinit
779
pubkey_deinit.argtypes = [pubkey_t]
780
pubkey_deinit.restype = None
782
# All the function declarations below are from gnutls/openpgp.h
784
openpgp_crt_init = _library.gnutls_openpgp_crt_init
785
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
786
openpgp_crt_init.restype = _error_code
788
openpgp_crt_import = _library.gnutls_openpgp_crt_import
789
openpgp_crt_import.argtypes = [openpgp_crt_t,
790
ctypes.POINTER(datum_t),
792
openpgp_crt_import.restype = _error_code
794
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
795
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
796
ctypes.POINTER(ctypes.c_uint)]
797
openpgp_crt_verify_self.restype = _error_code
799
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
800
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
801
openpgp_crt_deinit.restype = None
803
openpgp_crt_get_fingerprint = (
804
_library.gnutls_openpgp_crt_get_fingerprint)
805
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
809
openpgp_crt_get_fingerprint.restype = _error_code
811
if check_version(b"3.6.4"):
812
certificate_type_get2 = _library.gnutls_certificate_type_get2
813
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
814
certificate_type_get2.restype = _error_code
816
# Remove non-public functions
817
del _error_code, _retry_on_error
820
def call_pipe(connection, # : multiprocessing.Connection
821
func, *args, **kwargs):
822
"""This function is meant to be called by multiprocessing.Process
824
This function runs func(*args, **kwargs), and writes the resulting
825
return value on the provided multiprocessing.Connection.
827
connection.send(func(*args, **kwargs))
234
class Client(object):
832
235
"""A representation of a client host served by this server.
835
approved: bool(); 'None' if not yet approved/disapproved
836
approval_delay: datetime.timedelta(); Time to wait for approval
837
approval_duration: datetime.timedelta(); Duration of one approval
838
checker: multiprocessing.Process(); a running checker process used
839
to see if the client lives. 'None' if no process is
841
checker_callback_tag: a GLib event source tag, or None
842
checker_command: string; External command which is run to check
843
if client lives. %() expansions are done at
844
runtime with vars(self) as dict, so that for
845
instance %(name)s can be used in the command.
846
checker_initiator_tag: a GLib event source tag, or None
238
name: string; from the config file, used in log messages and
240
fingerprint: string (40 or 32 hexadecimal digits); used to
241
uniquely identify the client
242
secret: bytestring; sent verbatim (over TLS) to client
243
host: string; available for use by the checker command
847
244
created: datetime.datetime(); (UTC) object creation
848
client_structure: Object describing what attributes a client has
849
and is used for storing the client at exit
850
current_checker_command: string; current running checker_command
851
disable_initiator_tag: a GLib event source tag, or None
245
last_enabled: datetime.datetime(); (UTC)
853
fingerprint: string (40 or 32 hexadecimal digits); used to
854
uniquely identify an OpenPGP client
855
key_id: string (64 hexadecimal digits); used to uniquely identify
856
a client using raw public keys
857
host: string; available for use by the checker command
858
interval: datetime.timedelta(); How often to start a new checker
859
last_approval_request: datetime.datetime(); (UTC) or None
860
247
last_checked_ok: datetime.datetime(); (UTC) or None
861
last_checker_status: integer between 0 and 255 reflecting exit
862
status of last checker. -1 reflects crashed
863
checker, -2 means no checker completed yet.
864
last_checker_signal: The signal which killed the last checker, if
865
last_checker_status is -1
866
last_enabled: datetime.datetime(); (UTC) or None
867
name: string; from the config file, used in log messages and
869
secret: bytestring; sent verbatim (over TLS) to client
870
248
timeout: datetime.timedelta(); How long from last_checked_ok
871
249
until this client is disabled
872
extended_timeout: extra long timeout when secret has been sent
873
runtime_expansions: Allowed attributes for runtime expansion.
874
expires: datetime.datetime(); time (UTC) when a client will be
876
server_settings: The server_settings dict from main()
250
interval: datetime.timedelta(); How often to start a new checker
251
disable_hook: If set, called by disable() as disable_hook(self)
252
checker: subprocess.Popen(); a running checker process used
253
to see if the client lives.
254
'None' if no process is running.
255
checker_initiator_tag: a gobject event source tag, or None
256
disable_initiator_tag: - '' -
257
checker_callback_tag: - '' -
258
checker_command: string; External command which is run to check if
259
client lives. %() expansions are done at
260
runtime with vars(self) as dict, so that for
261
instance %(name)s can be used in the command.
262
current_checker_command: string; current running checker_command
263
approved_delay: datetime.timedelta(); Time to wait for approval
264
_approved: bool(); 'None' if not yet approved/disapproved
265
approved_duration: datetime.timedelta(); Duration of one approval
879
runtime_expansions = ("approval_delay", "approval_duration",
880
"created", "enabled", "expires", "key_id",
881
"fingerprint", "host", "interval",
882
"last_approval_request", "last_checked_ok",
883
"last_enabled", "name", "timeout")
886
"extended_timeout": "PT15M",
888
"checker": "fping -q -- %%(host)s",
890
"approval_delay": "PT0S",
891
"approval_duration": "PT1S",
892
"approved_by_default": "True",
897
def config_parser(config):
898
"""Construct a new dict of client settings of this form:
899
{ client_name: {setting_name: value, ...}, ...}
900
with exceptions for any special settings as defined above.
901
NOTE: Must be a pure function. Must return the same result
902
value given the same arguments.
905
for client_name in config.sections():
906
section = dict(config.items(client_name))
907
client = settings[client_name] = {}
909
client["host"] = section["host"]
910
# Reformat values from string types to Python types
911
client["approved_by_default"] = config.getboolean(
912
client_name, "approved_by_default")
913
client["enabled"] = config.getboolean(client_name,
916
# Uppercase and remove spaces from key_id and fingerprint
917
# for later comparison purposes with return value from the
918
# key_id() and fingerprint() functions
919
client["key_id"] = (section.get("key_id", "").upper()
921
client["fingerprint"] = (section["fingerprint"].upper()
923
if "secret" in section:
924
client["secret"] = codecs.decode(section["secret"]
927
elif "secfile" in section:
928
with open(os.path.expanduser(os.path.expandvars
929
(section["secfile"])),
931
client["secret"] = secfile.read()
933
raise TypeError("No secret or secfile for section {}"
935
client["timeout"] = string_to_delta(section["timeout"])
936
client["extended_timeout"] = string_to_delta(
937
section["extended_timeout"])
938
client["interval"] = string_to_delta(section["interval"])
939
client["approval_delay"] = string_to_delta(
940
section["approval_delay"])
941
client["approval_duration"] = string_to_delta(
942
section["approval_duration"])
943
client["checker_command"] = section["checker"]
944
client["last_approval_request"] = None
945
client["last_checked_ok"] = None
946
client["last_checker_status"] = -2
950
def __init__(self, settings, name=None, server_settings=None):
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
275
def timeout_milliseconds(self):
276
"Return the 'timeout' attribute in milliseconds"
277
return self._timedelta_to_milliseconds(self.timeout)
279
def interval_milliseconds(self):
280
"Return the 'interval' attribute in milliseconds"
281
return self._timedelta_to_milliseconds(self.interval)
283
def approved_delay_milliseconds(self):
284
return self._timedelta_to_milliseconds(self.approved_delay)
286
def __init__(self, name = None, disable_hook=None, config=None):
287
"""Note: the 'checker' key in 'config' sets the
288
'checker_command' attribute and *not* the 'checker'
952
if server_settings is None:
954
self.server_settings = server_settings
955
# adding all client settings
956
for setting, value in settings.items():
957
setattr(self, setting, value)
960
if not hasattr(self, "last_enabled"):
961
self.last_enabled = datetime.datetime.utcnow()
962
if not hasattr(self, "expires"):
963
self.expires = (datetime.datetime.utcnow()
293
logger.debug(u"Creating client %r", self.name)
294
# Uppercase and remove spaces from fingerprint for later
295
# comparison purposes with return value from the fingerprint()
297
self.fingerprint = (config[u"fingerprint"].upper()
299
logger.debug(u" Fingerprint: %s", self.fingerprint)
300
if u"secret" in config:
301
self.secret = config[u"secret"].decode(u"base64")
302
elif u"secfile" in config:
303
with open(os.path.expanduser(os.path.expandvars
304
(config[u"secfile"])),
306
self.secret = secfile.read()
966
self.last_enabled = None
969
logger.debug("Creating client %r", self.name)
970
logger.debug(" Key ID: %s", self.key_id)
971
logger.debug(" Fingerprint: %s", self.fingerprint)
972
self.created = settings.get("created",
973
datetime.datetime.utcnow())
975
# attributes specific for this server instance
308
#XXX Need to allow secret on demand!
309
raise TypeError(u"No secret or secfile for client %s"
311
self.host = config.get(u"host", u"")
312
self.created = datetime.datetime.utcnow()
314
self.last_enabled = None
315
self.last_checked_ok = None
316
self.timeout = string_to_delta(config[u"timeout"])
317
self.interval = string_to_delta(config[u"interval"])
318
self.disable_hook = disable_hook
976
319
self.checker = None
977
320
self.checker_initiator_tag = None
978
321
self.disable_initiator_tag = None
979
322
self.checker_callback_tag = None
323
self.checker_command = config[u"checker"]
980
324
self.current_checker_command = None
325
self.last_connect = None
982
326
self.approvals_pending = 0
983
self.changedstate = multiprocessing_manager.Condition(
984
multiprocessing_manager.Lock())
985
self.client_structure = [attr
986
for attr in self.__dict__.keys()
987
if not attr.startswith("_")]
988
self.client_structure.append("client_structure")
990
for name, t in inspect.getmembers(
991
type(self), lambda obj: isinstance(obj, property)):
992
if not name.startswith("_"):
993
self.client_structure.append(name)
995
# Send notice to process children that client state has changed
327
self._approved = None
328
self.approved_by_default = config.get(u"approved_by_default",
330
self.approved_delay = string_to_delta(
331
config[u"approved_delay"])
332
self.approved_duration = string_to_delta(
333
config[u"approved_duration"])
334
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
996
336
def send_changedstate(self):
997
with self.changedstate:
998
self.changedstate.notify_all()
337
self.changedstate.acquire()
338
self.changedstate.notify_all()
339
self.changedstate.release()
1000
341
def enable(self):
1001
342
"""Start this client's checker and timeout hooks"""
1002
if getattr(self, "enabled", False):
343
if getattr(self, u"enabled", False):
1003
344
# Already enabled
1005
self.expires = datetime.datetime.utcnow() + self.timeout
346
self.send_changedstate()
1007
347
self.last_enabled = datetime.datetime.utcnow()
1009
self.send_changedstate()
348
# Schedule a new checker to be started an 'interval' from now,
349
# and every interval from then on.
350
self.checker_initiator_tag = (gobject.timeout_add
351
(self.interval_milliseconds(),
353
# Schedule a disable() when 'timeout' has passed
354
self.disable_initiator_tag = (gobject.timeout_add
355
(self.timeout_milliseconds(),
358
# Also start a new checker *right now*.
1011
361
def disable(self, quiet=True):
1012
362
"""Disable this client."""
1013
363
if not getattr(self, "enabled", False):
1016
logger.info("Disabling client %s", self.name)
1017
if getattr(self, "disable_initiator_tag", None) is not None:
1018
GLib.source_remove(self.disable_initiator_tag)
366
self.send_changedstate()
368
logger.info(u"Disabling client %s", self.name)
369
if getattr(self, u"disable_initiator_tag", False):
370
gobject.source_remove(self.disable_initiator_tag)
1019
371
self.disable_initiator_tag = None
1021
if getattr(self, "checker_initiator_tag", None) is not None:
1022
GLib.source_remove(self.checker_initiator_tag)
372
if getattr(self, u"checker_initiator_tag", False):
373
gobject.source_remove(self.checker_initiator_tag)
1023
374
self.checker_initiator_tag = None
1024
375
self.stop_checker()
376
if self.disable_hook:
377
self.disable_hook(self)
1025
378
self.enabled = False
1027
self.send_changedstate()
1028
# Do not run this again if called by a GLib.timeout_add
379
# Do not run this again if called by a gobject.timeout_add
1031
382
def __del__(self):
383
self.disable_hook = None
1034
def init_checker(self):
1035
# Schedule a new checker to be started an 'interval' from now,
1036
# and every interval from then on.
1037
if self.checker_initiator_tag is not None:
1038
GLib.source_remove(self.checker_initiator_tag)
1039
self.checker_initiator_tag = GLib.timeout_add(
1040
int(self.interval.total_seconds() * 1000),
1042
# Schedule a disable() when 'timeout' has passed
1043
if self.disable_initiator_tag is not None:
1044
GLib.source_remove(self.disable_initiator_tag)
1045
self.disable_initiator_tag = GLib.timeout_add(
1046
int(self.timeout.total_seconds() * 1000), self.disable)
1047
# Also start a new checker *right now*.
1048
self.start_checker()
1050
def checker_callback(self, source, condition, connection,
386
def checker_callback(self, pid, condition, command):
1052
387
"""The checker has completed, so take appropriate actions."""
1053
# Read return code from connection (see call_pipe)
1054
returncode = connection.recv()
1056
if self.checker is not None:
1058
388
self.checker_callback_tag = None
1059
389
self.checker = None
1062
self.last_checker_status = returncode
1063
self.last_checker_signal = None
1064
if self.last_checker_status == 0:
1065
logger.info("Checker for %(name)s succeeded",
390
if os.WIFEXITED(condition):
391
exitstatus = os.WEXITSTATUS(condition)
393
logger.info(u"Checker for %(name)s succeeded",
1067
395
self.checked_ok()
1069
logger.info("Checker for %(name)s failed", vars(self))
397
logger.info(u"Checker for %(name)s failed",
1071
self.last_checker_status = -1
1072
self.last_checker_signal = -returncode
1073
logger.warning("Checker for %(name)s crashed?",
400
logger.warning(u"Checker for %(name)s crashed?",
1077
403
def checked_ok(self):
1078
"""Assert that the client has been seen, alive and well."""
404
"""Bump up the timeout for this client.
406
This should only be called when the client has been seen,
1079
409
self.last_checked_ok = datetime.datetime.utcnow()
1080
self.last_checker_status = 0
1081
self.last_checker_signal = None
1084
def bump_timeout(self, timeout=None):
1085
"""Bump up the timeout for this client."""
1087
timeout = self.timeout
1088
if self.disable_initiator_tag is not None:
1089
GLib.source_remove(self.disable_initiator_tag)
1090
self.disable_initiator_tag = None
1091
if getattr(self, "enabled", False):
1092
self.disable_initiator_tag = GLib.timeout_add(
1093
int(timeout.total_seconds() * 1000), self.disable)
1094
self.expires = datetime.datetime.utcnow() + timeout
1096
def need_approval(self):
1097
self.last_approval_request = datetime.datetime.utcnow()
410
gobject.source_remove(self.disable_initiator_tag)
411
self.disable_initiator_tag = (gobject.timeout_add
412
(self.timeout_milliseconds(),
1099
415
def start_checker(self):
1100
416
"""Start a new checker subprocess if one is not running.
1102
418
If a checker already exists, leave it running and do
1104
420
# The reason for not killing a running checker is that if we
1105
# did that, and if a checker (for some reason) started running
1106
# slowly and taking more than 'interval' time, then the client
1107
# would inevitably timeout, since no checker would get a
1108
# chance to run to completion. If we instead leave running
421
# did that, then if a checker (for some reason) started
422
# running slowly and taking more than 'interval' time, the
423
# client would inevitably timeout, since no checker would get
424
# a chance to run to completion. If we instead leave running
1109
425
# checkers alone, the checker would have to take more time
1110
426
# than 'timeout' for the client to be disabled, which is as it
1113
if self.checker is not None and not self.checker.is_alive():
1114
logger.warning("Checker was not alive; joining")
429
# If a checker exists, make sure it is not a zombie
431
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
432
except (AttributeError, OSError), error:
433
if (isinstance(error, OSError)
434
and error.errno != errno.ECHILD):
438
logger.warning(u"Checker was a zombie")
439
gobject.source_remove(self.checker_callback_tag)
440
self.checker_callback(pid, status,
441
self.current_checker_command)
1117
442
# Start a new checker if needed
1118
443
if self.checker is None:
1119
# Escape attributes for the shell
1121
attr: re.escape(str(getattr(self, attr)))
1122
for attr in self.runtime_expansions}
1124
command = self.checker_command % escaped_attrs
1125
except TypeError as error:
1126
logger.error('Could not format string "%s"',
1127
self.checker_command,
1129
return True # Try again later
445
# In case checker_command has exactly one % operator
446
command = self.checker_command % self.host
448
# Escape attributes for the shell
449
escaped_attrs = dict((key,
450
re.escape(unicode(str(val),
454
vars(self).iteritems())
456
command = self.checker_command % escaped_attrs
457
except TypeError, error:
458
logger.error(u'Could not format string "%s":'
459
u' %s', self.checker_command, error)
460
return True # Try again later
1130
461
self.current_checker_command = command
1131
logger.info("Starting checker %r for %s", command,
1133
# We don't need to redirect stdout and stderr, since
1134
# in normal mode, that is already done by daemon(),
1135
# and in debug mode we don't want to. (Stdin is
1136
# always replaced by /dev/null.)
1137
# The exception is when not debugging but nevertheless
1138
# running in the foreground; use the previously
1140
popen_args = {"close_fds": True,
1143
if (not self.server_settings["debug"]
1144
and self.server_settings["foreground"]):
1145
popen_args.update({"stdout": wnull,
1147
pipe = multiprocessing.Pipe(duplex=False)
1148
self.checker = multiprocessing.Process(
1150
args=(pipe[1], subprocess.call, command),
1152
self.checker.start()
1153
self.checker_callback_tag = GLib.io_add_watch(
1154
GLib.IOChannel.unix_new(pipe[0].fileno()),
1155
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1156
self.checker_callback, pipe[0], command)
1157
# Re-run this periodically if run by GLib.timeout_add
463
logger.info(u"Starting checker %r for %s",
465
# We don't need to redirect stdout and stderr, since
466
# in normal mode, that is already done by daemon(),
467
# and in debug mode we don't want to. (Stdin is
468
# always replaced by /dev/null.)
469
self.checker = subprocess.Popen(command,
471
shell=True, cwd=u"/")
472
self.checker_callback_tag = (gobject.child_watch_add
474
self.checker_callback,
476
# The checker may have completed before the gobject
477
# watch was added. Check for this.
478
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
480
gobject.source_remove(self.checker_callback_tag)
481
self.checker_callback(pid, status, command)
482
except OSError, error:
483
logger.error(u"Failed to start subprocess: %s",
485
# Re-run this periodically if run by gobject.timeout_add
1160
488
def stop_checker(self):
1161
489
"""Force the checker process, if any, to stop."""
1162
490
if self.checker_callback_tag:
1163
GLib.source_remove(self.checker_callback_tag)
491
gobject.source_remove(self.checker_callback_tag)
1164
492
self.checker_callback_tag = None
1165
if getattr(self, "checker", None) is None:
493
if getattr(self, u"checker", None) is None:
1167
logger.debug("Stopping checker for %(name)s", vars(self))
1168
self.checker.terminate()
495
logger.debug(u"Stopping checker for %(name)s", vars(self))
497
os.kill(self.checker.pid, signal.SIGTERM)
499
#if self.checker.poll() is None:
500
# os.kill(self.checker.pid, signal.SIGKILL)
501
except OSError, error:
502
if error.errno != errno.ESRCH: # No such process
1169
504
self.checker = None
1172
def dbus_service_property(dbus_interface,
506
def dbus_service_property(dbus_interface, signature=u"v",
507
access=u"readwrite", byte_arrays=False):
1176
508
"""Decorators for marking methods of a DBusObjectWithProperties to
1177
509
become properties on the D-Bus.
1179
511
The decorated method will be called with no arguments by "Get"
1180
512
and with one argument by "Set".
1182
514
The parameters, where they are supported, are the same as
1183
515
dbus.service.method, except there is only "signature", since the
1184
516
type from Get() and the type sent to Set() is the same.
1186
518
# Encoding deeply encoded byte arrays is not supported yet by the
1187
519
# "Set" method, so we fail early here:
1188
if byte_arrays and signature != "ay":
1189
raise ValueError("Byte arrays not supported for non-'ay'"
1190
" signature {!r}".format(signature))
520
if byte_arrays and signature != u"ay":
521
raise ValueError(u"Byte arrays not supported for non-'ay'"
522
u" signature %r" % signature)
1192
523
def decorator(func):
1193
524
func._dbus_is_property = True
1194
525
func._dbus_interface = dbus_interface
1195
526
func._dbus_signature = signature
1196
527
func._dbus_access = access
1197
528
func._dbus_name = func.__name__
1198
if func._dbus_name.endswith("_dbus_property"):
529
if func._dbus_name.endswith(u"_dbus_property"):
1199
530
func._dbus_name = func._dbus_name[:-14]
1200
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1206
def dbus_interface_annotations(dbus_interface):
1207
"""Decorator for marking functions returning interface annotations
1211
@dbus_interface_annotations("org.example.Interface")
1212
def _foo(self): # Function name does not matter
1213
return {"org.freedesktop.DBus.Deprecated": "true",
1214
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1218
def decorator(func):
1219
func._dbus_is_interface = True
1220
func._dbus_interface = dbus_interface
1221
func._dbus_name = dbus_interface
1227
def dbus_annotations(annotations):
1228
"""Decorator to annotate D-Bus methods, signals or properties
1231
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1232
"org.freedesktop.DBus.Property."
1233
"EmitsChangedSignal": "false"})
1234
@dbus_service_property("org.example.Interface", signature="b",
1236
def Property_dbus_property(self):
1237
return dbus.Boolean(False)
1239
See also the DBusObjectWithAnnotations class.
1242
def decorator(func):
1243
func._dbus_annotations = annotations
531
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1246
533
return decorator
1249
536
class DBusPropertyException(dbus.exceptions.DBusException):
1250
537
"""A base class for D-Bus property-related exceptions
539
def __unicode__(self):
540
return unicode(str(self))
1255
543
class DBusPropertyAccessException(DBusPropertyException):
1267
class DBusObjectWithAnnotations(dbus.service.Object):
1268
"""A D-Bus object with annotations.
1270
Classes inheriting from this can use the dbus_annotations
1271
decorator to add annotations to methods or signals.
1275
def _is_dbus_thing(thing):
1276
"""Returns a function testing if an attribute is a D-Bus thing
1278
If called like _is_dbus_thing("method") it returns a function
1279
suitable for use as predicate to inspect.getmembers().
1281
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1284
def _get_all_dbus_things(self, thing):
1285
"""Returns a generator of (name, attribute) pairs
1287
return ((getattr(athing.__get__(self), "_dbus_name", name),
1288
athing.__get__(self))
1289
for cls in self.__class__.__mro__
1291
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1293
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1295
path_keyword='object_path',
1296
connection_keyword='connection')
1297
def Introspect(self, object_path, connection):
1298
"""Overloading of standard D-Bus method.
1300
Inserts annotation tags on methods and signals.
1302
xmlstring = dbus.service.Object.Introspect(self, object_path,
1305
document = xml.dom.minidom.parseString(xmlstring)
1307
for if_tag in document.getElementsByTagName("interface"):
1308
# Add annotation tags
1309
for typ in ("method", "signal"):
1310
for tag in if_tag.getElementsByTagName(typ):
1312
for name, prop in (self.
1313
_get_all_dbus_things(typ)):
1314
if (name == tag.getAttribute("name")
1315
and prop._dbus_interface
1316
== if_tag.getAttribute("name")):
1317
annots.update(getattr(
1318
prop, "_dbus_annotations", {}))
1319
for name, value in annots.items():
1320
ann_tag = document.createElement(
1322
ann_tag.setAttribute("name", name)
1323
ann_tag.setAttribute("value", value)
1324
tag.appendChild(ann_tag)
1325
# Add interface annotation tags
1326
for annotation, value in dict(
1327
itertools.chain.from_iterable(
1328
annotations().items()
1329
for name, annotations
1330
in self._get_all_dbus_things("interface")
1331
if name == if_tag.getAttribute("name")
1333
ann_tag = document.createElement("annotation")
1334
ann_tag.setAttribute("name", annotation)
1335
ann_tag.setAttribute("value", value)
1336
if_tag.appendChild(ann_tag)
1337
# Fix argument name for the Introspect method itself
1338
if (if_tag.getAttribute("name")
1339
== dbus.INTROSPECTABLE_IFACE):
1340
for cn in if_tag.getElementsByTagName("method"):
1341
if cn.getAttribute("name") == "Introspect":
1342
for arg in cn.getElementsByTagName("arg"):
1343
if (arg.getAttribute("direction")
1345
arg.setAttribute("name",
1347
xmlstring = document.toxml("utf-8")
1349
except (AttributeError, xml.dom.DOMException,
1350
xml.parsers.expat.ExpatError) as error:
1351
logger.error("Failed to override Introspection method",
1356
class DBusObjectWithProperties(DBusObjectWithAnnotations):
555
class DBusObjectWithProperties(dbus.service.Object):
1357
556
"""A D-Bus object with properties.
1359
558
Classes inheriting from this can use the dbus_service_property
1360
559
decorator to expose methods as D-Bus properties. It exposes the
1361
560
standard Get(), Set(), and GetAll() methods on the D-Bus.
564
def _is_dbus_property(obj):
565
return getattr(obj, u"_dbus_is_property", False)
567
def _get_all_dbus_properties(self):
568
"""Returns a generator of (name, attribute) pairs
570
return ((prop._dbus_name, prop)
572
inspect.getmembers(self, self._is_dbus_property))
1364
574
def _get_dbus_property(self, interface_name, property_name):
1365
575
"""Returns a bound method if one exists which is a D-Bus
1366
576
property with the specified name and interface.
1368
for cls in self.__class__.__mro__:
1369
for name, value in inspect.getmembers(
1370
cls, self._is_dbus_thing("property")):
1371
if (value._dbus_name == property_name
1372
and value._dbus_interface == interface_name):
1373
return value.__get__(self)
578
for name in (property_name,
579
property_name + u"_dbus_property"):
580
prop = getattr(self, name, None)
582
or not self._is_dbus_property(prop)
583
or prop._dbus_name != property_name
584
or (interface_name and prop._dbus_interface
585
and interface_name != prop._dbus_interface)):
1375
588
# No such property
1376
raise DBusPropertyNotFound("{}:{}.{}".format(
1377
self.dbus_object_path, interface_name, property_name))
1380
def _get_all_interface_names(cls):
1381
"""Get a sequence of all interfaces supported by an object"""
1382
return (name for name in set(getattr(getattr(x, attr),
1383
"_dbus_interface", None)
1384
for x in (inspect.getmro(cls))
1386
if name is not None)
1388
@dbus.service.method(dbus.PROPERTIES_IFACE,
589
raise DBusPropertyNotFound(self.dbus_object_path + u":"
590
+ interface_name + u"."
593
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1391
595
def Get(self, interface_name, property_name):
1392
596
"""Standard D-Bus property Get() method, see D-Bus standard.
1394
598
prop = self._get_dbus_property(interface_name, property_name)
1395
if prop._dbus_access == "write":
599
if prop._dbus_access == u"write":
1396
600
raise DBusPropertyAccessException(property_name)
1398
if not hasattr(value, "variant_level"):
602
if not hasattr(value, u"variant_level"):
1400
604
return type(value)(value, variant_level=value.variant_level+1)
1402
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
606
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1403
607
def Set(self, interface_name, property_name, value):
1404
608
"""Standard D-Bus property Set() method, see D-Bus standard.
1406
610
prop = self._get_dbus_property(interface_name, property_name)
1407
if prop._dbus_access == "read":
611
if prop._dbus_access == u"read":
1408
612
raise DBusPropertyAccessException(property_name)
1409
if prop._dbus_get_args_options["byte_arrays"]:
613
if prop._dbus_get_args_options[u"byte_arrays"]:
1410
614
# The byte_arrays option is not supported yet on
1411
615
# signatures other than "ay".
1412
if prop._dbus_signature != "ay":
1413
raise ValueError("Byte arrays not supported for non-"
1414
"'ay' signature {!r}"
1415
.format(prop._dbus_signature))
1416
value = dbus.ByteArray(b''.join(chr(byte)
616
if prop._dbus_signature != u"ay":
618
value = dbus.ByteArray(''.join(unichr(byte)
1420
@dbus.service.method(dbus.PROPERTIES_IFACE,
1422
out_signature="a{sv}")
622
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
623
out_signature=u"a{sv}")
1423
624
def GetAll(self, interface_name):
1424
625
"""Standard D-Bus property GetAll() method, see D-Bus
1427
628
Note: Will not include properties with access="write".
1430
for name, prop in self._get_all_dbus_things("property"):
631
for name, prop in self._get_all_dbus_properties():
1431
632
if (interface_name
1432
633
and interface_name != prop._dbus_interface):
1433
634
# Interface non-empty but did not match
1435
636
# Ignore write-only properties
1436
if prop._dbus_access == "write":
637
if prop._dbus_access == u"write":
1439
if not hasattr(value, "variant_level"):
1440
properties[name] = value
640
if not hasattr(value, u"variant_level"):
1442
properties[name] = type(value)(
1443
value, variant_level=value.variant_level + 1)
1444
return dbus.Dictionary(properties, signature="sv")
1446
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1447
def PropertiesChanged(self, interface_name, changed_properties,
1448
invalidated_properties):
1449
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
643
all[name] = type(value)(value, variant_level=
644
value.variant_level+1)
645
return dbus.Dictionary(all, signature=u"sv")
1454
647
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1456
649
path_keyword='object_path',
1457
650
connection_keyword='connection')
1458
651
def Introspect(self, object_path, connection):
1459
"""Overloading of standard D-Bus method.
1461
Inserts property tags and interface annotation tags.
652
"""Standard D-Bus method, overloaded to insert property tags.
1463
xmlstring = DBusObjectWithAnnotations.Introspect(self,
654
xmlstring = dbus.service.Object.Introspect(self, object_path,
1467
657
document = xml.dom.minidom.parseString(xmlstring)
1469
658
def make_tag(document, name, prop):
1470
e = document.createElement("property")
1471
e.setAttribute("name", name)
1472
e.setAttribute("type", prop._dbus_signature)
1473
e.setAttribute("access", prop._dbus_access)
659
e = document.createElement(u"property")
660
e.setAttribute(u"name", name)
661
e.setAttribute(u"type", prop._dbus_signature)
662
e.setAttribute(u"access", prop._dbus_access)
1476
for if_tag in document.getElementsByTagName("interface"):
664
for if_tag in document.getElementsByTagName(u"interface"):
1478
665
for tag in (make_tag(document, name, prop)
1480
in self._get_all_dbus_things("property")
667
in self._get_all_dbus_properties()
1481
668
if prop._dbus_interface
1482
== if_tag.getAttribute("name")):
669
== if_tag.getAttribute(u"name")):
1483
670
if_tag.appendChild(tag)
1484
# Add annotation tags for properties
1485
for tag in if_tag.getElementsByTagName("property"):
1487
for name, prop in self._get_all_dbus_things(
1489
if (name == tag.getAttribute("name")
1490
and prop._dbus_interface
1491
== if_tag.getAttribute("name")):
1492
annots.update(getattr(
1493
prop, "_dbus_annotations", {}))
1494
for name, value in annots.items():
1495
ann_tag = document.createElement(
1497
ann_tag.setAttribute("name", name)
1498
ann_tag.setAttribute("value", value)
1499
tag.appendChild(ann_tag)
1500
671
# Add the names to the return values for the
1501
672
# "org.freedesktop.DBus.Properties" methods
1502
if (if_tag.getAttribute("name")
1503
== "org.freedesktop.DBus.Properties"):
1504
for cn in if_tag.getElementsByTagName("method"):
1505
if cn.getAttribute("name") == "Get":
1506
for arg in cn.getElementsByTagName("arg"):
1507
if (arg.getAttribute("direction")
1509
arg.setAttribute("name", "value")
1510
elif cn.getAttribute("name") == "GetAll":
1511
for arg in cn.getElementsByTagName("arg"):
1512
if (arg.getAttribute("direction")
1514
arg.setAttribute("name", "props")
1515
xmlstring = document.toxml("utf-8")
1517
except (AttributeError, xml.dom.DOMException,
1518
xml.parsers.expat.ExpatError) as error:
1519
logger.error("Failed to override Introspection method",
1525
dbus.OBJECT_MANAGER_IFACE
1526
except AttributeError:
1527
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1530
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1531
"""A D-Bus object with an ObjectManager.
1533
Classes inheriting from this exposes the standard
1534
GetManagedObjects call and the InterfacesAdded and
1535
InterfacesRemoved signals on the standard
1536
"org.freedesktop.DBus.ObjectManager" interface.
1538
Note: No signals are sent automatically; they must be sent
1541
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1542
out_signature="a{oa{sa{sv}}}")
1543
def GetManagedObjects(self):
1544
"""This function must be overridden"""
1545
raise NotImplementedError()
1547
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1548
signature="oa{sa{sv}}")
1549
def InterfacesAdded(self, object_path, interfaces_and_properties):
1552
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1553
def InterfacesRemoved(self, object_path, interfaces):
1556
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1558
path_keyword='object_path',
1559
connection_keyword='connection')
1560
def Introspect(self, object_path, connection):
1561
"""Overloading of standard D-Bus method.
1563
Override return argument name of GetManagedObjects to be
1564
"objpath_interfaces_and_properties"
1566
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1570
document = xml.dom.minidom.parseString(xmlstring)
1572
for if_tag in document.getElementsByTagName("interface"):
1573
# Fix argument name for the GetManagedObjects method
1574
if (if_tag.getAttribute("name")
1575
== dbus.OBJECT_MANAGER_IFACE):
1576
for cn in if_tag.getElementsByTagName("method"):
1577
if (cn.getAttribute("name")
1578
== "GetManagedObjects"):
1579
for arg in cn.getElementsByTagName("arg"):
1580
if (arg.getAttribute("direction")
1584
"objpath_interfaces"
1586
xmlstring = document.toxml("utf-8")
1588
except (AttributeError, xml.dom.DOMException,
1589
xml.parsers.expat.ExpatError) as error:
1590
logger.error("Failed to override Introspection method",
1595
def datetime_to_dbus(dt, variant_level=0):
1596
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1598
return dbus.String("", variant_level=variant_level)
1599
return dbus.String(dt.isoformat(), variant_level=variant_level)
1602
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1603
"""A class decorator; applied to a subclass of
1604
dbus.service.Object, it will add alternate D-Bus attributes with
1605
interface names according to the "alt_interface_names" mapping.
1608
@alternate_dbus_interfaces({"org.example.Interface":
1609
"net.example.AlternateInterface"})
1610
class SampleDBusObject(dbus.service.Object):
1611
@dbus.service.method("org.example.Interface")
1612
def SampleDBusMethod():
1615
The above "SampleDBusMethod" on "SampleDBusObject" will be
1616
reachable via two interfaces: "org.example.Interface" and
1617
"net.example.AlternateInterface", the latter of which will have
1618
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1619
"true", unless "deprecate" is passed with a False value.
1621
This works for methods and signals, and also for D-Bus properties
1622
(from DBusObjectWithProperties) and interfaces (from the
1623
dbus_interface_annotations decorator).
1627
for orig_interface_name, alt_interface_name in (
1628
alt_interface_names.items()):
1630
interface_names = set()
1631
# Go though all attributes of the class
1632
for attrname, attribute in inspect.getmembers(cls):
1633
# Ignore non-D-Bus attributes, and D-Bus attributes
1634
# with the wrong interface name
1635
if (not hasattr(attribute, "_dbus_interface")
1636
or not attribute._dbus_interface.startswith(
1637
orig_interface_name)):
1639
# Create an alternate D-Bus interface name based on
1641
alt_interface = attribute._dbus_interface.replace(
1642
orig_interface_name, alt_interface_name)
1643
interface_names.add(alt_interface)
1644
# Is this a D-Bus signal?
1645
if getattr(attribute, "_dbus_is_signal", False):
1646
# Extract the original non-method undecorated
1647
# function by black magic
1648
if sys.version_info.major == 2:
1649
nonmethod_func = (dict(
1650
zip(attribute.func_code.co_freevars,
1651
attribute.__closure__))
1652
["func"].cell_contents)
1654
nonmethod_func = (dict(
1655
zip(attribute.__code__.co_freevars,
1656
attribute.__closure__))
1657
["func"].cell_contents)
1658
# Create a new, but exactly alike, function
1659
# object, and decorate it to be a new D-Bus signal
1660
# with the alternate D-Bus interface name
1661
new_function = copy_function(nonmethod_func)
1662
new_function = (dbus.service.signal(
1664
attribute._dbus_signature)(new_function))
1665
# Copy annotations, if any
1667
new_function._dbus_annotations = dict(
1668
attribute._dbus_annotations)
1669
except AttributeError:
1672
# Define a creator of a function to call both the
1673
# original and alternate functions, so both the
1674
# original and alternate signals gets sent when
1675
# the function is called
1676
def fixscope(func1, func2):
1677
"""This function is a scope container to pass
1678
func1 and func2 to the "call_both" function
1679
outside of its arguments"""
1681
@functools.wraps(func2)
1682
def call_both(*args, **kwargs):
1683
"""This function will emit two D-Bus
1684
signals by calling func1 and func2"""
1685
func1(*args, **kwargs)
1686
func2(*args, **kwargs)
1687
# Make wrapper function look like a D-Bus
1689
for name, attr in inspect.getmembers(func2):
1690
if name.startswith("_dbus_"):
1691
setattr(call_both, name, attr)
1694
# Create the "call_both" function and add it to
1696
attr[attrname] = fixscope(attribute, new_function)
1697
# Is this a D-Bus method?
1698
elif getattr(attribute, "_dbus_is_method", False):
1699
# Create a new, but exactly alike, function
1700
# object. Decorate it to be a new D-Bus method
1701
# with the alternate D-Bus interface name. Add it
1704
dbus.service.method(
1706
attribute._dbus_in_signature,
1707
attribute._dbus_out_signature)
1708
(copy_function(attribute)))
1709
# Copy annotations, if any
1711
attr[attrname]._dbus_annotations = dict(
1712
attribute._dbus_annotations)
1713
except AttributeError:
1715
# Is this a D-Bus property?
1716
elif getattr(attribute, "_dbus_is_property", False):
1717
# Create a new, but exactly alike, function
1718
# object, and decorate it to be a new D-Bus
1719
# property with the alternate D-Bus interface
1720
# name. Add it to the class.
1721
attr[attrname] = (dbus_service_property(
1722
alt_interface, attribute._dbus_signature,
1723
attribute._dbus_access,
1724
attribute._dbus_get_args_options
1726
(copy_function(attribute)))
1727
# Copy annotations, if any
1729
attr[attrname]._dbus_annotations = dict(
1730
attribute._dbus_annotations)
1731
except AttributeError:
1733
# Is this a D-Bus interface?
1734
elif getattr(attribute, "_dbus_is_interface", False):
1735
# Create a new, but exactly alike, function
1736
# object. Decorate it to be a new D-Bus interface
1737
# with the alternate D-Bus interface name. Add it
1740
dbus_interface_annotations(alt_interface)
1741
(copy_function(attribute)))
1743
# Deprecate all alternate interfaces
1744
iname = "_AlternateDBusNames_interface_annotation{}"
1745
for interface_name in interface_names:
1747
@dbus_interface_annotations(interface_name)
1749
return {"org.freedesktop.DBus.Deprecated":
1751
# Find an unused name
1752
for aname in (iname.format(i)
1753
for i in itertools.count()):
1754
if aname not in attr:
1758
# Replace the class with a new subclass of it with
1759
# methods, signals, etc. as created above.
1760
if sys.version_info.major == 2:
1761
cls = type(b"{}Alternate".format(cls.__name__),
1764
cls = type("{}Alternate".format(cls.__name__),
1771
@alternate_dbus_interfaces({"se.recompile.Mandos":
1772
"se.bsnet.fukt.Mandos"})
673
if (if_tag.getAttribute(u"name")
674
== u"org.freedesktop.DBus.Properties"):
675
for cn in if_tag.getElementsByTagName(u"method"):
676
if cn.getAttribute(u"name") == u"Get":
677
for arg in cn.getElementsByTagName(u"arg"):
678
if (arg.getAttribute(u"direction")
680
arg.setAttribute(u"name", u"value")
681
elif cn.getAttribute(u"name") == u"GetAll":
682
for arg in cn.getElementsByTagName(u"arg"):
683
if (arg.getAttribute(u"direction")
685
arg.setAttribute(u"name", u"props")
686
xmlstring = document.toxml(u"utf-8")
688
except (AttributeError, xml.dom.DOMException,
689
xml.parsers.expat.ExpatError), error:
690
logger.error(u"Failed to override Introspection method",
1773
695
class ClientDBus(Client, DBusObjectWithProperties):
1774
696
"""A Client class using D-Bus
1777
699
dbus_object_path: dbus.ObjectPath
1778
700
bus: dbus.SystemBus()
1781
runtime_expansions = (Client.runtime_expansions
1782
+ ("dbus_object_path", ))
1784
_interface = "se.recompile.Mandos.Client"
1786
702
# dbus.service.Object doesn't use super(), so we can't either.
1788
def __init__(self, bus=None, *args, **kwargs):
704
def __init__(self, bus = None, *args, **kwargs):
705
self._approvals_pending = 0
1790
707
Client.__init__(self, *args, **kwargs)
1791
708
# Only now, when this client is initialized, can it show up on
1793
client_object_name = str(self.name).translate(
1794
{ord("."): ord("_"),
1795
ord("-"): ord("_")})
1796
self.dbus_object_path = dbus.ObjectPath(
1797
"/clients/" + client_object_name)
710
self.dbus_object_path = (dbus.ObjectPath
712
+ self.name.replace(u".", u"_")))
1798
713
DBusObjectWithProperties.__init__(self, self.bus,
1799
714
self.dbus_object_path)
1801
def notifychangeproperty(transform_func, dbus_name,
1802
type_func=lambda x: x,
1804
invalidate_only=False,
1805
_interface=_interface):
1806
""" Modify a variable so that it's a property which announces
1807
its changes to DBus.
1809
transform_fun: Function that takes a value and a variant_level
1810
and transforms it to a D-Bus type.
1811
dbus_name: D-Bus name of the variable
1812
type_func: Function that transform the value before sending it
1813
to the D-Bus. Default: no transform
1814
variant_level: D-Bus variant level. Default: 1
1816
attrname = "_{}".format(dbus_name)
1818
def setter(self, value):
1819
if hasattr(self, "dbus_object_path"):
1820
if (not hasattr(self, attrname) or
1821
type_func(getattr(self, attrname, None))
1822
!= type_func(value)):
1824
self.PropertiesChanged(
1825
_interface, dbus.Dictionary(),
1826
dbus.Array((dbus_name, )))
1828
dbus_value = transform_func(
1830
variant_level=variant_level)
1831
self.PropertyChanged(dbus.String(dbus_name),
1833
self.PropertiesChanged(
1835
dbus.Dictionary({dbus.String(dbus_name):
1838
setattr(self, attrname, value)
1840
return property(lambda self: getattr(self, attrname), setter)
1842
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1843
approvals_pending = notifychangeproperty(dbus.Boolean,
1846
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1847
last_enabled = notifychangeproperty(datetime_to_dbus,
1849
checker = notifychangeproperty(
1850
dbus.Boolean, "CheckerRunning",
1851
type_func=lambda checker: checker is not None)
1852
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1854
last_checker_status = notifychangeproperty(dbus.Int16,
1855
"LastCheckerStatus")
1856
last_approval_request = notifychangeproperty(
1857
datetime_to_dbus, "LastApprovalRequest")
1858
approved_by_default = notifychangeproperty(dbus.Boolean,
1859
"ApprovedByDefault")
1860
approval_delay = notifychangeproperty(
1861
dbus.UInt64, "ApprovalDelay",
1862
type_func=lambda td: td.total_seconds() * 1000)
1863
approval_duration = notifychangeproperty(
1864
dbus.UInt64, "ApprovalDuration",
1865
type_func=lambda td: td.total_seconds() * 1000)
1866
host = notifychangeproperty(dbus.String, "Host")
1867
timeout = notifychangeproperty(
1868
dbus.UInt64, "Timeout",
1869
type_func=lambda td: td.total_seconds() * 1000)
1870
extended_timeout = notifychangeproperty(
1871
dbus.UInt64, "ExtendedTimeout",
1872
type_func=lambda td: td.total_seconds() * 1000)
1873
interval = notifychangeproperty(
1874
dbus.UInt64, "Interval",
1875
type_func=lambda td: td.total_seconds() * 1000)
1876
checker_command = notifychangeproperty(dbus.String, "Checker")
1877
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1878
invalidate_only=True)
1880
del notifychangeproperty
716
def _get_approvals_pending(value):
717
return self._approvals_pending
718
def _set_approvals_pending(value):
719
old_value = self._approvals_pending
720
self._approvals_pending = value
722
if bval is bool(old_value):
723
dbus_bool = dbus.Boolean(bval, variant_level=1)
724
self.PropertyChanged(dbus.String(u"approved_pending"),
727
approvals_pending = property(_get_approvals_pending,
728
_set_approvals_pending)
729
del _get_approvals_pending, _set_approvals_pending
732
def _datetime_to_dbus(dt, variant_level=0):
733
"""Convert a UTC datetime.datetime() to a D-Bus type."""
734
return dbus.String(dt.isoformat(),
735
variant_level=variant_level)
738
oldstate = getattr(self, u"enabled", False)
739
r = Client.enable(self)
740
if oldstate != self.enabled:
742
self.PropertyChanged(dbus.String(u"enabled"),
743
dbus.Boolean(True, variant_level=1))
744
self.PropertyChanged(
745
dbus.String(u"last_enabled"),
746
self._datetime_to_dbus(self.last_enabled,
750
def disable(self, quiet = False):
751
oldstate = getattr(self, u"enabled", False)
752
r = Client.disable(self, quiet=quiet)
753
if not quiet and oldstate != self.enabled:
755
self.PropertyChanged(dbus.String(u"enabled"),
756
dbus.Boolean(False, variant_level=1))
1882
759
def __del__(self, *args, **kwargs):
1884
761
self.remove_from_connection()
1885
762
except LookupError:
1887
if hasattr(DBusObjectWithProperties, "__del__"):
764
if hasattr(DBusObjectWithProperties, u"__del__"):
1888
765
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1889
766
Client.__del__(self, *args, **kwargs)
1891
def checker_callback(self, source, condition,
1892
connection, command, *args, **kwargs):
1893
ret = Client.checker_callback(self, source, condition,
1894
connection, command, *args,
1896
exitstatus = self.last_checker_status
768
def checker_callback(self, pid, condition, command,
770
self.checker_callback_tag = None
773
self.PropertyChanged(dbus.String(u"checker_running"),
774
dbus.Boolean(False, variant_level=1))
775
if os.WIFEXITED(condition):
776
exitstatus = os.WEXITSTATUS(condition)
1898
777
# Emit D-Bus signal
1899
778
self.CheckerCompleted(dbus.Int16(exitstatus),
1900
# This is specific to GNU libC
1901
dbus.Int64(exitstatus << 8),
779
dbus.Int64(condition),
1902
780
dbus.String(command))
1904
782
# Emit D-Bus signal
1905
783
self.CheckerCompleted(dbus.Int16(-1),
1907
# This is specific to GNU libC
1909
| self.last_checker_signal),
784
dbus.Int64(condition),
1910
785
dbus.String(command))
787
return Client.checker_callback(self, pid, condition, command,
790
def checked_ok(self, *args, **kwargs):
791
r = Client.checked_ok(self, *args, **kwargs)
793
self.PropertyChanged(
794
dbus.String(u"last_checked_ok"),
795
(self._datetime_to_dbus(self.last_checked_ok,
1913
799
def start_checker(self, *args, **kwargs):
1914
old_checker_pid = getattr(self.checker, "pid", None)
800
old_checker = self.checker
801
if self.checker is not None:
802
old_checker_pid = self.checker.pid
804
old_checker_pid = None
1915
805
r = Client.start_checker(self, *args, **kwargs)
1916
806
# Only if new checker process was started
1917
807
if (self.checker is not None
1918
808
and old_checker_pid != self.checker.pid):
1919
809
# Emit D-Bus signal
1920
810
self.CheckerStarted(self.current_checker_command)
811
self.PropertyChanged(
812
dbus.String(u"checker_running"),
813
dbus.Boolean(True, variant_level=1))
816
def stop_checker(self, *args, **kwargs):
817
old_checker = getattr(self, u"checker", None)
818
r = Client.stop_checker(self, *args, **kwargs)
819
if (old_checker is not None
820
and getattr(self, u"checker", None) is None):
821
self.PropertyChanged(dbus.String(u"checker_running"),
822
dbus.Boolean(False, variant_level=1))
1923
825
def _reset_approved(self):
1924
self.approved = None
826
self._approved = None
1927
829
def approve(self, value=True):
1928
self.approved = value
1929
GLib.timeout_add(int(self.approval_duration.total_seconds()
1930
* 1000), self._reset_approved)
1931
self.send_changedstate()
1933
# D-Bus methods, signals & properties
830
self._approved = value
831
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration, self._reset_approved))
834
## D-Bus methods, signals & properties
835
_interface = u"se.bsnet.fukt.Mandos.Client"
1939
839
# CheckerCompleted - signal
1940
@dbus.service.signal(_interface, signature="nxs")
840
@dbus.service.signal(_interface, signature=u"nxs")
1941
841
def CheckerCompleted(self, exitcode, waitstatus, command):
1945
845
# CheckerStarted - signal
1946
@dbus.service.signal(_interface, signature="s")
846
@dbus.service.signal(_interface, signature=u"s")
1947
847
def CheckerStarted(self, command):
1951
851
# PropertyChanged - signal
1952
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1953
@dbus.service.signal(_interface, signature="sv")
852
@dbus.service.signal(_interface, signature=u"sv")
1954
853
def PropertyChanged(self, property, value):
1958
857
# GotSecret - signal
1959
858
@dbus.service.signal(_interface)
1960
859
def GotSecret(self):
1962
Is sent after a successful transfer of secret from the Mandos
1963
server to mandos-client
1967
863
# Rejected - signal
1968
@dbus.service.signal(_interface, signature="s")
864
@dbus.service.signal(_interface, signature=u"s")
1969
865
def Rejected(self, reason):
1973
869
# NeedApproval - signal
1974
@dbus.service.signal(_interface, signature="tb")
870
@dbus.service.signal(_interface, signature=u"db")
1975
871
def NeedApproval(self, timeout, default):
1977
return self.need_approval()
1981
877
# Approve - method
1982
@dbus.service.method(_interface, in_signature="b")
878
@dbus.service.method(_interface, in_signature=u"b")
1983
879
def Approve(self, value):
1984
880
self.approve(value)
1986
882
# CheckedOK - method
1987
883
@dbus.service.method(_interface)
1988
884
def CheckedOK(self):
885
return self.checked_ok()
1991
887
# Enable - method
1992
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1993
888
@dbus.service.method(_interface)
1994
889
def Enable(self):
1998
893
# StartChecker - method
1999
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2000
894
@dbus.service.method(_interface)
2001
895
def StartChecker(self):
2003
897
self.start_checker()
2005
899
# Disable - method
2006
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2007
900
@dbus.service.method(_interface)
2008
901
def Disable(self):
2012
905
# StopChecker - method
2013
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2014
906
@dbus.service.method(_interface)
2015
907
def StopChecker(self):
2016
908
self.stop_checker()
2020
# ApprovalPending - property
2021
@dbus_service_property(_interface, signature="b", access="read")
2022
def ApprovalPending_dbus_property(self):
912
# approved_pending - property
913
@dbus_service_property(_interface, signature=u"b", access=u"read")
914
def approved_pending_dbus_property(self):
2023
915
return dbus.Boolean(bool(self.approvals_pending))
2025
# ApprovedByDefault - property
2026
@dbus_service_property(_interface,
2029
def ApprovedByDefault_dbus_property(self, value=None):
2030
if value is None: # get
2031
return dbus.Boolean(self.approved_by_default)
2032
self.approved_by_default = bool(value)
2034
# ApprovalDelay - property
2035
@dbus_service_property(_interface,
2038
def ApprovalDelay_dbus_property(self, value=None):
2039
if value is None: # get
2040
return dbus.UInt64(self.approval_delay.total_seconds()
2042
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2044
# ApprovalDuration - property
2045
@dbus_service_property(_interface,
2048
def ApprovalDuration_dbus_property(self, value=None):
2049
if value is None: # get
2050
return dbus.UInt64(self.approval_duration.total_seconds()
2052
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2056
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2057
@dbus_service_property(_interface, signature="s", access="read")
2058
def Name_dbus_property(self):
917
# approved_by_default - property
918
@dbus_service_property(_interface, signature=u"b",
920
def approved_by_default_dbus_property(self):
921
return dbus.Boolean(self.approved_by_default)
923
# approved_delay - property
924
@dbus_service_property(_interface, signature=u"t",
926
def approved_delay_dbus_property(self):
927
return dbus.UInt64(self.approved_delay_milliseconds())
929
# approved_duration - property
930
@dbus_service_property(_interface, signature=u"t",
932
def approved_duration_dbus_property(self):
933
return dbus.UInt64(self._timedelta_to_milliseconds(
934
self.approved_duration))
937
@dbus_service_property(_interface, signature=u"s", access=u"read")
938
def name_dbus_property(self):
2059
939
return dbus.String(self.name)
2063
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2064
@dbus_service_property(_interface, signature="s", access="read")
2065
def KeyID_dbus_property(self):
2066
return dbus.String(self.key_id)
2068
# Fingerprint - property
2070
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2071
@dbus_service_property(_interface, signature="s", access="read")
2072
def Fingerprint_dbus_property(self):
941
# fingerprint - property
942
@dbus_service_property(_interface, signature=u"s", access=u"read")
943
def fingerprint_dbus_property(self):
2073
944
return dbus.String(self.fingerprint)
2076
@dbus_service_property(_interface,
2079
def Host_dbus_property(self, value=None):
947
@dbus_service_property(_interface, signature=u"s",
949
def host_dbus_property(self, value=None):
2080
950
if value is None: # get
2081
951
return dbus.String(self.host)
2082
self.host = str(value)
2084
# Created - property
2086
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2087
@dbus_service_property(_interface, signature="s", access="read")
2088
def Created_dbus_property(self):
2089
return datetime_to_dbus(self.created)
2091
# LastEnabled - property
2092
@dbus_service_property(_interface, signature="s", access="read")
2093
def LastEnabled_dbus_property(self):
2094
return datetime_to_dbus(self.last_enabled)
2096
# Enabled - property
2097
@dbus_service_property(_interface,
2100
def Enabled_dbus_property(self, value=None):
954
self.PropertyChanged(dbus.String(u"host"),
955
dbus.String(value, variant_level=1))
958
@dbus_service_property(_interface, signature=u"s", access=u"read")
959
def created_dbus_property(self):
960
return dbus.String(self._datetime_to_dbus(self.created))
962
# last_enabled - property
963
@dbus_service_property(_interface, signature=u"s", access=u"read")
964
def last_enabled_dbus_property(self):
965
if self.last_enabled is None:
966
return dbus.String(u"")
967
return dbus.String(self._datetime_to_dbus(self.last_enabled))
970
@dbus_service_property(_interface, signature=u"b",
972
def enabled_dbus_property(self, value=None):
2101
973
if value is None: # get
2102
974
return dbus.Boolean(self.enabled)
2108
# LastCheckedOK - property
2109
@dbus_service_property(_interface,
2112
def LastCheckedOK_dbus_property(self, value=None):
980
# last_checked_ok - property
981
@dbus_service_property(_interface, signature=u"s",
983
def last_checked_ok_dbus_property(self, value=None):
2113
984
if value is not None:
2114
985
self.checked_ok()
2116
return datetime_to_dbus(self.last_checked_ok)
2118
# LastCheckerStatus - property
2119
@dbus_service_property(_interface, signature="n", access="read")
2120
def LastCheckerStatus_dbus_property(self):
2121
return dbus.Int16(self.last_checker_status)
2123
# Expires - property
2124
@dbus_service_property(_interface, signature="s", access="read")
2125
def Expires_dbus_property(self):
2126
return datetime_to_dbus(self.expires)
2128
# LastApprovalRequest - property
2129
@dbus_service_property(_interface, signature="s", access="read")
2130
def LastApprovalRequest_dbus_property(self):
2131
return datetime_to_dbus(self.last_approval_request)
2133
# Timeout - property
2134
@dbus_service_property(_interface,
2137
def Timeout_dbus_property(self, value=None):
987
if self.last_checked_ok is None:
988
return dbus.String(u"")
989
return dbus.String(self._datetime_to_dbus(self
993
@dbus_service_property(_interface, signature=u"t",
995
def timeout_dbus_property(self, value=None):
2138
996
if value is None: # get
2139
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2140
old_timeout = self.timeout
997
return dbus.UInt64(self.timeout_milliseconds())
2141
998
self.timeout = datetime.timedelta(0, 0, 0, value)
2142
# Reschedule disabling
2144
now = datetime.datetime.utcnow()
2145
self.expires += self.timeout - old_timeout
2146
if self.expires <= now:
2147
# The timeout has passed
2150
if (getattr(self, "disable_initiator_tag", None)
2153
GLib.source_remove(self.disable_initiator_tag)
2154
self.disable_initiator_tag = GLib.timeout_add(
2155
int((self.expires - now).total_seconds() * 1000),
2158
# ExtendedTimeout - property
2159
@dbus_service_property(_interface,
2162
def ExtendedTimeout_dbus_property(self, value=None):
2163
if value is None: # get
2164
return dbus.UInt64(self.extended_timeout.total_seconds()
2166
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2168
# Interval - property
2169
@dbus_service_property(_interface,
2172
def Interval_dbus_property(self, value=None):
2173
if value is None: # get
2174
return dbus.UInt64(self.interval.total_seconds() * 1000)
1000
self.PropertyChanged(dbus.String(u"timeout"),
1001
dbus.UInt64(value, variant_level=1))
1002
if getattr(self, u"disable_initiator_tag", None) is None:
1004
# Reschedule timeout
1005
gobject.source_remove(self.disable_initiator_tag)
1006
self.disable_initiator_tag = None
1007
time_to_die = (self.
1008
_timedelta_to_milliseconds((self
1013
if time_to_die <= 0:
1014
# The timeout has passed
1017
self.disable_initiator_tag = (gobject.timeout_add
1018
(time_to_die, self.disable))
1020
# interval - property
1021
@dbus_service_property(_interface, signature=u"t",
1022
access=u"readwrite")
1023
def interval_dbus_property(self, value=None):
1024
if value is None: # get
1025
return dbus.UInt64(self.interval_milliseconds())
2175
1026
self.interval = datetime.timedelta(0, 0, 0, value)
2176
if getattr(self, "checker_initiator_tag", None) is None:
1028
self.PropertyChanged(dbus.String(u"interval"),
1029
dbus.UInt64(value, variant_level=1))
1030
if getattr(self, u"checker_initiator_tag", None) is None:
2179
# Reschedule checker run
2180
GLib.source_remove(self.checker_initiator_tag)
2181
self.checker_initiator_tag = GLib.timeout_add(
2182
value, self.start_checker)
2183
self.start_checker() # Start one now, too
1032
# Reschedule checker run
1033
gobject.source_remove(self.checker_initiator_tag)
1034
self.checker_initiator_tag = (gobject.timeout_add
1035
(value, self.start_checker))
1036
self.start_checker() # Start one now, too
2185
# Checker - property
2186
@dbus_service_property(_interface,
2189
def Checker_dbus_property(self, value=None):
1038
# checker - property
1039
@dbus_service_property(_interface, signature=u"s",
1040
access=u"readwrite")
1041
def checker_dbus_property(self, value=None):
2190
1042
if value is None: # get
2191
1043
return dbus.String(self.checker_command)
2192
self.checker_command = str(value)
2194
# CheckerRunning - property
2195
@dbus_service_property(_interface,
2198
def CheckerRunning_dbus_property(self, value=None):
1044
self.checker_command = value
1046
self.PropertyChanged(dbus.String(u"checker"),
1047
dbus.String(self.checker_command,
1050
# checker_running - property
1051
@dbus_service_property(_interface, signature=u"b",
1052
access=u"readwrite")
1053
def checker_running_dbus_property(self, value=None):
2199
1054
if value is None: # get
2200
1055
return dbus.Boolean(self.checker is not None)
2202
1057
self.start_checker()
2204
1059
self.stop_checker()
2206
# ObjectPath - property
2208
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2209
"org.freedesktop.DBus.Deprecated": "true"})
2210
@dbus_service_property(_interface, signature="o", access="read")
2211
def ObjectPath_dbus_property(self):
2212
return self.dbus_object_path # is already a dbus.ObjectPath
2216
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2218
@dbus_service_property(_interface,
2222
def Secret_dbus_property(self, value):
2223
self.secret = bytes(value)
1061
# object_path - property
1062
@dbus_service_property(_interface, signature=u"o", access=u"read")
1063
def object_path_dbus_property(self):
1064
return self.dbus_object_path # is already a dbus.ObjectPath
1067
@dbus_service_property(_interface, signature=u"ay",
1068
access=u"write", byte_arrays=True)
1069
def secret_dbus_property(self, value):
1070
self.secret = str(value)
2229
def __init__(self, child_pipe, key_id, fpr, address):
1075
class ProxyClient(object):
1076
def __init__(self, child_pipe, fpr, address):
2230
1077
self._pipe = child_pipe
2231
self._pipe.send(('init', key_id, fpr, address))
1078
self._pipe.send(('init', fpr, address))
2232
1079
if not self._pipe.recv():
2233
raise KeyError(key_id or fpr)
2235
1082
def __getattribute__(self, name):
1083
if(name == '_pipe'):
2237
1084
return super(ProxyClient, self).__getattribute__(name)
2238
1085
self._pipe.send(('getattr', name))
2239
1086
data = self._pipe.recv()
2240
1087
if data[0] == 'data':
2242
1089
if data[0] == 'function':
2244
1090
def func(*args, **kwargs):
2245
1091
self._pipe.send(('funcall', name, args, kwargs))
2246
1092
return self._pipe.recv()[1]
2250
1095
def __setattr__(self, name, value):
1096
if(name == '_pipe'):
2252
1097
return super(ProxyClient, self).__setattr__(name, value)
2253
1098
self._pipe.send(('setattr', name, value))
2256
1101
class ClientHandler(socketserver.BaseRequestHandler, object):
2257
1102
"""A class to handle client connections.
2259
1104
Instantiated once for each connection to handle it.
2260
1105
Note: This will run in its own forked process."""
2262
1107
def handle(self):
2263
1108
with contextlib.closing(self.server.child_pipe) as child_pipe:
2264
logger.info("TCP connection from: %s",
2265
str(self.client_address))
2266
logger.debug("Pipe FD: %d",
1109
logger.info(u"TCP connection from: %s",
1110
unicode(self.client_address))
1111
logger.debug(u"Pipe FD: %d",
2267
1112
self.server.child_pipe.fileno())
2269
session = gnutls.ClientSession(self.request)
2271
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2272
# "+AES-256-CBC", "+SHA1",
2273
# "+COMP-NULL", "+CTYPE-OPENPGP",
1114
session = (gnutls.connection
1115
.ClientSession(self.request,
1117
.X509Credentials()))
1119
# Note: gnutls.connection.X509Credentials is really a
1120
# generic GnuTLS certificate credentials object so long as
1121
# no X.509 keys are added to it. Therefore, we can use it
1122
# here despite using OpenPGP certificates.
1124
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1125
# u"+AES-256-CBC", u"+SHA1",
1126
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2275
1128
# Use a fallback default, since this MUST be set.
2276
1129
priority = self.server.gnutls_priority
2277
1130
if priority is None:
2279
gnutls.priority_set_direct(session._c_object,
2280
priority.encode("utf-8"),
1131
priority = u"NORMAL"
1132
(gnutls.library.functions
1133
.gnutls_priority_set_direct(session._c_object,
2283
1136
# Start communication using the Mandos protocol
2284
1137
# Get protocol number
2285
1138
line = self.request.makefile().readline()
2286
logger.debug("Protocol version: %r", line)
1139
logger.debug(u"Protocol version: %r", line)
2288
1141
if int(line.strip().split()[0]) > 1:
2289
raise RuntimeError(line)
2290
except (ValueError, IndexError, RuntimeError) as error:
2291
logger.error("Unknown protocol version: %s", error)
1143
except (ValueError, IndexError, RuntimeError), error:
1144
logger.error(u"Unknown protocol version: %s", error)
2294
1147
# Start GnuTLS connection
2296
1149
session.handshake()
2297
except gnutls.Error as error:
2298
logger.warning("Handshake failed: %s", error)
1150
except gnutls.errors.GNUTLSError, error:
1151
logger.warning(u"Handshake failed: %s", error)
2299
1152
# Do not run session.bye() here: the session is not
2300
1153
# established. Just abandon the request.
2302
logger.debug("Handshake succeeded")
1155
logger.debug(u"Handshake succeeded")
2304
1157
approval_required = False
2306
if gnutls.has_rawpk:
2309
key_id = self.key_id(
2310
self.peer_certificate(session))
2311
except (TypeError, gnutls.Error) as error:
2312
logger.warning("Bad certificate: %s", error)
2314
logger.debug("Key ID: %s", key_id)
2319
fpr = self.fingerprint(
2320
self.peer_certificate(session))
2321
except (TypeError, gnutls.Error) as error:
2322
logger.warning("Bad certificate: %s", error)
2324
logger.debug("Fingerprint: %s", fpr)
2327
client = ProxyClient(child_pipe, key_id, fpr,
1160
fpr = self.fingerprint(self.peer_certificate
1162
except (TypeError, gnutls.errors.GNUTLSError), error:
1163
logger.warning(u"Bad certificate: %s", error)
1165
logger.debug(u"Fingerprint: %s", fpr)
1168
client = ProxyClient(child_pipe, fpr,
2328
1169
self.client_address)
2329
1170
except KeyError:
2332
if client.approval_delay:
2333
delay = client.approval_delay
1173
if client.approved_delay:
1174
delay = client.approved_delay
2334
1175
client.approvals_pending += 1
2335
1176
approval_required = True
2338
1179
if not client.enabled:
2339
logger.info("Client %s is disabled",
1180
logger.warning(u"Client %s is disabled",
2341
1182
if self.server.use_dbus:
2342
1183
# Emit D-Bus signal
2343
client.Rejected("Disabled")
1184
client.Rejected("Disabled")
2346
if client.approved or not client.approval_delay:
2347
# We are approved or approval is disabled
1187
if client._approved or not client.approved_delay:
1188
#We are approved or approval is disabled
2349
elif client.approved is None:
2350
logger.info("Client %s needs approval",
1190
elif client._approved is None:
1191
logger.info(u"Client %s need approval",
2352
1193
if self.server.use_dbus:
2353
1194
# Emit D-Bus signal
2354
1195
client.NeedApproval(
2355
client.approval_delay.total_seconds()
2356
* 1000, client.approved_by_default)
1196
client.approved_delay_milliseconds(),
1197
client.approved_by_default)
2358
logger.warning("Client %s was not approved",
1199
logger.warning(u"Client %s was not approved",
2360
1201
if self.server.use_dbus:
2361
1202
# Emit D-Bus signal
2362
client.Rejected("Denied")
1203
client.Rejected("Disapproved")
2365
# wait until timeout or approved
1206
#wait until timeout or approved
1207
#x = float(client._timedelta_to_milliseconds(delay))
2366
1208
time = datetime.datetime.now()
2367
1209
client.changedstate.acquire()
2368
client.changedstate.wait(delay.total_seconds())
1210
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
2369
1211
client.changedstate.release()
2370
1212
time2 = datetime.datetime.now()
2371
1213
if (time2 - time) >= delay:
2376
1218
if self.server.use_dbus:
2377
1219
# Emit D-Bus signal
2378
client.Rejected("Approval timed out")
1220
client.Rejected("Time out")
2383
1225
delay -= time2 - time
2386
session.send(client.secret)
2387
except gnutls.Error as error:
2388
logger.warning("gnutls send failed",
2392
logger.info("Sending secret to %s", client.name)
2393
# bump the timeout using extended_timeout
2394
client.bump_timeout(client.extended_timeout)
1228
while sent_size < len(client.secret):
1229
# XXX handle session exception
1230
sent = session.send(client.secret[sent_size:])
1231
logger.debug(u"Sent: %d, remaining: %d",
1232
sent, len(client.secret)
1233
- (sent_size + sent))
1236
logger.info(u"Sending secret to %s", client.name)
1237
# bump the timeout as if seen
2395
1239
if self.server.use_dbus:
2396
1240
# Emit D-Bus signal
2397
1241
client.GotSecret()
2400
1244
if approval_required:
2401
1245
client.approvals_pending -= 1
2404
except gnutls.Error as error:
2405
logger.warning("GnuTLS bye failed",
2409
1249
def peer_certificate(session):
2410
"Return the peer's certificate as a bytestring"
2412
cert_type = gnutls.certificate_type_get2(session._c_object,
2414
except AttributeError:
2415
cert_type = gnutls.certificate_type_get(session._c_object)
2416
if gnutls.has_rawpk:
2417
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2419
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2420
# If not a valid certificate type...
2421
if cert_type not in valid_cert_types:
2422
logger.info("Cert type %r not in %r", cert_type,
2424
# ...return invalid data
1250
"Return the peer's OpenPGP certificate as a bytestring"
1251
# If not an OpenPGP certificate...
1252
if (gnutls.library.functions
1253
.gnutls_certificate_type_get(session._c_object)
1254
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1255
# ...do the normal thing
1256
return session.peer_certificate
2426
1257
list_size = ctypes.c_uint(1)
2427
cert_list = (gnutls.certificate_get_peers
1258
cert_list = (gnutls.library.functions
1259
.gnutls_certificate_get_peers
2428
1260
(session._c_object, ctypes.byref(list_size)))
2429
1261
if not bool(cert_list) and list_size.value != 0:
2430
raise gnutls.Error("error getting peer certificate")
1262
raise gnutls.errors.GNUTLSError(u"error getting peer"
2431
1264
if list_size.value == 0:
2433
1266
cert = cert_list[0]
2434
1267
return ctypes.string_at(cert.data, cert.size)
2437
def key_id(certificate):
2438
"Convert a certificate bytestring to a hexdigit key ID"
2439
# New GnuTLS "datum" with the public key
2440
datum = gnutls.datum_t(
2441
ctypes.cast(ctypes.c_char_p(certificate),
2442
ctypes.POINTER(ctypes.c_ubyte)),
2443
ctypes.c_uint(len(certificate)))
2444
# XXX all these need to be created in the gnutls "module"
2445
# New empty GnuTLS certificate
2446
pubkey = gnutls.pubkey_t()
2447
gnutls.pubkey_init(ctypes.byref(pubkey))
2448
# Import the raw public key into the certificate
2449
gnutls.pubkey_import(pubkey,
2450
ctypes.byref(datum),
2451
gnutls.X509_FMT_DER)
2452
# New buffer for the key ID
2453
buf = ctypes.create_string_buffer(32)
2454
buf_len = ctypes.c_size_t(len(buf))
2455
# Get the key ID from the raw public key into the buffer
2456
gnutls.pubkey_get_key_id(pubkey,
2457
gnutls.KEYID_USE_SHA256,
2458
ctypes.cast(ctypes.byref(buf),
2459
ctypes.POINTER(ctypes.c_ubyte)),
2460
ctypes.byref(buf_len))
2461
# Deinit the certificate
2462
gnutls.pubkey_deinit(pubkey)
2464
# Convert the buffer to a Python bytestring
2465
key_id = ctypes.string_at(buf, buf_len.value)
2466
# Convert the bytestring to hexadecimal notation
2467
hex_key_id = binascii.hexlify(key_id).upper()
2471
1270
def fingerprint(openpgp):
2472
1271
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2473
1272
# New GnuTLS "datum" with the OpenPGP public key
2474
datum = gnutls.datum_t(
2475
ctypes.cast(ctypes.c_char_p(openpgp),
2476
ctypes.POINTER(ctypes.c_ubyte)),
2477
ctypes.c_uint(len(openpgp)))
1273
datum = (gnutls.library.types
1274
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1277
ctypes.c_uint(len(openpgp))))
2478
1278
# New empty GnuTLS certificate
2479
crt = gnutls.openpgp_crt_t()
2480
gnutls.openpgp_crt_init(ctypes.byref(crt))
1279
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1280
(gnutls.library.functions
1281
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2481
1282
# Import the OpenPGP public key into the certificate
2482
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2483
gnutls.OPENPGP_FMT_RAW)
1283
(gnutls.library.functions
1284
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1285
gnutls.library.constants
1286
.GNUTLS_OPENPGP_FMT_RAW))
2484
1287
# Verify the self signature in the key
2485
1288
crtverify = ctypes.c_uint()
2486
gnutls.openpgp_crt_verify_self(crt, 0,
2487
ctypes.byref(crtverify))
1289
(gnutls.library.functions
1290
.gnutls_openpgp_crt_verify_self(crt, 0,
1291
ctypes.byref(crtverify)))
2488
1292
if crtverify.value != 0:
2489
gnutls.openpgp_crt_deinit(crt)
2490
raise gnutls.CertificateSecurityError(code
1293
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1294
raise (gnutls.errors.CertificateSecurityError
2492
1296
# New buffer for the fingerprint
2493
1297
buf = ctypes.create_string_buffer(20)
2494
1298
buf_len = ctypes.c_size_t()
2495
1299
# Get the fingerprint from the certificate into the buffer
2496
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2497
ctypes.byref(buf_len))
1300
(gnutls.library.functions
1301
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1302
ctypes.byref(buf_len)))
2498
1303
# Deinit the certificate
2499
gnutls.openpgp_crt_deinit(crt)
1304
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2500
1305
# Convert the buffer to a Python bytestring
2501
1306
fpr = ctypes.string_at(buf, buf_len.value)
2502
1307
# Convert the bytestring to hexadecimal notation
2503
hex_fpr = binascii.hexlify(fpr).upper()
1308
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2507
class MultiprocessingMixIn:
1312
class MultiprocessingMixIn(object):
2508
1313
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2510
1314
def sub_process_main(self, request, address):
2512
1316
self.finish_request(request, address)
2514
1318
self.handle_error(request, address)
2515
1319
self.close_request(request)
2517
1321
def process_request(self, request, address):
2518
1322
"""Start a new process to process the request."""
2519
proc = multiprocessing.Process(target=self.sub_process_main,
2520
args=(request, address))
2525
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1323
multiprocessing.Process(target = self.sub_process_main,
1324
args = (request, address)).start()
1326
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2526
1327
""" adds a pipe to the MixIn """
2528
1328
def process_request(self, request, client_address):
2529
1329
"""Overrides and wraps the original process_request().
2531
1331
This function creates a new pipe in self.pipe
2533
1333
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2535
proc = MultiprocessingMixIn.process_request(self, request,
2537
self.child_pipe.close()
2538
self.add_pipe(parent_pipe, proc)
2540
def add_pipe(self, parent_pipe, proc):
1335
super(MultiprocessingMixInWithPipe,
1336
self).process_request(request, client_address)
1337
self.add_pipe(parent_pipe)
1338
def add_pipe(self, parent_pipe):
2541
1339
"""Dummy function; override as necessary"""
2542
raise NotImplementedError()
2545
1342
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2546
socketserver.TCPServer):
1343
socketserver.TCPServer, object):
2547
1344
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2550
1347
enabled: Boolean; whether this server is activated yet
2551
1348
interface: None or a network interface name (string)
2552
1349
use_ipv6: Boolean; to use IPv6 or not
2555
1351
def __init__(self, server_address, RequestHandlerClass,
2559
"""If socketfd is set, use that file descriptor instead of
2560
creating a new one with socket.socket().
1352
interface=None, use_ipv6=True):
2562
1353
self.interface = interface
2564
1355
self.address_family = socket.AF_INET6
2565
if socketfd is not None:
2566
# Save the file descriptor
2567
self.socketfd = socketfd
2568
# Save the original socket.socket() function
2569
self.socket_socket = socket.socket
2571
# To implement --socket, we monkey patch socket.socket.
2573
# (When socketserver.TCPServer is a new-style class, we
2574
# could make self.socket into a property instead of monkey
2575
# patching socket.socket.)
2577
# Create a one-time-only replacement for socket.socket()
2578
@functools.wraps(socket.socket)
2579
def socket_wrapper(*args, **kwargs):
2580
# Restore original function so subsequent calls are
2582
socket.socket = self.socket_socket
2583
del self.socket_socket
2584
# This time only, return a new socket object from the
2585
# saved file descriptor.
2586
return socket.fromfd(self.socketfd, *args, **kwargs)
2587
# Replace socket.socket() function with wrapper
2588
socket.socket = socket_wrapper
2589
# The socketserver.TCPServer.__init__ will call
2590
# socket.socket(), which might be our replacement,
2591
# socket_wrapper(), if socketfd was set.
2592
1356
socketserver.TCPServer.__init__(self, server_address,
2593
1357
RequestHandlerClass)
2595
1358
def server_bind(self):
2596
1359
"""This overrides the normal server_bind() function
2597
1360
to bind to an interface if one was specified, and also NOT to
2598
1361
bind to an address or port if they were not specified."""
2599
global SO_BINDTODEVICE
2600
1362
if self.interface is not None:
2601
1363
if SO_BINDTODEVICE is None:
2602
# Fall back to a hard-coded value which seems to be
2604
logger.warning("SO_BINDTODEVICE not found, trying 25")
2605
SO_BINDTODEVICE = 25
2607
self.socket.setsockopt(
2608
socket.SOL_SOCKET, SO_BINDTODEVICE,
2609
(self.interface + "\0").encode("utf-8"))
2610
except socket.error as error:
2611
if error.errno == errno.EPERM:
2612
logger.error("No permission to bind to"
2613
" interface %s", self.interface)
2614
elif error.errno == errno.ENOPROTOOPT:
2615
logger.error("SO_BINDTODEVICE not available;"
2616
" cannot bind to interface %s",
2618
elif error.errno == errno.ENODEV:
2619
logger.error("Interface %s does not exist,"
2620
" cannot bind", self.interface)
1364
logger.error(u"SO_BINDTODEVICE does not exist;"
1365
u" cannot bind to interface %s",
1369
self.socket.setsockopt(socket.SOL_SOCKET,
1373
except socket.error, error:
1374
if error[0] == errno.EPERM:
1375
logger.error(u"No permission to"
1376
u" bind to interface %s",
1378
elif error[0] == errno.ENOPROTOOPT:
1379
logger.error(u"SO_BINDTODEVICE not available;"
1380
u" cannot bind to interface %s",
2623
1384
# Only bind(2) the socket if we really need to.
2624
1385
if self.server_address[0] or self.server_address[1]:
2625
if self.server_address[1]:
2626
self.allow_reuse_address = True
2627
1386
if not self.server_address[0]:
2628
1387
if self.address_family == socket.AF_INET6:
2629
any_address = "::" # in6addr_any
1388
any_address = u"::" # in6addr_any
2631
any_address = "0.0.0.0" # INADDR_ANY
1390
any_address = socket.INADDR_ANY
2632
1391
self.server_address = (any_address,
2633
1392
self.server_address[1])
2634
1393
elif not self.server_address[1]:
2635
self.server_address = (self.server_address[0], 0)
1394
self.server_address = (self.server_address[0],
2636
1396
# if self.interface:
2637
1397
# self.server_address = (self.server_address[0],
2645
1405
class MandosServer(IPv6_TCPServer):
2646
1406
"""Mandos server.
2649
1409
clients: set of Client objects
2650
1410
gnutls_priority GnuTLS priority string
2651
1411
use_dbus: Boolean; to emit D-Bus signals or not
2653
Assumes a GLib.MainLoop event loop.
1413
Assumes a gobject.MainLoop event loop.
2656
1415
def __init__(self, server_address, RequestHandlerClass,
2660
gnutls_priority=None,
1416
interface=None, use_ipv6=True, clients=None,
1417
gnutls_priority=None, use_dbus=True):
2663
1418
self.enabled = False
2664
1419
self.clients = clients
2665
1420
if self.clients is None:
1421
self.clients = set()
2667
1422
self.use_dbus = use_dbus
2668
1423
self.gnutls_priority = gnutls_priority
2669
1424
IPv6_TCPServer.__init__(self, server_address,
2670
1425
RequestHandlerClass,
2671
interface=interface,
1426
interface = interface,
1427
use_ipv6 = use_ipv6)
2675
1428
def server_activate(self):
2676
1429
if self.enabled:
2677
1430
return socketserver.TCPServer.server_activate(self)
2679
1431
def enable(self):
2680
1432
self.enabled = True
2682
def add_pipe(self, parent_pipe, proc):
1433
def add_pipe(self, parent_pipe):
2683
1434
# Call "handle_ipc" for both data and EOF events
2685
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2686
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2687
functools.partial(self.handle_ipc,
2688
parent_pipe=parent_pipe,
2691
def handle_ipc(self, source, condition,
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))
1440
def handle_ipc(self, source, condition, parent_pipe=None,
2694
1441
client_object=None):
2695
# error, or the other end of multiprocessing.Pipe has closed
2696
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2697
# Wait for other process to exit
1443
gobject.IO_IN: u"IN", # There is data to read.
1444
gobject.IO_OUT: u"OUT", # Data can be written (without
1446
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1447
gobject.IO_ERR: u"ERR", # Error condition.
1448
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1449
# broken, usually for pipes and
1452
conditions_string = ' | '.join(name
1454
condition_names.iteritems()
1455
if cond & condition)
1456
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
2701
1459
# Read a request from the child
2702
1460
request = parent_pipe.recv()
2703
1461
command = request[0]
2705
1463
if command == 'init':
2706
key_id = request[1].decode("ascii")
2707
fpr = request[2].decode("ascii")
2708
address = request[3]
2710
for c in self.clients.values():
2711
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2713
if key_id and c.key_id == key_id:
2716
if fpr and c.fingerprint == fpr:
1465
address = request[2]
1467
for c in self.clients:
1468
if c.fingerprint == fpr:
2720
logger.info("Client not found for key ID: %s, address"
2721
": %s", key_id or fpr, address)
1472
logger.warning(u"Client not found for fingerprint: %s, ad"
1473
u"dress: %s", fpr, address)
2722
1474
if self.use_dbus:
2723
1475
# Emit D-Bus signal
2724
mandos_dbus_service.ClientNotFound(key_id or fpr,
1476
mandos_dbus_service.ClientNotFound(fpr, address)
2726
1477
parent_pipe.send(False)
2730
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2731
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2732
functools.partial(self.handle_ipc,
2733
parent_pipe=parent_pipe,
2735
client_object=client))
1480
gobject.io_add_watch(parent_pipe.fileno(),
1481
gobject.IO_IN | gobject.IO_HUP,
1482
functools.partial(self.handle_ipc,
1483
parent_pipe = parent_pipe,
1484
client_object = client))
2736
1485
parent_pipe.send(True)
2737
# remove the old hook in favor of the new above hook on
1486
# remove the old hook in favor of the new above hook on same fileno
2740
1488
if command == 'funcall':
2741
1489
funcname = request[1]
2742
1490
args = request[2]
2743
1491
kwargs = request[3]
2745
parent_pipe.send(('data', getattr(client_object,
1493
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2749
1495
if command == 'getattr':
2750
1496
attrname = request[1]
2751
if isinstance(client_object.__getattribute__(attrname),
2752
collections.Callable):
2753
parent_pipe.send(('function', ))
1497
if callable(client_object.__getattribute__(attrname)):
1498
parent_pipe.send(('function',))
2756
'data', client_object.__getattribute__(attrname)))
1500
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2758
1502
if command == 'setattr':
2759
1503
attrname = request[1]
2760
1504
value = request[2]
2761
1505
setattr(client_object, attrname, value)
2766
def rfc3339_duration_to_delta(duration):
2767
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2769
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2771
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2773
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2775
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2777
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2779
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2781
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2785
# Parsing an RFC 3339 duration with regular expressions is not
2786
# possible - there would have to be multiple places for the same
2787
# values, like seconds. The current code, while more esoteric, is
2788
# cleaner without depending on a parsing library. If Python had a
2789
# built-in library for parsing we would use it, but we'd like to
2790
# avoid excessive use of external libraries.
2792
# New type for defining tokens, syntax, and semantics all-in-one
2793
Token = collections.namedtuple("Token", (
2794
"regexp", # To match token; if "value" is not None, must have
2795
# a "group" containing digits
2796
"value", # datetime.timedelta or None
2797
"followers")) # Tokens valid after this token
2798
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2799
# the "duration" ABNF definition in RFC 3339, Appendix A.
2800
token_end = Token(re.compile(r"$"), None, frozenset())
2801
token_second = Token(re.compile(r"(\d+)S"),
2802
datetime.timedelta(seconds=1),
2803
frozenset((token_end, )))
2804
token_minute = Token(re.compile(r"(\d+)M"),
2805
datetime.timedelta(minutes=1),
2806
frozenset((token_second, token_end)))
2807
token_hour = Token(re.compile(r"(\d+)H"),
2808
datetime.timedelta(hours=1),
2809
frozenset((token_minute, token_end)))
2810
token_time = Token(re.compile(r"T"),
2812
frozenset((token_hour, token_minute,
2814
token_day = Token(re.compile(r"(\d+)D"),
2815
datetime.timedelta(days=1),
2816
frozenset((token_time, token_end)))
2817
token_month = Token(re.compile(r"(\d+)M"),
2818
datetime.timedelta(weeks=4),
2819
frozenset((token_day, token_end)))
2820
token_year = Token(re.compile(r"(\d+)Y"),
2821
datetime.timedelta(weeks=52),
2822
frozenset((token_month, token_end)))
2823
token_week = Token(re.compile(r"(\d+)W"),
2824
datetime.timedelta(weeks=1),
2825
frozenset((token_end, )))
2826
token_duration = Token(re.compile(r"P"), None,
2827
frozenset((token_year, token_month,
2828
token_day, token_time,
2830
# Define starting values:
2832
value = datetime.timedelta()
2834
# Following valid tokens
2835
followers = frozenset((token_duration, ))
2836
# String left to parse
2838
# Loop until end token is found
2839
while found_token is not token_end:
2840
# Search for any currently valid tokens
2841
for token in followers:
2842
match = token.regexp.match(s)
2843
if match is not None:
2845
if token.value is not None:
2846
# Value found, parse digits
2847
factor = int(match.group(1), 10)
2848
# Add to value so far
2849
value += factor * token.value
2850
# Strip token from string
2851
s = token.regexp.sub("", s, 1)
2854
# Set valid next tokens
2855
followers = found_token.followers
2858
# No currently valid tokens were found
2859
raise ValueError("Invalid RFC 3339 duration: {!r}"
2865
1510
def string_to_delta(interval):
2866
1511
"""Parse a string and return a datetime.timedelta
2868
>>> string_to_delta('7d') == datetime.timedelta(7)
2870
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2872
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2874
>>> string_to_delta('24h') == datetime.timedelta(1)
2876
>>> string_to_delta('1w') == datetime.timedelta(7)
2878
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
1513
>>> string_to_delta(u'7d')
1514
datetime.timedelta(7)
1515
>>> string_to_delta(u'60s')
1516
datetime.timedelta(0, 60)
1517
>>> string_to_delta(u'60m')
1518
datetime.timedelta(0, 3600)
1519
>>> string_to_delta(u'24h')
1520
datetime.timedelta(1)
1521
>>> string_to_delta(u'1w')
1522
datetime.timedelta(7)
1523
>>> string_to_delta(u'5m 30s')
1524
datetime.timedelta(0, 330)
2883
return rfc3339_duration_to_delta(interval)
2887
1526
timevalue = datetime.timedelta(0)
2888
1527
for s in interval.split():
1529
suffix = unicode(s[-1])
2891
1530
value = int(s[:-1])
2893
1532
delta = datetime.timedelta(value)
1533
elif suffix == u"s":
2895
1534
delta = datetime.timedelta(0, value)
1535
elif suffix == u"m":
2897
1536
delta = datetime.timedelta(0, 0, 0, 0, value)
1537
elif suffix == u"h":
2899
1538
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1539
elif suffix == u"w":
2901
1540
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2903
raise ValueError("Unknown suffix {!r}".format(suffix))
2904
except IndexError as e:
2905
raise ValueError(*(e.args))
1542
raise ValueError(u"Unknown suffix %r" % suffix)
1543
except (ValueError, IndexError), e:
1544
raise ValueError(e.message)
2906
1545
timevalue += delta
2907
1546
return timevalue
2910
def daemon(nochdir=False, noclose=False):
1549
def if_nametoindex(interface):
1550
"""Call the C function if_nametoindex(), or equivalent
1552
Note: This function cannot accept a unicode string."""
1553
global if_nametoindex
1555
if_nametoindex = (ctypes.cdll.LoadLibrary
1556
(ctypes.util.find_library(u"c"))
1558
except (OSError, AttributeError):
1559
logger.warning(u"Doing if_nametoindex the hard way")
1560
def if_nametoindex(interface):
1561
"Get an interface index the hard way, i.e. using fcntl()"
1562
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1563
with contextlib.closing(socket.socket()) as s:
1564
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1565
struct.pack(str(u"16s16x"),
1567
interface_index = struct.unpack(str(u"I"),
1569
return interface_index
1570
return if_nametoindex(interface)
1573
def daemon(nochdir = False, noclose = False):
2911
1574
"""See daemon(3). Standard BSD Unix function.
2913
1576
This should really exist as os.daemon, but it doesn't (yet)."""
2917
1580
if not nochdir:
2921
1584
if not noclose:
2922
1585
# Close all standard open file descriptors
2923
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1586
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2924
1587
if not stat.S_ISCHR(os.fstat(null).st_mode):
2925
1588
raise OSError(errno.ENODEV,
2926
"{} not a character device"
2927
.format(os.devnull))
1589
u"%s not a character device"
2928
1591
os.dup2(null, sys.stdin.fileno())
2929
1592
os.dup2(null, sys.stdout.fileno())
2930
1593
os.dup2(null, sys.stderr.fileno())
2937
1600
##################################################################
2938
1601
# Parsing of options, both command line and config file
2940
parser = argparse.ArgumentParser()
2941
parser.add_argument("-v", "--version", action="version",
2942
version="%(prog)s {}".format(version),
2943
help="show version number and exit")
2944
parser.add_argument("-i", "--interface", metavar="IF",
2945
help="Bind to interface IF")
2946
parser.add_argument("-a", "--address",
2947
help="Address to listen for requests on")
2948
parser.add_argument("-p", "--port", type=int,
2949
help="Port number to receive requests on")
2950
parser.add_argument("--check", action="store_true",
2951
help="Run self-test")
2952
parser.add_argument("--debug", action="store_true",
2953
help="Debug mode; run in foreground and log"
2954
" to terminal", default=None)
2955
parser.add_argument("--debuglevel", metavar="LEVEL",
2956
help="Debug level for stdout output")
2957
parser.add_argument("--priority", help="GnuTLS"
2958
" priority string (see GnuTLS documentation)")
2959
parser.add_argument("--servicename",
2960
metavar="NAME", help="Zeroconf service name")
2961
parser.add_argument("--configdir",
2962
default="/etc/mandos", metavar="DIR",
2963
help="Directory to search for configuration"
2965
parser.add_argument("--no-dbus", action="store_false",
2966
dest="use_dbus", help="Do not provide D-Bus"
2967
" system bus interface", default=None)
2968
parser.add_argument("--no-ipv6", action="store_false",
2969
dest="use_ipv6", help="Do not use IPv6",
2971
parser.add_argument("--no-restore", action="store_false",
2972
dest="restore", help="Do not restore stored"
2973
" state", default=None)
2974
parser.add_argument("--socket", type=int,
2975
help="Specify a file descriptor to a network"
2976
" socket to use instead of creating one")
2977
parser.add_argument("--statedir", metavar="DIR",
2978
help="Directory to save/restore state in")
2979
parser.add_argument("--foreground", action="store_true",
2980
help="Run in foreground", default=None)
2981
parser.add_argument("--no-zeroconf", action="store_false",
2982
dest="zeroconf", help="Do not use Zeroconf",
2985
options = parser.parse_args()
1603
parser = optparse.OptionParser(version = "%%prog %s" % version)
1604
parser.add_option("-i", u"--interface", type=u"string",
1605
metavar="IF", help=u"Bind to interface IF")
1606
parser.add_option("-a", u"--address", type=u"string",
1607
help=u"Address to listen for requests on")
1608
parser.add_option("-p", u"--port", type=u"int",
1609
help=u"Port number to receive requests on")
1610
parser.add_option("--check", action=u"store_true",
1611
help=u"Run self-test")
1612
parser.add_option("--debug", action=u"store_true",
1613
help=u"Debug mode; run in foreground and log to"
1615
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1616
u" priority string (see GnuTLS documentation)")
1617
parser.add_option("--servicename", type=u"string",
1618
metavar=u"NAME", help=u"Zeroconf service name")
1619
parser.add_option("--configdir", type=u"string",
1620
default=u"/etc/mandos", metavar=u"DIR",
1621
help=u"Directory to search for configuration"
1623
parser.add_option("--no-dbus", action=u"store_false",
1624
dest=u"use_dbus", help=u"Do not provide D-Bus"
1625
u" system bus interface")
1626
parser.add_option("--no-ipv6", action=u"store_false",
1627
dest=u"use_ipv6", help=u"Do not use IPv6")
1628
options = parser.parse_args()[0]
2987
1635
# Default values for config file for server-global settings
2988
if gnutls.has_rawpk:
2989
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2990
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2992
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2993
":+SIGN-DSA-SHA256")
2994
server_defaults = {"interface": "",
2998
"priority": priority,
2999
"servicename": "Mandos",
3005
"statedir": "/var/lib/mandos",
3006
"foreground": "False",
1636
server_defaults = { u"interface": u"",
1641
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1642
u"servicename": u"Mandos",
1643
u"use_dbus": u"True",
1644
u"use_ipv6": u"True",
3011
1647
# Parse config file for server-global settings
3012
server_config = configparser.ConfigParser(server_defaults)
1648
server_config = configparser.SafeConfigParser(server_defaults)
3013
1649
del server_defaults
3014
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3015
# Convert the ConfigParser object to a dict
1650
server_config.read(os.path.join(options.configdir,
1652
# Convert the SafeConfigParser object to a dict
3016
1653
server_settings = server_config.defaults()
3017
1654
# Use the appropriate methods on the non-string config options
3018
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3019
"foreground", "zeroconf"):
3020
server_settings[option] = server_config.getboolean("DEFAULT",
1655
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1656
server_settings[option] = server_config.getboolean(u"DEFAULT",
3022
1658
if server_settings["port"]:
3023
server_settings["port"] = server_config.getint("DEFAULT",
3025
if server_settings["socket"]:
3026
server_settings["socket"] = server_config.getint("DEFAULT",
3028
# Later, stdin will, and stdout and stderr might, be dup'ed
3029
# over with an opened os.devnull. But we don't want this to
3030
# happen with a supplied network socket.
3031
if 0 <= server_settings["socket"] <= 2:
3032
server_settings["socket"] = os.dup(server_settings
1659
server_settings["port"] = server_config.getint(u"DEFAULT",
3034
1661
del server_config
3036
1663
# Override the settings from the config file with command line
3037
1664
# options, if set.
3038
for option in ("interface", "address", "port", "debug",
3039
"priority", "servicename", "configdir", "use_dbus",
3040
"use_ipv6", "debuglevel", "restore", "statedir",
3041
"socket", "foreground", "zeroconf"):
1665
for option in (u"interface", u"address", u"port", u"debug",
1666
u"priority", u"servicename", u"configdir",
1667
u"use_dbus", u"use_ipv6"):
3042
1668
value = getattr(options, option)
3043
1669
if value is not None:
3044
1670
server_settings[option] = value
3046
1672
# Force all strings to be unicode
3047
1673
for option in server_settings.keys():
3048
if isinstance(server_settings[option], bytes):
3049
server_settings[option] = (server_settings[option]
3051
# Force all boolean options to be boolean
3052
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3053
"foreground", "zeroconf"):
3054
server_settings[option] = bool(server_settings[option])
3055
# Debug implies foreground
3056
if server_settings["debug"]:
3057
server_settings["foreground"] = True
1674
if type(server_settings[option]) is str:
1675
server_settings[option] = unicode(server_settings[option])
3058
1676
# Now we have our good server settings in "server_settings"
3060
1678
##################################################################
3062
if (not server_settings["zeroconf"]
3063
and not (server_settings["port"]
3064
or server_settings["socket"] != "")):
3065
parser.error("Needs port or socket to work without Zeroconf")
3067
1680
# For convenience
3068
debug = server_settings["debug"]
3069
debuglevel = server_settings["debuglevel"]
3070
use_dbus = server_settings["use_dbus"]
3071
use_ipv6 = server_settings["use_ipv6"]
3072
stored_state_path = os.path.join(server_settings["statedir"],
3074
foreground = server_settings["foreground"]
3075
zeroconf = server_settings["zeroconf"]
3078
initlogger(debug, logging.DEBUG)
3083
level = getattr(logging, debuglevel.upper())
3084
initlogger(debug, level)
3086
if server_settings["servicename"] != "Mandos":
3087
syslogger.setFormatter(
3088
logging.Formatter('Mandos ({}) [%(process)d]:'
3089
' %(levelname)s: %(message)s'.format(
3090
server_settings["servicename"])))
1681
debug = server_settings[u"debug"]
1682
use_dbus = server_settings[u"use_dbus"]
1683
use_ipv6 = server_settings[u"use_ipv6"]
1686
syslogger.setLevel(logging.WARNING)
1687
console.setLevel(logging.WARNING)
1689
if server_settings[u"servicename"] != u"Mandos":
1690
syslogger.setFormatter(logging.Formatter
1691
(u'Mandos (%s) [%%(process)d]:'
1692
u' %%(levelname)s: %%(message)s'
1693
% server_settings[u"servicename"]))
3092
1695
# Parse config file with clients
3093
client_config = configparser.ConfigParser(Client.client_defaults)
3094
client_config.read(os.path.join(server_settings["configdir"],
1696
client_defaults = { u"timeout": u"1h",
1698
u"checker": u"fping -q -- %%(host)s",
1700
u"approved_delay": u"0s",
1701
u"approved_duration": u"1s",
1703
client_config = configparser.SafeConfigParser(client_defaults)
1704
client_config.read(os.path.join(server_settings[u"configdir"],
3097
1707
global mandos_dbus_service
3098
1708
mandos_dbus_service = None
3101
if server_settings["socket"] != "":
3102
socketfd = server_settings["socket"]
3103
tcp_server = MandosServer(
3104
(server_settings["address"], server_settings["port"]),
3106
interface=(server_settings["interface"] or None),
3108
gnutls_priority=server_settings["priority"],
3112
pidfilename = "/run/mandos.pid"
3113
if not os.path.isdir("/run/."):
3114
pidfilename = "/var/run/mandos.pid"
3117
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3118
except IOError as e:
3119
logger.error("Could not open file %r", pidfilename,
3122
for name, group in (("_mandos", "_mandos"),
3123
("mandos", "mandos"),
3124
("nobody", "nogroup")):
3126
uid = pwd.getpwnam(name).pw_uid
3127
gid = pwd.getpwnam(group).pw_gid
1710
tcp_server = MandosServer((server_settings[u"address"],
1711
server_settings[u"port"]),
1713
interface=server_settings[u"interface"],
1716
server_settings[u"priority"],
1718
pidfilename = u"/var/run/mandos.pid"
1720
pidfile = open(pidfilename, u"w")
1722
logger.error(u"Could not open file %r", pidfilename)
1725
uid = pwd.getpwnam(u"_mandos").pw_uid
1726
gid = pwd.getpwnam(u"_mandos").pw_gid
1729
uid = pwd.getpwnam(u"mandos").pw_uid
1730
gid = pwd.getpwnam(u"mandos").pw_gid
3129
1731
except KeyError:
1733
uid = pwd.getpwnam(u"nobody").pw_uid
1734
gid = pwd.getpwnam(u"nobody").pw_gid
3138
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3140
except OSError as error:
3141
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3142
.format(uid, gid, os.strerror(error.errno)))
3143
if error.errno != errno.EPERM:
1741
except OSError, error:
1742
if error[0] != errno.EPERM:
1745
# Enable all possible GnuTLS debugging
3147
# Enable all possible GnuTLS debugging
3149
1747
# "Use a log level over 10 to enable all debugging options."
3150
1748
# - GnuTLS manual
3151
gnutls.global_set_log_level(11)
1749
gnutls.library.functions.gnutls_global_set_log_level(11)
1751
@gnutls.library.types.gnutls_log_func
3154
1752
def debug_gnutls(level, string):
3155
logger.debug("GnuTLS: %s", string[:-1])
3157
gnutls.global_set_log_function(debug_gnutls)
3159
# Redirect stdin so all checkers get /dev/null
3160
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3161
os.dup2(null, sys.stdin.fileno())
3165
# Need to fork before connecting to D-Bus
3167
# Close all input and output, do double fork, etc.
3170
if gi.version_info < (3, 10, 2):
3171
# multiprocessing will use threads, so before we use GLib we
3172
# need to inform GLib that threads will be used.
1753
logger.debug(u"GnuTLS: %s", string[:-1])
1755
(gnutls.library.functions
1756
.gnutls_global_set_log_function(debug_gnutls))
3175
1758
global main_loop
3176
1759
# From the Avahi example code
3177
DBusGMainLoop(set_as_default=True)
3178
main_loop = GLib.MainLoop()
1760
DBusGMainLoop(set_as_default=True )
1761
main_loop = gobject.MainLoop()
3179
1762
bus = dbus.SystemBus()
3180
1763
# End of Avahi example code
3183
bus_name = dbus.service.BusName("se.recompile.Mandos",
3186
old_bus_name = dbus.service.BusName(
3187
"se.bsnet.fukt.Mandos", bus,
3189
except dbus.exceptions.DBusException as e:
3190
logger.error("Disabling D-Bus:", exc_info=e)
1766
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1767
bus, do_not_queue=True)
1768
except dbus.exceptions.NameExistsException, e:
1769
logger.error(unicode(e) + u", disabling D-Bus")
3191
1770
use_dbus = False
3192
server_settings["use_dbus"] = False
1771
server_settings[u"use_dbus"] = False
3193
1772
tcp_server.use_dbus = False
3195
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3196
service = AvahiServiceToSyslog(
3197
name=server_settings["servicename"],
3198
servicetype="_mandos._tcp",
3201
if server_settings["interface"]:
3202
service.interface = if_nametoindex(
3203
server_settings["interface"].encode("utf-8"))
3205
global multiprocessing_manager
3206
multiprocessing_manager = multiprocessing.Manager()
1773
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1774
service = AvahiService(name = server_settings[u"servicename"],
1775
servicetype = u"_mandos._tcp",
1776
protocol = protocol, bus = bus)
1777
if server_settings["interface"]:
1778
service.interface = (if_nametoindex
1779
(str(server_settings[u"interface"])))
3208
1781
client_class = Client
3210
client_class = functools.partial(ClientDBus, bus=bus)
3212
client_settings = Client.config_parser(client_config)
3213
old_client_settings = {}
3216
# This is used to redirect stdout and stderr for checker processes
3218
wnull = open(os.devnull, "w") # A writable /dev/null
3219
# Only used if server is running in foreground but not in debug
3221
if debug or not foreground:
3224
# Get client data and settings from last running state.
3225
if server_settings["restore"]:
3227
with open(stored_state_path, "rb") as stored_state:
3228
if sys.version_info.major == 2:
3229
clients_data, old_client_settings = pickle.load(
3232
bytes_clients_data, bytes_old_client_settings = (
3233
pickle.load(stored_state, encoding="bytes"))
3234
# Fix bytes to strings
3237
clients_data = {(key.decode("utf-8")
3238
if isinstance(key, bytes)
3241
bytes_clients_data.items()}
3242
del bytes_clients_data
3243
for key in clients_data:
3244
value = {(k.decode("utf-8")
3245
if isinstance(k, bytes) else k): v
3247
clients_data[key].items()}
3248
clients_data[key] = value
3250
value["client_structure"] = [
3252
if isinstance(s, bytes)
3254
value["client_structure"]]
3255
# .name, .host, and .checker_command
3256
for k in ("name", "host", "checker_command"):
3257
if isinstance(value[k], bytes):
3258
value[k] = value[k].decode("utf-8")
3259
if "key_id" not in value:
3260
value["key_id"] = ""
3261
elif "fingerprint" not in value:
3262
value["fingerprint"] = ""
3263
# old_client_settings
3265
old_client_settings = {
3266
(key.decode("utf-8")
3267
if isinstance(key, bytes)
3270
bytes_old_client_settings.items()}
3271
del bytes_old_client_settings
3272
# .host and .checker_command
3273
for value in old_client_settings.values():
3274
for attribute in ("host", "checker_command"):
3275
if isinstance(value[attribute], bytes):
3276
value[attribute] = (value[attribute]
3278
os.remove(stored_state_path)
3279
except IOError as e:
3280
if e.errno == errno.ENOENT:
3281
logger.warning("Could not load persistent state:"
3282
" {}".format(os.strerror(e.errno)))
3284
logger.critical("Could not load persistent state:",
3287
except EOFError as e:
3288
logger.warning("Could not load persistent state: "
3292
with PGPEngine() as pgp:
3293
for client_name, client in clients_data.items():
3294
# Skip removed clients
3295
if client_name not in client_settings:
3298
# Decide which value to use after restoring saved state.
3299
# We have three different values: Old config file,
3300
# new config file, and saved state.
3301
# New config value takes precedence if it differs from old
3302
# config value, otherwise use saved state.
3303
for name, value in client_settings[client_name].items():
3305
# For each value in new config, check if it
3306
# differs from the old config value (Except for
3307
# the "secret" attribute)
3308
if (name != "secret"
3310
old_client_settings[client_name][name])):
3311
client[name] = value
3315
# Clients who has passed its expire date can still be
3316
# enabled if its last checker was successful. A Client
3317
# whose checker succeeded before we stored its state is
3318
# assumed to have successfully run all checkers during
3320
if client["enabled"]:
3321
if datetime.datetime.utcnow() >= client["expires"]:
3322
if not client["last_checked_ok"]:
3324
"disabling client {} - Client never "
3325
"performed a successful checker".format(
3327
client["enabled"] = False
3328
elif client["last_checker_status"] != 0:
3330
"disabling client {} - Client last"
3331
" checker failed with error code"
3334
client["last_checker_status"]))
3335
client["enabled"] = False
3337
client["expires"] = (
3338
datetime.datetime.utcnow()
3339
+ client["timeout"])
3340
logger.debug("Last checker succeeded,"
3341
" keeping {} enabled".format(
1783
client_class = functools.partial(ClientDBus, bus = bus)
1784
def client_config_items(config, section):
1785
special_settings = {
1786
"approved_by_default":
1787
lambda: config.getboolean(section,
1788
"approved_by_default"),
1790
for name, value in config.items(section):
3344
client["secret"] = pgp.decrypt(
3345
client["encrypted_secret"],
3346
client_settings[client_name]["secret"])
3348
# If decryption fails, we use secret from new settings
3349
logger.debug("Failed to decrypt {} old secret".format(
3351
client["secret"] = (client_settings[client_name]
3354
# Add/remove clients based on new changes made to config
3355
for client_name in (set(old_client_settings)
3356
- set(client_settings)):
3357
del clients_data[client_name]
3358
for client_name in (set(client_settings)
3359
- set(old_client_settings)):
3360
clients_data[client_name] = client_settings[client_name]
3362
# Create all client objects
3363
for client_name, client in clients_data.items():
3364
tcp_server.clients[client_name] = client_class(
3367
server_settings=server_settings)
1792
yield (name, special_settings[name]())
1796
tcp_server.clients.update(set(
1797
client_class(name = section,
1798
config= dict(client_config_items(
1799
client_config, section)))
1800
for section in client_config.sections()))
3369
1801
if not tcp_server.clients:
3370
logger.warning("No clients defined")
3373
if pidfile is not None:
1802
logger.warning(u"No clients defined")
1805
# Redirect stdin so all checkers get /dev/null
1806
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1807
os.dup2(null, sys.stdin.fileno())
1811
# No console logging
1812
logger.removeHandler(console)
1813
# Close all input and output, do double fork, etc.
3374
1818
pid = os.getpid()
3377
print(pid, file=pidfile)
3379
logger.error("Could not write to file %r with PID %d",
1819
pidfile.write(str(pid) + "\n")
3384
for termsig in (signal.SIGHUP, signal.SIGTERM):
3385
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3386
lambda: main_loop.quit() and False)
1822
logger.error(u"Could not write to file %r with PID %d",
1825
# "pidfile" was never created
1830
signal.signal(signal.SIGINT, signal.SIG_IGN)
1831
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1832
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3390
@alternate_dbus_interfaces(
3391
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3392
class MandosDBusService(DBusObjectWithObjectManager):
1835
class MandosDBusService(dbus.service.Object):
3393
1836
"""A D-Bus proxy object"""
3395
1837
def __init__(self):
3396
dbus.service.Object.__init__(self, bus, "/")
3398
_interface = "se.recompile.Mandos"
3400
@dbus.service.signal(_interface, signature="o")
1838
dbus.service.Object.__init__(self, bus, u"/")
1839
_interface = u"se.bsnet.fukt.Mandos"
1841
@dbus.service.signal(_interface, signature=u"o")
3401
1842
def ClientAdded(self, objpath):
3405
@dbus.service.signal(_interface, signature="ss")
3406
def ClientNotFound(self, key_id, address):
1846
@dbus.service.signal(_interface, signature=u"ss")
1847
def ClientNotFound(self, fingerprint, address):
3410
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3412
@dbus.service.signal(_interface, signature="os")
1851
@dbus.service.signal(_interface, signature=u"os")
3413
1852
def ClientRemoved(self, objpath, name):
3417
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3419
@dbus.service.method(_interface, out_signature="ao")
1856
@dbus.service.method(_interface, out_signature=u"ao")
3420
1857
def GetAllClients(self):
3422
return dbus.Array(c.dbus_object_path for c in
3423
tcp_server.clients.values())
3425
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1859
return dbus.Array(c.dbus_object_path
1860
for c in tcp_server.clients)
3427
1862
@dbus.service.method(_interface,
3428
out_signature="a{oa{sv}}")
1863
out_signature=u"a{oa{sv}}")
3429
1864
def GetAllClientsWithProperties(self):
3431
1866
return dbus.Dictionary(
3432
{c.dbus_object_path: c.GetAll(
3433
"se.recompile.Mandos.Client")
3434
for c in tcp_server.clients.values()},
3437
@dbus.service.method(_interface, in_signature="o")
1867
((c.dbus_object_path, c.GetAll(u""))
1868
for c in tcp_server.clients),
1869
signature=u"oa{sv}")
1871
@dbus.service.method(_interface, in_signature=u"o")
3438
1872
def RemoveClient(self, object_path):
3440
for c in tcp_server.clients.values():
1874
for c in tcp_server.clients:
3441
1875
if c.dbus_object_path == object_path:
3442
del tcp_server.clients[c.name]
1876
tcp_server.clients.remove(c)
3443
1877
c.remove_from_connection()
3444
# Don't signal the disabling
1878
# Don't signal anything except ClientRemoved
3445
1879
c.disable(quiet=True)
3446
# Emit D-Bus signal for removal
3447
self.client_removed_signal(c)
1881
self.ClientRemoved(object_path, c.name)
3449
1883
raise KeyError(object_path)
3453
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3454
out_signature="a{oa{sa{sv}}}")
3455
def GetManagedObjects(self):
3457
return dbus.Dictionary(
3458
{client.dbus_object_path:
3460
{interface: client.GetAll(interface)
3462
client._get_all_interface_names()})
3463
for client in tcp_server.clients.values()})
3465
def client_added_signal(self, client):
3466
"""Send the new standard signal and the old signal"""
3468
# New standard signal
3469
self.InterfacesAdded(
3470
client.dbus_object_path,
3472
{interface: client.GetAll(interface)
3474
client._get_all_interface_names()}))
3476
self.ClientAdded(client.dbus_object_path)
3478
def client_removed_signal(self, client):
3479
"""Send the new standard signal and the old signal"""
3481
# New standard signal
3482
self.InterfacesRemoved(
3483
client.dbus_object_path,
3484
client._get_all_interface_names())
3486
self.ClientRemoved(client.dbus_object_path,
3489
1887
mandos_dbus_service = MandosDBusService()
3491
# Save modules to variables to exempt the modules from being
3492
# unloaded before the function registered with atexit() is run.
3493
mp = multiprocessing
3497
1890
"Cleanup function; run on exit"
3501
mp.active_children()
3503
if not (tcp_server.clients or client_settings):
3506
# Store client before exiting. Secrets are encrypted with key
3507
# based on what config file has. If config file is
3508
# removed/edited, old secret will thus be unrecovable.
3510
with PGPEngine() as pgp:
3511
for client in tcp_server.clients.values():
3512
key = client_settings[client.name]["secret"]
3513
client.encrypted_secret = pgp.encrypt(client.secret,
3517
# A list of attributes that can not be pickled
3519
exclude = {"bus", "changedstate", "secret",
3520
"checker", "server_settings"}
3521
for name, typ in inspect.getmembers(dbus.service
3525
client_dict["encrypted_secret"] = (client
3527
for attr in client.client_structure:
3528
if attr not in exclude:
3529
client_dict[attr] = getattr(client, attr)
3531
clients[client.name] = client_dict
3532
del client_settings[client.name]["secret"]
3535
with tempfile.NamedTemporaryFile(
3539
dir=os.path.dirname(stored_state_path),
3540
delete=False) as stored_state:
3541
pickle.dump((clients, client_settings), stored_state,
3543
tempname = stored_state.name
3544
os.rename(tempname, stored_state_path)
3545
except (IOError, OSError) as e:
3551
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3552
logger.warning("Could not save persistent state: {}"
3553
.format(os.strerror(e.errno)))
3555
logger.warning("Could not save persistent state:",
3559
# Delete all clients, and settings from config
3560
1893
while tcp_server.clients:
3561
name, client = tcp_server.clients.popitem()
1894
client = tcp_server.clients.pop()
3563
1896
client.remove_from_connection()
3564
# Don't signal the disabling
1897
client.disable_hook = None
1898
# Don't signal anything except ClientRemoved
3565
1899
client.disable(quiet=True)
3566
# Emit D-Bus signal for removal
3568
mandos_dbus_service.client_removed_signal(client)
3569
client_settings.clear()
1902
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3571
1905
atexit.register(cleanup)
3573
for client in tcp_server.clients.values():
1907
for client in tcp_server.clients:
3575
# Emit D-Bus signal for adding
3576
mandos_dbus_service.client_added_signal(client)
3577
# Need to initiate checking of clients
3579
client.init_checker()
1910
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3581
1913
tcp_server.enable()
3582
1914
tcp_server.server_activate()
3584
1916
# Find out what port we got
3586
service.port = tcp_server.socket.getsockname()[1]
1917
service.port = tcp_server.socket.getsockname()[1]
3588
logger.info("Now listening on address %r, port %d,"
3589
" flowinfo %d, scope_id %d",
3590
*tcp_server.socket.getsockname())
1919
logger.info(u"Now listening on address %r, port %d,"
1920
" flowinfo %d, scope_id %d"
1921
% tcp_server.socket.getsockname())
3592
logger.info("Now listening on address %r, port %d",
3593
*tcp_server.socket.getsockname())
3595
# service.interface = tcp_server.socket.getsockname()[3]
1923
logger.info(u"Now listening on address %r, port %d"
1924
% tcp_server.socket.getsockname())
1926
#service.interface = tcp_server.socket.getsockname()[3]
3599
# From the Avahi example code
3602
except dbus.exceptions.DBusException as error:
3603
logger.critical("D-Bus Exception", exc_info=error)
3606
# End of Avahi example code
3609
GLib.IOChannel.unix_new(tcp_server.fileno()),
3610
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3611
lambda *args, **kwargs: (tcp_server.handle_request
3612
(*args[2:], **kwargs) or True))
3614
logger.debug("Starting main loop")
1929
# From the Avahi example code
1932
except dbus.exceptions.DBusException, error:
1933
logger.critical(u"DBusException: %s", error)
1936
# End of Avahi example code
1938
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1939
lambda *args, **kwargs:
1940
(tcp_server.handle_request
1941
(*args[2:], **kwargs) or True))
1943
logger.debug(u"Starting main loop")
3615
1944
main_loop.run()
3616
except AvahiError as error:
3617
logger.critical("Avahi Error", exc_info=error)
1945
except AvahiError, error:
1946
logger.critical(u"AvahiError: %s", error)
3620
1949
except KeyboardInterrupt:
3622
print("", file=sys.stderr)
3623
logger.debug("Server received KeyboardInterrupt")
3624
logger.debug("Server exiting")
1952
logger.debug(u"Server received KeyboardInterrupt")
1953
logger.debug(u"Server exiting")
3625
1954
# Must run before the D-Bus bus name gets deregistered
3629
def should_only_run_tests():
3630
parser = argparse.ArgumentParser(add_help=False)
3631
parser.add_argument("--check", action='store_true')
3632
args, unknown_args = parser.parse_known_args()
3633
run_tests = args.check
3635
# Remove --check argument from sys.argv
3636
sys.argv[1:] = unknown_args
3639
# Add all tests from doctest strings
3640
def load_tests(loader, tests, none):
3642
tests.addTests(doctest.DocTestSuite())
3645
1957
if __name__ == '__main__':
3647
if should_only_run_tests():
3648
# Call using ./mandos --check [--verbose]