418
189
dbus.UInt16(self.port),
419
190
avahi.string_array_to_txt_array(self.TXT))
420
191
self.group.Commit()
422
192
def entry_group_state_changed(self, state, error):
423
193
"""Derived from the Avahi example code"""
424
logger.debug("Avahi entry group state change: %i", state)
194
logger.debug(u"Avahi state change: %i", state)
426
196
if state == avahi.ENTRY_GROUP_ESTABLISHED:
427
logger.debug("Zeroconf service established.")
197
logger.debug(u"Zeroconf service established.")
428
198
elif state == avahi.ENTRY_GROUP_COLLISION:
429
logger.info("Zeroconf service name collision.")
199
logger.warning(u"Zeroconf service name collision.")
431
201
elif state == avahi.ENTRY_GROUP_FAILURE:
432
logger.critical("Avahi: Error in group state changed %s",
434
raise AvahiGroupError("State changed: {!s}".format(error))
202
logger.critical(u"Avahi: Error in group state changed %s",
204
raise AvahiGroupError(u"State changed: %s"
436
206
def cleanup(self):
437
207
"""Derived from the Avahi example code"""
438
208
if self.group is not None:
441
except (dbus.exceptions.UnknownMethodException,
442
dbus.exceptions.DBusException):
444
210
self.group = None
447
def server_state_changed(self, state, error=None):
211
def server_state_changed(self, state):
448
212
"""Derived from the Avahi example code"""
449
logger.debug("Avahi server state change: %i", state)
451
avahi.SERVER_INVALID: "Zeroconf server invalid",
452
avahi.SERVER_REGISTERING: None,
453
avahi.SERVER_COLLISION: "Zeroconf server name collision",
454
avahi.SERVER_FAILURE: "Zeroconf server failure",
456
if state in bad_states:
457
if bad_states[state] is not None:
459
logger.error(bad_states[state])
461
logger.error(bad_states[state] + ": %r", error)
213
if state == avahi.SERVER_COLLISION:
214
logger.error(u"Zeroconf server name collision")
463
216
elif state == avahi.SERVER_RUNNING:
466
except dbus.exceptions.DBusException as error:
467
if (error.get_dbus_name()
468
== "org.freedesktop.Avahi.CollisionError"):
469
logger.info("Local Zeroconf service name"
471
return self.rename(remove=False)
473
logger.critical("D-Bus Exception", exc_info=error)
478
logger.debug("Unknown state: %r", state)
480
logger.debug("Unknown state: %r: %r", state, error)
482
218
def activate(self):
483
219
"""Derived from the Avahi example code"""
484
220
if self.server is None:
485
221
self.server = dbus.Interface(
486
222
self.bus.get_object(avahi.DBUS_NAME,
487
avahi.DBUS_PATH_SERVER,
488
follow_name_owner_changes=True),
223
avahi.DBUS_PATH_SERVER),
489
224
avahi.DBUS_INTERFACE_SERVER)
490
self.server.connect_to_signal("StateChanged",
491
self.server_state_changed)
225
self.server.connect_to_signal(u"StateChanged",
226
self.server_state_changed)
492
227
self.server_state_changed(self.server.GetState())
495
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
497
"""Add the new name to the syslog messages"""
498
ret = AvahiService.rename(self, *args, **kwargs)
499
syslogger.setFormatter(logging.Formatter(
500
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
505
# Pretend that we have a GnuTLS module
506
class GnuTLS(object):
507
"""This isn't so much a class as it is a module-like namespace.
508
It is instantiated once, and simulates having a GnuTLS module."""
510
_library = ctypes.cdll.LoadLibrary(
511
ctypes.util.find_library("gnutls"))
512
_need_version = b"3.3.0"
515
# Need to use class name "GnuTLS" here, since this method is
516
# called before the assignment to the "gnutls" global variable
518
if GnuTLS.check_version(self._need_version) is None:
519
raise GnuTLS.Error("Needs GnuTLS {} or later"
520
.format(self._need_version))
522
# Unless otherwise indicated, the constants and types below are
523
# all from the gnutls/gnutls.h C header file.
533
E_NO_CERTIFICATE_FOUND = -49
534
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
537
class session_int(ctypes.Structure):
539
session_t = ctypes.POINTER(session_int)
541
class certificate_credentials_st(ctypes.Structure):
543
certificate_credentials_t = ctypes.POINTER(
544
certificate_credentials_st)
545
certificate_type_t = ctypes.c_int
547
class datum_t(ctypes.Structure):
548
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
549
('size', ctypes.c_uint)]
551
class openpgp_crt_int(ctypes.Structure):
553
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
554
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
555
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
556
credentials_type_t = ctypes.c_int
557
transport_ptr_t = ctypes.c_void_p
558
close_request_t = ctypes.c_int
561
class Error(Exception):
562
# We need to use the class name "GnuTLS" here, since this
563
# exception might be raised from within GnuTLS.__init__,
564
# which is called before the assignment to the "gnutls"
565
# global variable has happened.
566
def __init__(self, message=None, code=None, args=()):
567
# Default usage is by a message string, but if a return
568
# code is passed, convert it to a string with
571
if message is None and code is not None:
572
message = GnuTLS.strerror(code)
573
return super(GnuTLS.Error, self).__init__(
576
class CertificateSecurityError(Error):
580
class Credentials(object):
582
self._c_object = gnutls.certificate_credentials_t()
583
gnutls.certificate_allocate_credentials(
584
ctypes.byref(self._c_object))
585
self.type = gnutls.CRD_CERTIFICATE
588
gnutls.certificate_free_credentials(self._c_object)
590
class ClientSession(object):
591
def __init__(self, socket, credentials=None):
592
self._c_object = gnutls.session_t()
593
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
594
gnutls.set_default_priority(self._c_object)
595
gnutls.transport_set_ptr(self._c_object, socket.fileno())
596
gnutls.handshake_set_private_extensions(self._c_object,
599
if credentials is None:
600
credentials = gnutls.Credentials()
601
gnutls.credentials_set(self._c_object, credentials.type,
602
ctypes.cast(credentials._c_object,
604
self.credentials = credentials
607
gnutls.deinit(self._c_object)
610
return gnutls.handshake(self._c_object)
612
def send(self, data):
616
data_len -= gnutls.record_send(self._c_object,
621
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
623
# Error handling functions
624
def _error_code(result):
625
"""A function to raise exceptions on errors, suitable
626
for the 'restype' attribute on ctypes functions"""
629
if result == gnutls.E_NO_CERTIFICATE_FOUND:
630
raise gnutls.CertificateSecurityError(code=result)
631
raise gnutls.Error(code=result)
633
def _retry_on_error(result, func, arguments):
634
"""A function to retry on some errors, suitable
635
for the 'errcheck' attribute on ctypes functions"""
637
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
638
return _error_code(result)
639
result = func(*arguments)
642
# Unless otherwise indicated, the function declarations below are
643
# all from the gnutls/gnutls.h C header file.
646
priority_set_direct = _library.gnutls_priority_set_direct
647
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
648
ctypes.POINTER(ctypes.c_char_p)]
649
priority_set_direct.restype = _error_code
651
init = _library.gnutls_init
652
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
653
init.restype = _error_code
655
set_default_priority = _library.gnutls_set_default_priority
656
set_default_priority.argtypes = [session_t]
657
set_default_priority.restype = _error_code
659
record_send = _library.gnutls_record_send
660
record_send.argtypes = [session_t, ctypes.c_void_p,
662
record_send.restype = ctypes.c_ssize_t
663
record_send.errcheck = _retry_on_error
665
certificate_allocate_credentials = (
666
_library.gnutls_certificate_allocate_credentials)
667
certificate_allocate_credentials.argtypes = [
668
ctypes.POINTER(certificate_credentials_t)]
669
certificate_allocate_credentials.restype = _error_code
671
certificate_free_credentials = (
672
_library.gnutls_certificate_free_credentials)
673
certificate_free_credentials.argtypes = [
674
certificate_credentials_t]
675
certificate_free_credentials.restype = None
677
handshake_set_private_extensions = (
678
_library.gnutls_handshake_set_private_extensions)
679
handshake_set_private_extensions.argtypes = [session_t,
681
handshake_set_private_extensions.restype = None
683
credentials_set = _library.gnutls_credentials_set
684
credentials_set.argtypes = [session_t, credentials_type_t,
686
credentials_set.restype = _error_code
688
strerror = _library.gnutls_strerror
689
strerror.argtypes = [ctypes.c_int]
690
strerror.restype = ctypes.c_char_p
692
certificate_type_get = _library.gnutls_certificate_type_get
693
certificate_type_get.argtypes = [session_t]
694
certificate_type_get.restype = _error_code
696
certificate_get_peers = _library.gnutls_certificate_get_peers
697
certificate_get_peers.argtypes = [session_t,
698
ctypes.POINTER(ctypes.c_uint)]
699
certificate_get_peers.restype = ctypes.POINTER(datum_t)
701
global_set_log_level = _library.gnutls_global_set_log_level
702
global_set_log_level.argtypes = [ctypes.c_int]
703
global_set_log_level.restype = None
705
global_set_log_function = _library.gnutls_global_set_log_function
706
global_set_log_function.argtypes = [log_func]
707
global_set_log_function.restype = None
709
deinit = _library.gnutls_deinit
710
deinit.argtypes = [session_t]
711
deinit.restype = None
713
handshake = _library.gnutls_handshake
714
handshake.argtypes = [session_t]
715
handshake.restype = _error_code
716
handshake.errcheck = _retry_on_error
718
transport_set_ptr = _library.gnutls_transport_set_ptr
719
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
720
transport_set_ptr.restype = None
722
bye = _library.gnutls_bye
723
bye.argtypes = [session_t, close_request_t]
724
bye.restype = _error_code
725
bye.errcheck = _retry_on_error
727
check_version = _library.gnutls_check_version
728
check_version.argtypes = [ctypes.c_char_p]
729
check_version.restype = ctypes.c_char_p
731
# All the function declarations below are from gnutls/openpgp.h
733
openpgp_crt_init = _library.gnutls_openpgp_crt_init
734
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
735
openpgp_crt_init.restype = _error_code
737
openpgp_crt_import = _library.gnutls_openpgp_crt_import
738
openpgp_crt_import.argtypes = [openpgp_crt_t,
739
ctypes.POINTER(datum_t),
741
openpgp_crt_import.restype = _error_code
743
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
744
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
745
ctypes.POINTER(ctypes.c_uint)]
746
openpgp_crt_verify_self.restype = _error_code
748
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
749
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
750
openpgp_crt_deinit.restype = None
752
openpgp_crt_get_fingerprint = (
753
_library.gnutls_openpgp_crt_get_fingerprint)
754
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
758
openpgp_crt_get_fingerprint.restype = _error_code
760
# Remove non-public functions
761
del _error_code, _retry_on_error
762
# Create the global "gnutls" object, simulating a module
766
def call_pipe(connection, # : multiprocessing.Connection
767
func, *args, **kwargs):
768
"""This function is meant to be called by multiprocessing.Process
770
This function runs func(*args, **kwargs), and writes the resulting
771
return value on the provided multiprocessing.Connection.
773
connection.send(func(*args, **kwargs))
777
230
class Client(object):
778
231
"""A representation of a client host served by this server.
781
approved: bool(); 'None' if not yet approved/disapproved
782
approval_delay: datetime.timedelta(); Time to wait for approval
783
approval_duration: datetime.timedelta(); Duration of one approval
234
name: string; from the config file, used in log messages and
236
fingerprint: string (40 or 32 hexadecimal digits); used to
237
uniquely identify the client
238
secret: bytestring; sent verbatim (over TLS) to client
239
host: string; available for use by the checker command
240
created: datetime.datetime(); (UTC) object creation
241
last_enabled: datetime.datetime(); (UTC)
243
last_checked_ok: datetime.datetime(); (UTC) or None
244
timeout: datetime.timedelta(); How long from last_checked_ok
245
until this client is invalid
246
interval: datetime.timedelta(); How often to start a new checker
247
disable_hook: If set, called by disable() as disable_hook(self)
784
248
checker: subprocess.Popen(); a running checker process used
785
249
to see if the client lives.
786
250
'None' if no process is running.
787
checker_callback_tag: a GLib event source tag, or None
788
checker_command: string; External command which is run to check
789
if client lives. %() expansions are done at
251
checker_initiator_tag: a gobject event source tag, or None
252
disable_initiator_tag: - '' -
253
checker_callback_tag: - '' -
254
checker_command: string; External command which is run to check if
255
client lives. %() expansions are done at
790
256
runtime with vars(self) as dict, so that for
791
257
instance %(name)s can be used in the command.
792
checker_initiator_tag: a GLib event source tag, or None
793
created: datetime.datetime(); (UTC) object creation
794
client_structure: Object describing what attributes a client has
795
and is used for storing the client at exit
796
258
current_checker_command: string; current running checker_command
797
disable_initiator_tag: a GLib event source tag, or None
799
fingerprint: string (40 or 32 hexadecimal digits); used to
800
uniquely identify the client
801
host: string; available for use by the checker command
802
interval: datetime.timedelta(); How often to start a new checker
803
last_approval_request: datetime.datetime(); (UTC) or None
804
last_checked_ok: datetime.datetime(); (UTC) or None
805
last_checker_status: integer between 0 and 255 reflecting exit
806
status of last checker. -1 reflects crashed
807
checker, -2 means no checker completed yet.
808
last_checker_signal: The signal which killed the last checker, if
809
last_checker_status is -1
810
last_enabled: datetime.datetime(); (UTC) or None
811
name: string; from the config file, used in log messages and
813
secret: bytestring; sent verbatim (over TLS) to client
814
timeout: datetime.timedelta(); How long from last_checked_ok
815
until this client is disabled
816
extended_timeout: extra long timeout when secret has been sent
817
runtime_expansions: Allowed attributes for runtime expansion.
818
expires: datetime.datetime(); time (UTC) when a client will be
820
server_settings: The server_settings dict from main()
823
runtime_expansions = ("approval_delay", "approval_duration",
824
"created", "enabled", "expires",
825
"fingerprint", "host", "interval",
826
"last_approval_request", "last_checked_ok",
827
"last_enabled", "name", "timeout")
830
"extended_timeout": "PT15M",
832
"checker": "fping -q -- %%(host)s",
834
"approval_delay": "PT0S",
835
"approval_duration": "PT1S",
836
"approved_by_default": "True",
841
def config_parser(config):
842
"""Construct a new dict of client settings of this form:
843
{ client_name: {setting_name: value, ...}, ...}
844
with exceptions for any special settings as defined above.
845
NOTE: Must be a pure function. Must return the same result
846
value given the same arguments.
849
for client_name in config.sections():
850
section = dict(config.items(client_name))
851
client = settings[client_name] = {}
853
client["host"] = section["host"]
854
# Reformat values from string types to Python types
855
client["approved_by_default"] = config.getboolean(
856
client_name, "approved_by_default")
857
client["enabled"] = config.getboolean(client_name,
860
# Uppercase and remove spaces from fingerprint for later
861
# comparison purposes with return value from the
862
# fingerprint() function
863
client["fingerprint"] = (section["fingerprint"].upper()
865
if "secret" in section:
866
client["secret"] = codecs.decode(section["secret"]
869
elif "secfile" in section:
870
with open(os.path.expanduser(os.path.expandvars
871
(section["secfile"])),
873
client["secret"] = secfile.read()
875
raise TypeError("No secret or secfile for section {}"
877
client["timeout"] = string_to_delta(section["timeout"])
878
client["extended_timeout"] = string_to_delta(
879
section["extended_timeout"])
880
client["interval"] = string_to_delta(section["interval"])
881
client["approval_delay"] = string_to_delta(
882
section["approval_delay"])
883
client["approval_duration"] = string_to_delta(
884
section["approval_duration"])
885
client["checker_command"] = section["checker"]
886
client["last_approval_request"] = None
887
client["last_checked_ok"] = None
888
client["last_checker_status"] = -2
892
def __init__(self, settings, name=None, server_settings=None):
262
def _timedelta_to_milliseconds(td):
263
"Convert a datetime.timedelta() to milliseconds"
264
return ((td.days * 24 * 60 * 60 * 1000)
265
+ (td.seconds * 1000)
266
+ (td.microseconds // 1000))
268
def timeout_milliseconds(self):
269
"Return the 'timeout' attribute in milliseconds"
270
return self._timedelta_to_milliseconds(self.timeout)
272
def interval_milliseconds(self):
273
"Return the 'interval' attribute in milliseconds"
274
return self._timedelta_to_milliseconds(self.interval)
276
def __init__(self, name = None, disable_hook=None, config=None):
277
"""Note: the 'checker' key in 'config' sets the
278
'checker_command' attribute and *not* the 'checker'
894
if server_settings is None:
896
self.server_settings = server_settings
897
# adding all client settings
898
for setting, value in settings.items():
899
setattr(self, setting, value)
902
if not hasattr(self, "last_enabled"):
903
self.last_enabled = datetime.datetime.utcnow()
904
if not hasattr(self, "expires"):
905
self.expires = (datetime.datetime.utcnow()
283
logger.debug(u"Creating client %r", self.name)
284
# Uppercase and remove spaces from fingerprint for later
285
# comparison purposes with return value from the fingerprint()
287
self.fingerprint = (config[u"fingerprint"].upper()
289
logger.debug(u" Fingerprint: %s", self.fingerprint)
290
if u"secret" in config:
291
self.secret = config[u"secret"].decode(u"base64")
292
elif u"secfile" in config:
293
with closing(open(os.path.expanduser
295
(config[u"secfile"])))) as secfile:
296
self.secret = secfile.read()
908
self.last_enabled = None
911
logger.debug("Creating client %r", self.name)
912
logger.debug(" Fingerprint: %s", self.fingerprint)
913
self.created = settings.get("created",
914
datetime.datetime.utcnow())
916
# attributes specific for this server instance
298
raise TypeError(u"No secret or secfile for client %s"
300
self.host = config.get(u"host", u"")
301
self.created = datetime.datetime.utcnow()
303
self.last_enabled = None
304
self.last_checked_ok = None
305
self.timeout = string_to_delta(config[u"timeout"])
306
self.interval = string_to_delta(config[u"interval"])
307
self.disable_hook = disable_hook
917
308
self.checker = None
918
309
self.checker_initiator_tag = None
919
310
self.disable_initiator_tag = None
920
311
self.checker_callback_tag = None
312
self.checker_command = config[u"checker"]
921
313
self.current_checker_command = None
923
self.approvals_pending = 0
924
self.changedstate = multiprocessing_manager.Condition(
925
multiprocessing_manager.Lock())
926
self.client_structure = [attr
927
for attr in self.__dict__.keys()
928
if not attr.startswith("_")]
929
self.client_structure.append("client_structure")
931
for name, t in inspect.getmembers(
932
type(self), lambda obj: isinstance(obj, property)):
933
if not name.startswith("_"):
934
self.client_structure.append(name)
936
# Send notice to process children that client state has changed
937
def send_changedstate(self):
938
with self.changedstate:
939
self.changedstate.notify_all()
314
self.last_connect = None
941
316
def enable(self):
942
317
"""Start this client's checker and timeout hooks"""
943
if getattr(self, "enabled", False):
318
if getattr(self, u"enabled", False):
944
319
# Already enabled
946
self.expires = datetime.datetime.utcnow() + self.timeout
948
321
self.last_enabled = datetime.datetime.utcnow()
950
self.send_changedstate()
952
def disable(self, quiet=True):
322
# Schedule a new checker to be started an 'interval' from now,
323
# and every interval from then on.
324
self.checker_initiator_tag = (gobject.timeout_add
325
(self.interval_milliseconds(),
327
# Also start a new checker *right now*.
329
# Schedule a disable() when 'timeout' has passed
330
self.disable_initiator_tag = (gobject.timeout_add
331
(self.timeout_milliseconds(),
953
336
"""Disable this client."""
954
337
if not getattr(self, "enabled", False):
957
logger.info("Disabling client %s", self.name)
958
if getattr(self, "disable_initiator_tag", None) is not None:
959
GLib.source_remove(self.disable_initiator_tag)
339
logger.info(u"Disabling client %s", self.name)
340
if getattr(self, u"disable_initiator_tag", False):
341
gobject.source_remove(self.disable_initiator_tag)
960
342
self.disable_initiator_tag = None
962
if getattr(self, "checker_initiator_tag", None) is not None:
963
GLib.source_remove(self.checker_initiator_tag)
343
if getattr(self, u"checker_initiator_tag", False):
344
gobject.source_remove(self.checker_initiator_tag)
964
345
self.checker_initiator_tag = None
965
346
self.stop_checker()
347
if self.disable_hook:
348
self.disable_hook(self)
966
349
self.enabled = False
968
self.send_changedstate()
969
# Do not run this again if called by a GLib.timeout_add
350
# Do not run this again if called by a gobject.timeout_add
972
353
def __del__(self):
354
self.disable_hook = None
975
def init_checker(self):
976
# Schedule a new checker to be started an 'interval' from now,
977
# and every interval from then on.
978
if self.checker_initiator_tag is not None:
979
GLib.source_remove(self.checker_initiator_tag)
980
self.checker_initiator_tag = GLib.timeout_add(
981
int(self.interval.total_seconds() * 1000),
983
# Schedule a disable() when 'timeout' has passed
984
if self.disable_initiator_tag is not None:
985
GLib.source_remove(self.disable_initiator_tag)
986
self.disable_initiator_tag = GLib.timeout_add(
987
int(self.timeout.total_seconds() * 1000), self.disable)
988
# Also start a new checker *right now*.
991
def checker_callback(self, source, condition, connection,
357
def checker_callback(self, pid, condition, command):
993
358
"""The checker has completed, so take appropriate actions."""
994
359
self.checker_callback_tag = None
995
360
self.checker = None
996
# Read return code from connection (see call_pipe)
997
returncode = connection.recv()
1001
self.last_checker_status = returncode
1002
self.last_checker_signal = None
1003
if self.last_checker_status == 0:
1004
logger.info("Checker for %(name)s succeeded",
361
if os.WIFEXITED(condition):
362
exitstatus = os.WEXITSTATUS(condition)
364
logger.info(u"Checker for %(name)s succeeded",
1006
366
self.checked_ok()
1008
logger.info("Checker for %(name)s failed", vars(self))
368
logger.info(u"Checker for %(name)s failed",
1010
self.last_checker_status = -1
1011
self.last_checker_signal = -returncode
1012
logger.warning("Checker for %(name)s crashed?",
371
logger.warning(u"Checker for %(name)s crashed?",
1016
374
def checked_ok(self):
1017
"""Assert that the client has been seen, alive and well."""
375
"""Bump up the timeout for this client.
377
This should only be called when the client has been seen,
1018
380
self.last_checked_ok = datetime.datetime.utcnow()
1019
self.last_checker_status = 0
1020
self.last_checker_signal = None
1023
def bump_timeout(self, timeout=None):
1024
"""Bump up the timeout for this client."""
1026
timeout = self.timeout
1027
if self.disable_initiator_tag is not None:
1028
GLib.source_remove(self.disable_initiator_tag)
1029
self.disable_initiator_tag = None
1030
if getattr(self, "enabled", False):
1031
self.disable_initiator_tag = GLib.timeout_add(
1032
int(timeout.total_seconds() * 1000), self.disable)
1033
self.expires = datetime.datetime.utcnow() + timeout
1035
def need_approval(self):
1036
self.last_approval_request = datetime.datetime.utcnow()
381
gobject.source_remove(self.disable_initiator_tag)
382
self.disable_initiator_tag = (gobject.timeout_add
383
(self.timeout_milliseconds(),
1038
386
def start_checker(self):
1039
387
"""Start a new checker subprocess if one is not running.
1041
389
If a checker already exists, leave it running and do
1043
391
# The reason for not killing a running checker is that if we
1044
# did that, and if a checker (for some reason) started running
1045
# slowly and taking more than 'interval' time, then the client
1046
# would inevitably timeout, since no checker would get a
1047
# chance to run to completion. If we instead leave running
392
# did that, then if a checker (for some reason) started
393
# running slowly and taking more than 'interval' time, the
394
# client would inevitably timeout, since no checker would get
395
# a chance to run to completion. If we instead leave running
1048
396
# checkers alone, the checker would have to take more time
1049
# than 'timeout' for the client to be disabled, which is as it
1052
if self.checker is not None and not self.checker.is_alive():
1053
logger.warning("Checker was not alive; joining")
397
# than 'timeout' for the client to be declared invalid, which
398
# is as it should be.
400
# If a checker exists, make sure it is not a zombie
402
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
403
except (AttributeError, OSError), error:
404
if (isinstance(error, OSError)
405
and error.errno != errno.ECHILD):
409
logger.warning(u"Checker was a zombie")
410
gobject.source_remove(self.checker_callback_tag)
411
self.checker_callback(pid, status,
412
self.current_checker_command)
1056
413
# Start a new checker if needed
1057
414
if self.checker is None:
1058
# Escape attributes for the shell
1060
attr: re.escape(str(getattr(self, attr)))
1061
for attr in self.runtime_expansions}
1063
command = self.checker_command % escaped_attrs
1064
except TypeError as error:
1065
logger.error('Could not format string "%s"',
1066
self.checker_command,
1068
return True # Try again later
416
# In case checker_command has exactly one % operator
417
command = self.checker_command % self.host
419
# Escape attributes for the shell
420
escaped_attrs = dict((key,
421
re.escape(unicode(str(val),
425
vars(self).iteritems())
427
command = self.checker_command % escaped_attrs
428
except TypeError, error:
429
logger.error(u'Could not format string "%s":'
430
u' %s', self.checker_command, error)
431
return True # Try again later
1069
432
self.current_checker_command = command
1070
logger.info("Starting checker %r for %s", command,
1072
# We don't need to redirect stdout and stderr, since
1073
# in normal mode, that is already done by daemon(),
1074
# and in debug mode we don't want to. (Stdin is
1075
# always replaced by /dev/null.)
1076
# The exception is when not debugging but nevertheless
1077
# running in the foreground; use the previously
1079
popen_args = {"close_fds": True,
1082
if (not self.server_settings["debug"]
1083
and self.server_settings["foreground"]):
1084
popen_args.update({"stdout": wnull,
1086
pipe = multiprocessing.Pipe(duplex=False)
1087
self.checker = multiprocessing.Process(
1089
args=(pipe[1], subprocess.call, command),
1091
self.checker.start()
1092
self.checker_callback_tag = GLib.io_add_watch(
1093
pipe[0].fileno(), GLib.IO_IN,
1094
self.checker_callback, pipe[0], command)
1095
# Re-run this periodically if run by GLib.timeout_add
434
logger.info(u"Starting checker %r for %s",
436
# We don't need to redirect stdout and stderr, since
437
# in normal mode, that is already done by daemon(),
438
# and in debug mode we don't want to. (Stdin is
439
# always replaced by /dev/null.)
440
self.checker = subprocess.Popen(command,
442
shell=True, cwd=u"/")
443
self.checker_callback_tag = (gobject.child_watch_add
445
self.checker_callback,
447
# The checker may have completed before the gobject
448
# watch was added. Check for this.
449
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
451
gobject.source_remove(self.checker_callback_tag)
452
self.checker_callback(pid, status, command)
453
except OSError, error:
454
logger.error(u"Failed to start subprocess: %s",
456
# Re-run this periodically if run by gobject.timeout_add
1098
459
def stop_checker(self):
1099
460
"""Force the checker process, if any, to stop."""
1100
461
if self.checker_callback_tag:
1101
GLib.source_remove(self.checker_callback_tag)
462
gobject.source_remove(self.checker_callback_tag)
1102
463
self.checker_callback_tag = None
1103
if getattr(self, "checker", None) is None:
464
if getattr(self, u"checker", None) is None:
1105
logger.debug("Stopping checker for %(name)s", vars(self))
1106
self.checker.terminate()
466
logger.debug(u"Stopping checker for %(name)s", vars(self))
468
os.kill(self.checker.pid, signal.SIGTERM)
470
#if self.checker.poll() is None:
471
# os.kill(self.checker.pid, signal.SIGKILL)
472
except OSError, error:
473
if error.errno != errno.ESRCH: # No such process
1107
475
self.checker = None
1110
def dbus_service_property(dbus_interface,
477
def still_valid(self):
478
"""Has the timeout not yet passed for this client?"""
479
if not getattr(self, u"enabled", False):
481
now = datetime.datetime.utcnow()
482
if self.last_checked_ok is None:
483
return now < (self.created + self.timeout)
485
return now < (self.last_checked_ok + self.timeout)
488
def dbus_service_property(dbus_interface, signature=u"v",
489
access=u"readwrite", byte_arrays=False):
1114
490
"""Decorators for marking methods of a DBusObjectWithProperties to
1115
491
become properties on the D-Bus.
1117
493
The decorated method will be called with no arguments by "Get"
1118
494
and with one argument by "Set".
1120
496
The parameters, where they are supported, are the same as
1121
497
dbus.service.method, except there is only "signature", since the
1122
498
type from Get() and the type sent to Set() is the same.
1124
# Encoding deeply encoded byte arrays is not supported yet by the
1125
# "Set" method, so we fail early here:
1126
if byte_arrays and signature != "ay":
1127
raise ValueError("Byte arrays not supported for non-'ay'"
1128
" signature {!r}".format(signature))
1130
500
def decorator(func):
1131
501
func._dbus_is_property = True
1132
502
func._dbus_interface = dbus_interface
1133
503
func._dbus_signature = signature
1134
504
func._dbus_access = access
1135
505
func._dbus_name = func.__name__
1136
if func._dbus_name.endswith("_dbus_property"):
506
if func._dbus_name.endswith(u"_dbus_property"):
1137
507
func._dbus_name = func._dbus_name[:-14]
1138
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1144
def dbus_interface_annotations(dbus_interface):
1145
"""Decorator for marking functions returning interface annotations
1149
@dbus_interface_annotations("org.example.Interface")
1150
def _foo(self): # Function name does not matter
1151
return {"org.freedesktop.DBus.Deprecated": "true",
1152
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1156
def decorator(func):
1157
func._dbus_is_interface = True
1158
func._dbus_interface = dbus_interface
1159
func._dbus_name = dbus_interface
1165
def dbus_annotations(annotations):
1166
"""Decorator to annotate D-Bus methods, signals or properties
1169
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1170
"org.freedesktop.DBus.Property."
1171
"EmitsChangedSignal": "false"})
1172
@dbus_service_property("org.example.Interface", signature="b",
1174
def Property_dbus_property(self):
1175
return dbus.Boolean(False)
1177
See also the DBusObjectWithAnnotations class.
1180
def decorator(func):
1181
func._dbus_annotations = annotations
508
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1184
510
return decorator
1187
513
class DBusPropertyException(dbus.exceptions.DBusException):
1188
514
"""A base class for D-Bus property-related exceptions
516
def __unicode__(self):
517
return unicode(str(self))
1193
520
class DBusPropertyAccessException(DBusPropertyException):
1205
class DBusObjectWithAnnotations(dbus.service.Object):
1206
"""A D-Bus object with annotations.
1208
Classes inheriting from this can use the dbus_annotations
1209
decorator to add annotations to methods or signals.
1213
def _is_dbus_thing(thing):
1214
"""Returns a function testing if an attribute is a D-Bus thing
1216
If called like _is_dbus_thing("method") it returns a function
1217
suitable for use as predicate to inspect.getmembers().
1219
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1222
def _get_all_dbus_things(self, thing):
1223
"""Returns a generator of (name, attribute) pairs
1225
return ((getattr(athing.__get__(self), "_dbus_name", name),
1226
athing.__get__(self))
1227
for cls in self.__class__.__mro__
1229
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1231
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1233
path_keyword='object_path',
1234
connection_keyword='connection')
1235
def Introspect(self, object_path, connection):
1236
"""Overloading of standard D-Bus method.
1238
Inserts annotation tags on methods and signals.
1240
xmlstring = dbus.service.Object.Introspect(self, object_path,
1243
document = xml.dom.minidom.parseString(xmlstring)
1245
for if_tag in document.getElementsByTagName("interface"):
1246
# Add annotation tags
1247
for typ in ("method", "signal"):
1248
for tag in if_tag.getElementsByTagName(typ):
1250
for name, prop in (self.
1251
_get_all_dbus_things(typ)):
1252
if (name == tag.getAttribute("name")
1253
and prop._dbus_interface
1254
== if_tag.getAttribute("name")):
1255
annots.update(getattr(
1256
prop, "_dbus_annotations", {}))
1257
for name, value in annots.items():
1258
ann_tag = document.createElement(
1260
ann_tag.setAttribute("name", name)
1261
ann_tag.setAttribute("value", value)
1262
tag.appendChild(ann_tag)
1263
# Add interface annotation tags
1264
for annotation, value in dict(
1265
itertools.chain.from_iterable(
1266
annotations().items()
1267
for name, annotations
1268
in self._get_all_dbus_things("interface")
1269
if name == if_tag.getAttribute("name")
1271
ann_tag = document.createElement("annotation")
1272
ann_tag.setAttribute("name", annotation)
1273
ann_tag.setAttribute("value", value)
1274
if_tag.appendChild(ann_tag)
1275
# Fix argument name for the Introspect method itself
1276
if (if_tag.getAttribute("name")
1277
== dbus.INTROSPECTABLE_IFACE):
1278
for cn in if_tag.getElementsByTagName("method"):
1279
if cn.getAttribute("name") == "Introspect":
1280
for arg in cn.getElementsByTagName("arg"):
1281
if (arg.getAttribute("direction")
1283
arg.setAttribute("name",
1285
xmlstring = document.toxml("utf-8")
1287
except (AttributeError, xml.dom.DOMException,
1288
xml.parsers.expat.ExpatError) as error:
1289
logger.error("Failed to override Introspection method",
1294
class DBusObjectWithProperties(DBusObjectWithAnnotations):
532
class DBusObjectWithProperties(dbus.service.Object):
1295
533
"""A D-Bus object with properties.
1297
535
Classes inheriting from this can use the dbus_service_property
1298
536
decorator to expose methods as D-Bus properties. It exposes the
1299
537
standard Get(), Set(), and GetAll() methods on the D-Bus.
541
def _is_dbus_property(obj):
542
return getattr(obj, u"_dbus_is_property", False)
544
def _get_all_dbus_properties(self):
545
"""Returns a generator of (name, attribute) pairs
547
return ((prop._dbus_name, prop)
549
inspect.getmembers(self, self._is_dbus_property))
1302
551
def _get_dbus_property(self, interface_name, property_name):
1303
552
"""Returns a bound method if one exists which is a D-Bus
1304
553
property with the specified name and interface.
1306
for cls in self.__class__.__mro__:
1307
for name, value in inspect.getmembers(
1308
cls, self._is_dbus_thing("property")):
1309
if (value._dbus_name == property_name
1310
and value._dbus_interface == interface_name):
1311
return value.__get__(self)
555
for name in (property_name,
556
property_name + u"_dbus_property"):
557
prop = getattr(self, name, None)
559
or not self._is_dbus_property(prop)
560
or prop._dbus_name != property_name
561
or (interface_name and prop._dbus_interface
562
and interface_name != prop._dbus_interface)):
1313
565
# No such property
1314
raise DBusPropertyNotFound("{}:{}.{}".format(
1315
self.dbus_object_path, interface_name, property_name))
1318
def _get_all_interface_names(cls):
1319
"""Get a sequence of all interfaces supported by an object"""
1320
return (name for name in set(getattr(getattr(x, attr),
1321
"_dbus_interface", None)
1322
for x in (inspect.getmro(cls))
1324
if name is not None)
1326
@dbus.service.method(dbus.PROPERTIES_IFACE,
566
raise DBusPropertyNotFound(self.dbus_object_path + u":"
567
+ interface_name + u"."
570
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1329
572
def Get(self, interface_name, property_name):
1330
573
"""Standard D-Bus property Get() method, see D-Bus standard.
1332
575
prop = self._get_dbus_property(interface_name, property_name)
1333
if prop._dbus_access == "write":
576
if prop._dbus_access == u"write":
1334
577
raise DBusPropertyAccessException(property_name)
1336
if not hasattr(value, "variant_level"):
579
if not hasattr(value, u"variant_level"):
1338
581
return type(value)(value, variant_level=value.variant_level+1)
1340
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
583
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1341
584
def Set(self, interface_name, property_name, value):
1342
585
"""Standard D-Bus property Set() method, see D-Bus standard.
1344
587
prop = self._get_dbus_property(interface_name, property_name)
1345
if prop._dbus_access == "read":
588
if prop._dbus_access == u"read":
1346
589
raise DBusPropertyAccessException(property_name)
1347
if prop._dbus_get_args_options["byte_arrays"]:
1348
# The byte_arrays option is not supported yet on
1349
# signatures other than "ay".
1350
if prop._dbus_signature != "ay":
1351
raise ValueError("Byte arrays not supported for non-"
1352
"'ay' signature {!r}"
1353
.format(prop._dbus_signature))
1354
value = dbus.ByteArray(b''.join(chr(byte)
590
if prop._dbus_get_args_options[u"byte_arrays"]:
591
value = dbus.ByteArray(''.join(unichr(byte)
1358
@dbus.service.method(dbus.PROPERTIES_IFACE,
1360
out_signature="a{sv}")
595
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
596
out_signature=u"a{sv}")
1361
597
def GetAll(self, interface_name):
1362
598
"""Standard D-Bus property GetAll() method, see D-Bus
1365
601
Note: Will not include properties with access="write".
1368
for name, prop in self._get_all_dbus_things("property"):
604
for name, prop in self._get_all_dbus_properties():
1369
605
if (interface_name
1370
606
and interface_name != prop._dbus_interface):
1371
607
# Interface non-empty but did not match
1373
609
# Ignore write-only properties
1374
if prop._dbus_access == "write":
610
if prop._dbus_access == u"write":
1377
if not hasattr(value, "variant_level"):
1378
properties[name] = value
613
if not hasattr(value, u"variant_level"):
1380
properties[name] = type(value)(
1381
value, variant_level=value.variant_level + 1)
1382
return dbus.Dictionary(properties, signature="sv")
1384
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1385
def PropertiesChanged(self, interface_name, changed_properties,
1386
invalidated_properties):
1387
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1392
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1394
path_keyword='object_path',
1395
connection_keyword='connection')
1396
def Introspect(self, object_path, connection):
1397
"""Overloading of standard D-Bus method.
1399
Inserts property tags and interface annotation tags.
1401
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1405
document = xml.dom.minidom.parseString(xmlstring)
1407
def make_tag(document, name, prop):
1408
e = document.createElement("property")
1409
e.setAttribute("name", name)
1410
e.setAttribute("type", prop._dbus_signature)
1411
e.setAttribute("access", prop._dbus_access)
1414
for if_tag in document.getElementsByTagName("interface"):
1416
for tag in (make_tag(document, name, prop)
1418
in self._get_all_dbus_things("property")
1419
if prop._dbus_interface
1420
== if_tag.getAttribute("name")):
1421
if_tag.appendChild(tag)
1422
# Add annotation tags for properties
1423
for tag in if_tag.getElementsByTagName("property"):
1425
for name, prop in self._get_all_dbus_things(
1427
if (name == tag.getAttribute("name")
1428
and prop._dbus_interface
1429
== if_tag.getAttribute("name")):
1430
annots.update(getattr(
1431
prop, "_dbus_annotations", {}))
1432
for name, value in annots.items():
1433
ann_tag = document.createElement(
1435
ann_tag.setAttribute("name", name)
1436
ann_tag.setAttribute("value", value)
1437
tag.appendChild(ann_tag)
1438
# Add the names to the return values for the
1439
# "org.freedesktop.DBus.Properties" methods
1440
if (if_tag.getAttribute("name")
1441
== "org.freedesktop.DBus.Properties"):
1442
for cn in if_tag.getElementsByTagName("method"):
1443
if cn.getAttribute("name") == "Get":
1444
for arg in cn.getElementsByTagName("arg"):
1445
if (arg.getAttribute("direction")
1447
arg.setAttribute("name", "value")
1448
elif cn.getAttribute("name") == "GetAll":
1449
for arg in cn.getElementsByTagName("arg"):
1450
if (arg.getAttribute("direction")
1452
arg.setAttribute("name", "props")
1453
xmlstring = document.toxml("utf-8")
1455
except (AttributeError, xml.dom.DOMException,
1456
xml.parsers.expat.ExpatError) as error:
1457
logger.error("Failed to override Introspection method",
1462
dbus.OBJECT_MANAGER_IFACE
1463
except AttributeError:
1464
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1467
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1468
"""A D-Bus object with an ObjectManager.
1470
Classes inheriting from this exposes the standard
1471
GetManagedObjects call and the InterfacesAdded and
1472
InterfacesRemoved signals on the standard
1473
"org.freedesktop.DBus.ObjectManager" interface.
1475
Note: No signals are sent automatically; they must be sent
1478
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1479
out_signature="a{oa{sa{sv}}}")
1480
def GetManagedObjects(self):
1481
"""This function must be overridden"""
1482
raise NotImplementedError()
1484
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1485
signature="oa{sa{sv}}")
1486
def InterfacesAdded(self, object_path, interfaces_and_properties):
1489
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1490
def InterfacesRemoved(self, object_path, interfaces):
1493
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1495
path_keyword='object_path',
1496
connection_keyword='connection')
1497
def Introspect(self, object_path, connection):
1498
"""Overloading of standard D-Bus method.
1500
Override return argument name of GetManagedObjects to be
1501
"objpath_interfaces_and_properties"
1503
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1507
document = xml.dom.minidom.parseString(xmlstring)
1509
for if_tag in document.getElementsByTagName("interface"):
1510
# Fix argument name for the GetManagedObjects method
1511
if (if_tag.getAttribute("name")
1512
== dbus.OBJECT_MANAGER_IFACE):
1513
for cn in if_tag.getElementsByTagName("method"):
1514
if (cn.getAttribute("name")
1515
== "GetManagedObjects"):
1516
for arg in cn.getElementsByTagName("arg"):
1517
if (arg.getAttribute("direction")
1521
"objpath_interfaces"
1523
xmlstring = document.toxml("utf-8")
1525
except (AttributeError, xml.dom.DOMException,
1526
xml.parsers.expat.ExpatError) as error:
1527
logger.error("Failed to override Introspection method",
1532
def datetime_to_dbus(dt, variant_level=0):
1533
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1535
return dbus.String("", variant_level=variant_level)
1536
return dbus.String(dt.isoformat(), variant_level=variant_level)
1539
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1540
"""A class decorator; applied to a subclass of
1541
dbus.service.Object, it will add alternate D-Bus attributes with
1542
interface names according to the "alt_interface_names" mapping.
1545
@alternate_dbus_interfaces({"org.example.Interface":
1546
"net.example.AlternateInterface"})
1547
class SampleDBusObject(dbus.service.Object):
1548
@dbus.service.method("org.example.Interface")
1549
def SampleDBusMethod():
1552
The above "SampleDBusMethod" on "SampleDBusObject" will be
1553
reachable via two interfaces: "org.example.Interface" and
1554
"net.example.AlternateInterface", the latter of which will have
1555
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1556
"true", unless "deprecate" is passed with a False value.
1558
This works for methods and signals, and also for D-Bus properties
1559
(from DBusObjectWithProperties) and interfaces (from the
1560
dbus_interface_annotations decorator).
1564
for orig_interface_name, alt_interface_name in (
1565
alt_interface_names.items()):
1567
interface_names = set()
1568
# Go though all attributes of the class
1569
for attrname, attribute in inspect.getmembers(cls):
1570
# Ignore non-D-Bus attributes, and D-Bus attributes
1571
# with the wrong interface name
1572
if (not hasattr(attribute, "_dbus_interface")
1573
or not attribute._dbus_interface.startswith(
1574
orig_interface_name)):
1576
# Create an alternate D-Bus interface name based on
1578
alt_interface = attribute._dbus_interface.replace(
1579
orig_interface_name, alt_interface_name)
1580
interface_names.add(alt_interface)
1581
# Is this a D-Bus signal?
1582
if getattr(attribute, "_dbus_is_signal", False):
1583
# Extract the original non-method undecorated
1584
# function by black magic
1585
if sys.version_info.major == 2:
1586
nonmethod_func = (dict(
1587
zip(attribute.func_code.co_freevars,
1588
attribute.__closure__))
1589
["func"].cell_contents)
1591
nonmethod_func = (dict(
1592
zip(attribute.__code__.co_freevars,
1593
attribute.__closure__))
1594
["func"].cell_contents)
1595
# Create a new, but exactly alike, function
1596
# object, and decorate it to be a new D-Bus signal
1597
# with the alternate D-Bus interface name
1598
new_function = copy_function(nonmethod_func)
1599
new_function = (dbus.service.signal(
1601
attribute._dbus_signature)(new_function))
1602
# Copy annotations, if any
1604
new_function._dbus_annotations = dict(
1605
attribute._dbus_annotations)
1606
except AttributeError:
1609
# Define a creator of a function to call both the
1610
# original and alternate functions, so both the
1611
# original and alternate signals gets sent when
1612
# the function is called
1613
def fixscope(func1, func2):
1614
"""This function is a scope container to pass
1615
func1 and func2 to the "call_both" function
1616
outside of its arguments"""
1618
@functools.wraps(func2)
1619
def call_both(*args, **kwargs):
1620
"""This function will emit two D-Bus
1621
signals by calling func1 and func2"""
1622
func1(*args, **kwargs)
1623
func2(*args, **kwargs)
1624
# Make wrapper function look like a D-Bus
1626
for name, attr in inspect.getmembers(func2):
1627
if name.startswith("_dbus_"):
1628
setattr(call_both, name, attr)
1631
# Create the "call_both" function and add it to
1633
attr[attrname] = fixscope(attribute, new_function)
1634
# Is this a D-Bus method?
1635
elif getattr(attribute, "_dbus_is_method", False):
1636
# Create a new, but exactly alike, function
1637
# object. Decorate it to be a new D-Bus method
1638
# with the alternate D-Bus interface name. Add it
1641
dbus.service.method(
1643
attribute._dbus_in_signature,
1644
attribute._dbus_out_signature)
1645
(copy_function(attribute)))
1646
# Copy annotations, if any
1648
attr[attrname]._dbus_annotations = dict(
1649
attribute._dbus_annotations)
1650
except AttributeError:
1652
# Is this a D-Bus property?
1653
elif getattr(attribute, "_dbus_is_property", False):
1654
# Create a new, but exactly alike, function
1655
# object, and decorate it to be a new D-Bus
1656
# property with the alternate D-Bus interface
1657
# name. Add it to the class.
1658
attr[attrname] = (dbus_service_property(
1659
alt_interface, attribute._dbus_signature,
1660
attribute._dbus_access,
1661
attribute._dbus_get_args_options
1663
(copy_function(attribute)))
1664
# Copy annotations, if any
1666
attr[attrname]._dbus_annotations = dict(
1667
attribute._dbus_annotations)
1668
except AttributeError:
1670
# Is this a D-Bus interface?
1671
elif getattr(attribute, "_dbus_is_interface", False):
1672
# Create a new, but exactly alike, function
1673
# object. Decorate it to be a new D-Bus interface
1674
# with the alternate D-Bus interface name. Add it
1677
dbus_interface_annotations(alt_interface)
1678
(copy_function(attribute)))
1680
# Deprecate all alternate interfaces
1681
iname = "_AlternateDBusNames_interface_annotation{}"
1682
for interface_name in interface_names:
1684
@dbus_interface_annotations(interface_name)
1686
return {"org.freedesktop.DBus.Deprecated":
1688
# Find an unused name
1689
for aname in (iname.format(i)
1690
for i in itertools.count()):
1691
if aname not in attr:
1695
# Replace the class with a new subclass of it with
1696
# methods, signals, etc. as created above.
1697
if sys.version_info.major == 2:
1698
cls = type(b"{}Alternate".format(cls.__name__),
1701
cls = type("{}Alternate".format(cls.__name__),
1708
@alternate_dbus_interfaces({"se.recompile.Mandos":
1709
"se.bsnet.fukt.Mandos"})
616
all[name] = type(value)(value, variant_level=
617
value.variant_level+1)
618
return dbus.Dictionary(all, signature=u"sv")
620
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
622
path_keyword='object_path',
623
connection_keyword='connection')
624
def Introspect(self, object_path, connection):
625
"""Standard D-Bus method, overloaded to insert property tags.
627
xmlstring = dbus.service.Object.Introspect(self, object_path,
629
document = xml.dom.minidom.parseString(xmlstring)
631
def make_tag(document, name, prop):
632
e = document.createElement(u"property")
633
e.setAttribute(u"name", name)
634
e.setAttribute(u"type", prop._dbus_signature)
635
e.setAttribute(u"access", prop._dbus_access)
637
for if_tag in document.getElementsByTagName(u"interface"):
638
for tag in (make_tag(document, name, prop)
640
in self._get_all_dbus_properties()
641
if prop._dbus_interface
642
== if_tag.getAttribute(u"name")):
643
if_tag.appendChild(tag)
644
xmlstring = document.toxml(u"utf-8")
1710
649
class ClientDBus(Client, DBusObjectWithProperties):
1711
650
"""A Client class using D-Bus
1714
653
dbus_object_path: dbus.ObjectPath
1715
654
bus: dbus.SystemBus()
1718
runtime_expansions = (Client.runtime_expansions
1719
+ ("dbus_object_path", ))
1721
_interface = "se.recompile.Mandos.Client"
1723
656
# dbus.service.Object doesn't use super(), so we can't either.
1725
def __init__(self, bus=None, *args, **kwargs):
658
def __init__(self, bus = None, *args, **kwargs):
1727
660
Client.__init__(self, *args, **kwargs)
1728
661
# Only now, when this client is initialized, can it show up on
1730
client_object_name = str(self.name).translate(
1731
{ord("."): ord("_"),
1732
ord("-"): ord("_")})
1733
self.dbus_object_path = dbus.ObjectPath(
1734
"/clients/" + client_object_name)
663
self.dbus_object_path = (dbus.ObjectPath
665
+ self.name.replace(u".", u"_")))
1735
666
DBusObjectWithProperties.__init__(self, self.bus,
1736
667
self.dbus_object_path)
1738
def notifychangeproperty(transform_func, dbus_name,
1739
type_func=lambda x: x,
1741
invalidate_only=False,
1742
_interface=_interface):
1743
""" Modify a variable so that it's a property which announces
1744
its changes to DBus.
1746
transform_fun: Function that takes a value and a variant_level
1747
and transforms it to a D-Bus type.
1748
dbus_name: D-Bus name of the variable
1749
type_func: Function that transform the value before sending it
1750
to the D-Bus. Default: no transform
1751
variant_level: D-Bus variant level. Default: 1
1753
attrname = "_{}".format(dbus_name)
1755
def setter(self, value):
1756
if hasattr(self, "dbus_object_path"):
1757
if (not hasattr(self, attrname) or
1758
type_func(getattr(self, attrname, None))
1759
!= type_func(value)):
1761
self.PropertiesChanged(
1762
_interface, dbus.Dictionary(),
1763
dbus.Array((dbus_name, )))
1765
dbus_value = transform_func(
1767
variant_level=variant_level)
1768
self.PropertyChanged(dbus.String(dbus_name),
1770
self.PropertiesChanged(
1772
dbus.Dictionary({dbus.String(dbus_name):
1775
setattr(self, attrname, value)
1777
return property(lambda self: getattr(self, attrname), setter)
1779
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1780
approvals_pending = notifychangeproperty(dbus.Boolean,
1783
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1784
last_enabled = notifychangeproperty(datetime_to_dbus,
1786
checker = notifychangeproperty(
1787
dbus.Boolean, "CheckerRunning",
1788
type_func=lambda checker: checker is not None)
1789
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1791
last_checker_status = notifychangeproperty(dbus.Int16,
1792
"LastCheckerStatus")
1793
last_approval_request = notifychangeproperty(
1794
datetime_to_dbus, "LastApprovalRequest")
1795
approved_by_default = notifychangeproperty(dbus.Boolean,
1796
"ApprovedByDefault")
1797
approval_delay = notifychangeproperty(
1798
dbus.UInt64, "ApprovalDelay",
1799
type_func=lambda td: td.total_seconds() * 1000)
1800
approval_duration = notifychangeproperty(
1801
dbus.UInt64, "ApprovalDuration",
1802
type_func=lambda td: td.total_seconds() * 1000)
1803
host = notifychangeproperty(dbus.String, "Host")
1804
timeout = notifychangeproperty(
1805
dbus.UInt64, "Timeout",
1806
type_func=lambda td: td.total_seconds() * 1000)
1807
extended_timeout = notifychangeproperty(
1808
dbus.UInt64, "ExtendedTimeout",
1809
type_func=lambda td: td.total_seconds() * 1000)
1810
interval = notifychangeproperty(
1811
dbus.UInt64, "Interval",
1812
type_func=lambda td: td.total_seconds() * 1000)
1813
checker_command = notifychangeproperty(dbus.String, "Checker")
1814
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1815
invalidate_only=True)
1817
del notifychangeproperty
670
def _datetime_to_dbus(dt, variant_level=0):
671
"""Convert a UTC datetime.datetime() to a D-Bus type."""
672
return dbus.String(dt.isoformat(),
673
variant_level=variant_level)
676
oldstate = getattr(self, u"enabled", False)
677
r = Client.enable(self)
678
if oldstate != self.enabled:
680
self.PropertyChanged(dbus.String(u"enabled"),
681
dbus.Boolean(True, variant_level=1))
682
self.PropertyChanged(
683
dbus.String(u"last_enabled"),
684
self._datetime_to_dbus(self.last_enabled,
688
def disable(self, signal = True):
689
oldstate = getattr(self, u"enabled", False)
690
r = Client.disable(self)
691
if signal and oldstate != self.enabled:
693
self.PropertyChanged(dbus.String(u"enabled"),
694
dbus.Boolean(False, variant_level=1))
1819
697
def __del__(self, *args, **kwargs):
1821
699
self.remove_from_connection()
1822
700
except LookupError:
1824
if hasattr(DBusObjectWithProperties, "__del__"):
702
if hasattr(DBusObjectWithProperties, u"__del__"):
1825
703
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1826
704
Client.__del__(self, *args, **kwargs)
1828
def checker_callback(self, source, condition,
1829
connection, command, *args, **kwargs):
1830
ret = Client.checker_callback(self, source, condition,
1831
connection, command, *args,
1833
exitstatus = self.last_checker_status
706
def checker_callback(self, pid, condition, command,
708
self.checker_callback_tag = None
711
self.PropertyChanged(dbus.String(u"checker_running"),
712
dbus.Boolean(False, variant_level=1))
713
if os.WIFEXITED(condition):
714
exitstatus = os.WEXITSTATUS(condition)
1835
715
# Emit D-Bus signal
1836
716
self.CheckerCompleted(dbus.Int16(exitstatus),
1837
# This is specific to GNU libC
1838
dbus.Int64(exitstatus << 8),
717
dbus.Int64(condition),
1839
718
dbus.String(command))
1841
720
# Emit D-Bus signal
1842
721
self.CheckerCompleted(dbus.Int16(-1),
1844
# This is specific to GNU libC
1846
| self.last_checker_signal),
722
dbus.Int64(condition),
1847
723
dbus.String(command))
725
return Client.checker_callback(self, pid, condition, command,
728
def checked_ok(self, *args, **kwargs):
729
r = Client.checked_ok(self, *args, **kwargs)
731
self.PropertyChanged(
732
dbus.String(u"last_checked_ok"),
733
(self._datetime_to_dbus(self.last_checked_ok,
1850
737
def start_checker(self, *args, **kwargs):
1851
old_checker_pid = getattr(self.checker, "pid", None)
738
old_checker = self.checker
739
if self.checker is not None:
740
old_checker_pid = self.checker.pid
742
old_checker_pid = None
1852
743
r = Client.start_checker(self, *args, **kwargs)
1853
744
# Only if new checker process was started
1854
745
if (self.checker is not None
1855
746
and old_checker_pid != self.checker.pid):
1856
747
# Emit D-Bus signal
1857
748
self.CheckerStarted(self.current_checker_command)
1860
def _reset_approved(self):
1861
self.approved = None
1864
def approve(self, value=True):
1865
self.approved = value
1866
GLib.timeout_add(int(self.approval_duration.total_seconds()
1867
* 1000), self._reset_approved)
1868
self.send_changedstate()
1870
# D-Bus methods, signals & properties
749
self.PropertyChanged(
750
dbus.String(u"checker_running"),
751
dbus.Boolean(True, variant_level=1))
754
def stop_checker(self, *args, **kwargs):
755
old_checker = getattr(self, u"checker", None)
756
r = Client.stop_checker(self, *args, **kwargs)
757
if (old_checker is not None
758
and getattr(self, u"checker", None) is None):
759
self.PropertyChanged(dbus.String(u"checker_running"),
760
dbus.Boolean(False, variant_level=1))
763
## D-Bus methods & signals
764
_interface = u"se.bsnet.fukt.Mandos.Client"
767
@dbus.service.method(_interface)
769
return self.checked_ok()
1876
771
# CheckerCompleted - signal
1877
@dbus.service.signal(_interface, signature="nxs")
772
@dbus.service.signal(_interface, signature=u"nxs")
1878
773
def CheckerCompleted(self, exitcode, waitstatus, command):
1882
777
# CheckerStarted - signal
1883
@dbus.service.signal(_interface, signature="s")
778
@dbus.service.signal(_interface, signature=u"s")
1884
779
def CheckerStarted(self, command):
1888
783
# PropertyChanged - signal
1889
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1890
@dbus.service.signal(_interface, signature="sv")
784
@dbus.service.signal(_interface, signature=u"sv")
1891
785
def PropertyChanged(self, property, value):
1895
# GotSecret - signal
789
# ReceivedSecret - signal
1896
790
@dbus.service.signal(_interface)
1897
def GotSecret(self):
1899
Is sent after a successful transfer of secret from the Mandos
1900
server to mandos-client
791
def ReceivedSecret(self):
1904
795
# Rejected - signal
1905
@dbus.service.signal(_interface, signature="s")
1906
def Rejected(self, reason):
796
@dbus.service.signal(_interface)
1910
# NeedApproval - signal
1911
@dbus.service.signal(_interface, signature="tb")
1912
def NeedApproval(self, timeout, default):
1914
return self.need_approval()
1919
@dbus.service.method(_interface, in_signature="b")
1920
def Approve(self, value):
1923
# CheckedOK - method
1924
@dbus.service.method(_interface)
1925
def CheckedOK(self):
1928
801
# Enable - method
1929
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1930
802
@dbus.service.method(_interface)
1931
803
def Enable(self):
1935
807
# StartChecker - method
1936
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1937
808
@dbus.service.method(_interface)
1938
809
def StartChecker(self):
1940
811
self.start_checker()
1942
813
# Disable - method
1943
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1944
814
@dbus.service.method(_interface)
1945
815
def Disable(self):
1949
819
# StopChecker - method
1950
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1951
820
@dbus.service.method(_interface)
1952
821
def StopChecker(self):
1953
822
self.stop_checker()
1957
# ApprovalPending - property
1958
@dbus_service_property(_interface, signature="b", access="read")
1959
def ApprovalPending_dbus_property(self):
1960
return dbus.Boolean(bool(self.approvals_pending))
1962
# ApprovedByDefault - property
1963
@dbus_service_property(_interface,
1966
def ApprovedByDefault_dbus_property(self, value=None):
1967
if value is None: # get
1968
return dbus.Boolean(self.approved_by_default)
1969
self.approved_by_default = bool(value)
1971
# ApprovalDelay - property
1972
@dbus_service_property(_interface,
1975
def ApprovalDelay_dbus_property(self, value=None):
1976
if value is None: # get
1977
return dbus.UInt64(self.approval_delay.total_seconds()
1979
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1981
# ApprovalDuration - property
1982
@dbus_service_property(_interface,
1985
def ApprovalDuration_dbus_property(self, value=None):
1986
if value is None: # get
1987
return dbus.UInt64(self.approval_duration.total_seconds()
1989
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1993
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1994
@dbus_service_property(_interface, signature="s", access="read")
1995
def Name_dbus_property(self):
825
@dbus_service_property(_interface, signature=u"s", access=u"read")
826
def name_dbus_property(self):
1996
827
return dbus.String(self.name)
1998
# Fingerprint - property
2000
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2001
@dbus_service_property(_interface, signature="s", access="read")
2002
def Fingerprint_dbus_property(self):
829
# fingerprint - property
830
@dbus_service_property(_interface, signature=u"s", access=u"read")
831
def fingerprint_dbus_property(self):
2003
832
return dbus.String(self.fingerprint)
2006
@dbus_service_property(_interface,
2009
def Host_dbus_property(self, value=None):
835
@dbus_service_property(_interface, signature=u"s",
837
def host_dbus_property(self, value=None):
2010
838
if value is None: # get
2011
839
return dbus.String(self.host)
2012
self.host = str(value)
2014
# Created - property
2016
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2017
@dbus_service_property(_interface, signature="s", access="read")
2018
def Created_dbus_property(self):
2019
return datetime_to_dbus(self.created)
2021
# LastEnabled - property
2022
@dbus_service_property(_interface, signature="s", access="read")
2023
def LastEnabled_dbus_property(self):
2024
return datetime_to_dbus(self.last_enabled)
2026
# Enabled - property
2027
@dbus_service_property(_interface,
2030
def Enabled_dbus_property(self, value=None):
842
self.PropertyChanged(dbus.String(u"host"),
843
dbus.String(value, variant_level=1))
846
@dbus_service_property(_interface, signature=u"s", access=u"read")
847
def created_dbus_property(self):
848
return dbus.String(self._datetime_to_dbus(self.created))
850
# last_enabled - property
851
@dbus_service_property(_interface, signature=u"s", access=u"read")
852
def last_enabled_dbus_property(self):
853
if self.last_enabled is None:
854
return dbus.String(u"")
855
return dbus.String(self._datetime_to_dbus(self.last_enabled))
858
@dbus_service_property(_interface, signature=u"b",
860
def enabled_dbus_property(self, value=None):
2031
861
if value is None: # get
2032
862
return dbus.Boolean(self.enabled)
2038
# LastCheckedOK - property
2039
@dbus_service_property(_interface,
2042
def LastCheckedOK_dbus_property(self, value=None):
868
# last_checked_ok - property
869
@dbus_service_property(_interface, signature=u"s",
871
def last_checked_ok_dbus_property(self, value=None):
2043
872
if value is not None:
2044
873
self.checked_ok()
2046
return datetime_to_dbus(self.last_checked_ok)
2048
# LastCheckerStatus - property
2049
@dbus_service_property(_interface, signature="n", access="read")
2050
def LastCheckerStatus_dbus_property(self):
2051
return dbus.Int16(self.last_checker_status)
2053
# Expires - property
2054
@dbus_service_property(_interface, signature="s", access="read")
2055
def Expires_dbus_property(self):
2056
return datetime_to_dbus(self.expires)
2058
# LastApprovalRequest - property
2059
@dbus_service_property(_interface, signature="s", access="read")
2060
def LastApprovalRequest_dbus_property(self):
2061
return datetime_to_dbus(self.last_approval_request)
2063
# Timeout - property
2064
@dbus_service_property(_interface,
2067
def Timeout_dbus_property(self, value=None):
875
if self.last_checked_ok is None:
876
return dbus.String(u"")
877
return dbus.String(self._datetime_to_dbus(self
881
@dbus_service_property(_interface, signature=u"t",
883
def timeout_dbus_property(self, value=None):
2068
884
if value is None: # get
2069
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2070
old_timeout = self.timeout
885
return dbus.UInt64(self.timeout_milliseconds())
2071
886
self.timeout = datetime.timedelta(0, 0, 0, value)
2072
# Reschedule disabling
2074
now = datetime.datetime.utcnow()
2075
self.expires += self.timeout - old_timeout
2076
if self.expires <= now:
2077
# The timeout has passed
2080
if (getattr(self, "disable_initiator_tag", None)
2083
GLib.source_remove(self.disable_initiator_tag)
2084
self.disable_initiator_tag = GLib.timeout_add(
2085
int((self.expires - now).total_seconds() * 1000),
2088
# ExtendedTimeout - property
2089
@dbus_service_property(_interface,
2092
def ExtendedTimeout_dbus_property(self, value=None):
2093
if value is None: # get
2094
return dbus.UInt64(self.extended_timeout.total_seconds()
2096
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2098
# Interval - property
2099
@dbus_service_property(_interface,
2102
def Interval_dbus_property(self, value=None):
2103
if value is None: # get
2104
return dbus.UInt64(self.interval.total_seconds() * 1000)
888
self.PropertyChanged(dbus.String(u"timeout"),
889
dbus.UInt64(value, variant_level=1))
890
if getattr(self, u"disable_initiator_tag", None) is None:
893
gobject.source_remove(self.disable_initiator_tag)
894
self.disable_initiator_tag = None
896
_timedelta_to_milliseconds((self
902
# The timeout has passed
905
self.disable_initiator_tag = (gobject.timeout_add
906
(time_to_die, self.disable))
908
# interval - property
909
@dbus_service_property(_interface, signature=u"t",
911
def interval_dbus_property(self, value=None):
912
if value is None: # get
913
return dbus.UInt64(self.interval_milliseconds())
2105
914
self.interval = datetime.timedelta(0, 0, 0, value)
2106
if getattr(self, "checker_initiator_tag", None) is None:
916
self.PropertyChanged(dbus.String(u"interval"),
917
dbus.UInt64(value, variant_level=1))
918
if getattr(self, u"checker_initiator_tag", None) is None:
2109
# Reschedule checker run
2110
GLib.source_remove(self.checker_initiator_tag)
2111
self.checker_initiator_tag = GLib.timeout_add(
2112
value, self.start_checker)
2113
self.start_checker() # Start one now, too
920
# Reschedule checker run
921
gobject.source_remove(self.checker_initiator_tag)
922
self.checker_initiator_tag = (gobject.timeout_add
923
(value, self.start_checker))
924
self.start_checker() # Start one now, too
2115
# Checker - property
2116
@dbus_service_property(_interface,
2119
def Checker_dbus_property(self, value=None):
927
@dbus_service_property(_interface, signature=u"s",
929
def checker_dbus_property(self, value=None):
2120
930
if value is None: # get
2121
931
return dbus.String(self.checker_command)
2122
self.checker_command = str(value)
2124
# CheckerRunning - property
2125
@dbus_service_property(_interface,
2128
def CheckerRunning_dbus_property(self, value=None):
932
self.checker_command = value
934
self.PropertyChanged(dbus.String(u"checker"),
935
dbus.String(self.checker_command,
938
# checker_running - property
939
@dbus_service_property(_interface, signature=u"b",
941
def checker_running_dbus_property(self, value=None):
2129
942
if value is None: # get
2130
943
return dbus.Boolean(self.checker is not None)
2132
945
self.start_checker()
2134
947
self.stop_checker()
2136
# ObjectPath - property
2138
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2139
"org.freedesktop.DBus.Deprecated": "true"})
2140
@dbus_service_property(_interface, signature="o", access="read")
2141
def ObjectPath_dbus_property(self):
2142
return self.dbus_object_path # is already a dbus.ObjectPath
2146
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2148
@dbus_service_property(_interface,
2152
def Secret_dbus_property(self, value):
2153
self.secret = bytes(value)
949
# object_path - property
950
@dbus_service_property(_interface, signature=u"o", access=u"read")
951
def object_path_dbus_property(self):
952
return self.dbus_object_path # is already a dbus.ObjectPath
955
@dbus_service_property(_interface, signature=u"ay",
956
access=u"write", byte_arrays=True)
957
def secret_dbus_property(self, value):
958
self.secret = str(value)
2158
class ProxyClient(object):
2159
def __init__(self, child_pipe, fpr, address):
2160
self._pipe = child_pipe
2161
self._pipe.send(('init', fpr, address))
2162
if not self._pipe.recv():
2165
def __getattribute__(self, name):
2167
return super(ProxyClient, self).__getattribute__(name)
2168
self._pipe.send(('getattr', name))
2169
data = self._pipe.recv()
2170
if data[0] == 'data':
2172
if data[0] == 'function':
2174
def func(*args, **kwargs):
2175
self._pipe.send(('funcall', name, args, kwargs))
2176
return self._pipe.recv()[1]
2180
def __setattr__(self, name, value):
2182
return super(ProxyClient, self).__setattr__(name, value)
2183
self._pipe.send(('setattr', name, value))
2186
963
class ClientHandler(socketserver.BaseRequestHandler, object):
2187
964
"""A class to handle client connections.
2189
966
Instantiated once for each connection to handle it.
2190
967
Note: This will run in its own forked process."""
2192
969
def handle(self):
2193
with contextlib.closing(self.server.child_pipe) as child_pipe:
2194
logger.info("TCP connection from: %s",
2195
str(self.client_address))
2196
logger.debug("Pipe FD: %d",
2197
self.server.child_pipe.fileno())
2199
session = gnutls.ClientSession(self.request)
2201
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2202
# "+AES-256-CBC", "+SHA1",
2203
# "+COMP-NULL", "+CTYPE-OPENPGP",
970
logger.info(u"TCP connection from: %s",
971
unicode(self.client_address))
972
logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
973
# Open IPC pipe to parent process
974
with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
975
session = (gnutls.connection
976
.ClientSession(self.request,
980
line = self.request.makefile().readline()
981
logger.debug(u"Protocol version: %r", line)
983
if int(line.strip().split()[0]) > 1:
985
except (ValueError, IndexError, RuntimeError), error:
986
logger.error(u"Unknown protocol version: %s", error)
989
# Note: gnutls.connection.X509Credentials is really a
990
# generic GnuTLS certificate credentials object so long as
991
# no X.509 keys are added to it. Therefore, we can use it
992
# here despite using OpenPGP certificates.
994
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
995
# u"+AES-256-CBC", u"+SHA1",
996
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2205
998
# Use a fallback default, since this MUST be set.
2206
999
priority = self.server.gnutls_priority
2207
1000
if priority is None:
2209
gnutls.priority_set_direct(session._c_object,
2210
priority.encode("utf-8"),
2213
# Start communication using the Mandos protocol
2214
# Get protocol number
2215
line = self.request.makefile().readline()
2216
logger.debug("Protocol version: %r", line)
2218
if int(line.strip().split()[0]) > 1:
2219
raise RuntimeError(line)
2220
except (ValueError, IndexError, RuntimeError) as error:
2221
logger.error("Unknown protocol version: %s", error)
2224
# Start GnuTLS connection
1001
priority = u"NORMAL"
1002
(gnutls.library.functions
1003
.gnutls_priority_set_direct(session._c_object,
2226
1007
session.handshake()
2227
except gnutls.Error as error:
2228
logger.warning("Handshake failed: %s", error)
1008
except gnutls.errors.GNUTLSError, error:
1009
logger.warning(u"Handshake failed: %s", error)
2229
1010
# Do not run session.bye() here: the session is not
2230
1011
# established. Just abandon the request.
2232
logger.debug("Handshake succeeded")
2234
approval_required = False
1013
logger.debug(u"Handshake succeeded")
2237
fpr = self.fingerprint(
2238
self.peer_certificate(session))
2239
except (TypeError, gnutls.Error) as error:
2240
logger.warning("Bad certificate: %s", error)
2242
logger.debug("Fingerprint: %s", fpr)
2245
client = ProxyClient(child_pipe, fpr,
2246
self.client_address)
2250
if client.approval_delay:
2251
delay = client.approval_delay
2252
client.approvals_pending += 1
2253
approval_required = True
2256
if not client.enabled:
2257
logger.info("Client %s is disabled",
2259
if self.server.use_dbus:
2261
client.Rejected("Disabled")
2264
if client.approved or not client.approval_delay:
2265
# We are approved or approval is disabled
2267
elif client.approved is None:
2268
logger.info("Client %s needs approval",
2270
if self.server.use_dbus:
2272
client.NeedApproval(
2273
client.approval_delay.total_seconds()
2274
* 1000, client.approved_by_default)
2276
logger.warning("Client %s was not approved",
2278
if self.server.use_dbus:
2280
client.Rejected("Denied")
2283
# wait until timeout or approved
2284
time = datetime.datetime.now()
2285
client.changedstate.acquire()
2286
client.changedstate.wait(delay.total_seconds())
2287
client.changedstate.release()
2288
time2 = datetime.datetime.now()
2289
if (time2 - time) >= delay:
2290
if not client.approved_by_default:
2291
logger.warning("Client %s timed out while"
2292
" waiting for approval",
2294
if self.server.use_dbus:
2296
client.Rejected("Approval timed out")
2301
delay -= time2 - time
2304
session.send(client.secret)
2305
except gnutls.Error as error:
2306
logger.warning("gnutls send failed",
2310
logger.info("Sending secret to %s", client.name)
2311
# bump the timeout using extended_timeout
2312
client.bump_timeout(client.extended_timeout)
2313
if self.server.use_dbus:
2318
if approval_required:
2319
client.approvals_pending -= 1
2322
except gnutls.Error as error:
2323
logger.warning("GnuTLS bye failed",
1015
fpr = self.fingerprint(self.peer_certificate(session))
1016
except (TypeError, gnutls.errors.GNUTLSError), error:
1017
logger.warning(u"Bad certificate: %s", error)
1020
logger.debug(u"Fingerprint: %s", fpr)
1022
for c in self.server.clients:
1023
if c.fingerprint == fpr:
1027
ipc.write(u"NOTFOUND %s %s\n"
1028
% (fpr, unicode(self.client_address)))
1031
# Have to check if client.still_valid(), since it is
1032
# possible that the client timed out while establishing
1033
# the GnuTLS session.
1034
if not client.still_valid():
1035
ipc.write(u"INVALID %s\n" % client.name)
1038
ipc.write(u"SENDING %s\n" % client.name)
1040
while sent_size < len(client.secret):
1041
sent = session.send(client.secret[sent_size:])
1042
logger.debug(u"Sent: %d, remaining: %d",
1043
sent, len(client.secret)
1044
- (sent_size + sent))
2327
1049
def peer_certificate(session):
2328
1050
"Return the peer's OpenPGP certificate as a bytestring"
2329
1051
# If not an OpenPGP certificate...
2330
if (gnutls.certificate_type_get(session._c_object)
2331
!= gnutls.CRT_OPENPGP):
2332
# ...return invalid data
1052
if (gnutls.library.functions
1053
.gnutls_certificate_type_get(session._c_object)
1054
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1055
# ...do the normal thing
1056
return session.peer_certificate
2334
1057
list_size = ctypes.c_uint(1)
2335
cert_list = (gnutls.certificate_get_peers
1058
cert_list = (gnutls.library.functions
1059
.gnutls_certificate_get_peers
2336
1060
(session._c_object, ctypes.byref(list_size)))
2337
1061
if not bool(cert_list) and list_size.value != 0:
2338
raise gnutls.Error("error getting peer certificate")
1062
raise gnutls.errors.GNUTLSError(u"error getting peer"
2339
1064
if list_size.value == 0:
2341
1066
cert = cert_list[0]
2342
1067
return ctypes.string_at(cert.data, cert.size)
2345
1070
def fingerprint(openpgp):
2346
1071
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2347
1072
# New GnuTLS "datum" with the OpenPGP public key
2348
datum = gnutls.datum_t(
2349
ctypes.cast(ctypes.c_char_p(openpgp),
2350
ctypes.POINTER(ctypes.c_ubyte)),
2351
ctypes.c_uint(len(openpgp)))
1073
datum = (gnutls.library.types
1074
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1077
ctypes.c_uint(len(openpgp))))
2352
1078
# New empty GnuTLS certificate
2353
crt = gnutls.openpgp_crt_t()
2354
gnutls.openpgp_crt_init(ctypes.byref(crt))
1079
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1080
(gnutls.library.functions
1081
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2355
1082
# Import the OpenPGP public key into the certificate
2356
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2357
gnutls.OPENPGP_FMT_RAW)
1083
(gnutls.library.functions
1084
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1085
gnutls.library.constants
1086
.GNUTLS_OPENPGP_FMT_RAW))
2358
1087
# Verify the self signature in the key
2359
1088
crtverify = ctypes.c_uint()
2360
gnutls.openpgp_crt_verify_self(crt, 0,
2361
ctypes.byref(crtverify))
1089
(gnutls.library.functions
1090
.gnutls_openpgp_crt_verify_self(crt, 0,
1091
ctypes.byref(crtverify)))
2362
1092
if crtverify.value != 0:
2363
gnutls.openpgp_crt_deinit(crt)
2364
raise gnutls.CertificateSecurityError("Verify failed")
1093
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1094
raise (gnutls.errors.CertificateSecurityError
2365
1096
# New buffer for the fingerprint
2366
1097
buf = ctypes.create_string_buffer(20)
2367
1098
buf_len = ctypes.c_size_t()
2368
1099
# Get the fingerprint from the certificate into the buffer
2369
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2370
ctypes.byref(buf_len))
1100
(gnutls.library.functions
1101
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1102
ctypes.byref(buf_len)))
2371
1103
# Deinit the certificate
2372
gnutls.openpgp_crt_deinit(crt)
1104
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2373
1105
# Convert the buffer to a Python bytestring
2374
1106
fpr = ctypes.string_at(buf, buf_len.value)
2375
1107
# Convert the bytestring to hexadecimal notation
2376
hex_fpr = binascii.hexlify(fpr).upper()
1108
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2380
class MultiprocessingMixIn(object):
2381
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2383
def sub_process_main(self, request, address):
2385
self.finish_request(request, address)
2387
self.handle_error(request, address)
2388
self.close_request(request)
2390
def process_request(self, request, address):
2391
"""Start a new process to process the request."""
2392
proc = multiprocessing.Process(target=self.sub_process_main,
2393
args=(request, address))
2398
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2399
""" adds a pipe to the MixIn """
1112
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
1113
"""Like socketserver.ForkingMixIn, but also pass a pipe."""
2401
1114
def process_request(self, request, client_address):
2402
1115
"""Overrides and wraps the original process_request().
2404
1117
This function creates a new pipe in self.pipe
2406
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2408
proc = MultiprocessingMixIn.process_request(self, request,
2410
self.child_pipe.close()
2411
self.add_pipe(parent_pipe, proc)
2413
def add_pipe(self, parent_pipe, proc):
1119
self.pipe = os.pipe()
1120
super(ForkingMixInWithPipe,
1121
self).process_request(request, client_address)
1122
os.close(self.pipe[1]) # close write end
1123
self.add_pipe(self.pipe[0])
1124
def add_pipe(self, pipe):
2414
1125
"""Dummy function; override as necessary"""
2415
raise NotImplementedError()
2418
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1129
class IPv6_TCPServer(ForkingMixInWithPipe,
2419
1130
socketserver.TCPServer, object):
2420
1131
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2423
1134
enabled: Boolean; whether this server is activated yet
2424
1135
interface: None or a network interface name (string)
2425
1136
use_ipv6: Boolean; to use IPv6 or not
2428
1138
def __init__(self, server_address, RequestHandlerClass,
2432
"""If socketfd is set, use that file descriptor instead of
2433
creating a new one with socket.socket().
1139
interface=None, use_ipv6=True):
2435
1140
self.interface = interface
2437
1142
self.address_family = socket.AF_INET6
2438
if socketfd is not None:
2439
# Save the file descriptor
2440
self.socketfd = socketfd
2441
# Save the original socket.socket() function
2442
self.socket_socket = socket.socket
2444
# To implement --socket, we monkey patch socket.socket.
2446
# (When socketserver.TCPServer is a new-style class, we
2447
# could make self.socket into a property instead of monkey
2448
# patching socket.socket.)
2450
# Create a one-time-only replacement for socket.socket()
2451
@functools.wraps(socket.socket)
2452
def socket_wrapper(*args, **kwargs):
2453
# Restore original function so subsequent calls are
2455
socket.socket = self.socket_socket
2456
del self.socket_socket
2457
# This time only, return a new socket object from the
2458
# saved file descriptor.
2459
return socket.fromfd(self.socketfd, *args, **kwargs)
2460
# Replace socket.socket() function with wrapper
2461
socket.socket = socket_wrapper
2462
# The socketserver.TCPServer.__init__ will call
2463
# socket.socket(), which might be our replacement,
2464
# socket_wrapper(), if socketfd was set.
2465
1143
socketserver.TCPServer.__init__(self, server_address,
2466
1144
RequestHandlerClass)
2468
1145
def server_bind(self):
2469
1146
"""This overrides the normal server_bind() function
2470
1147
to bind to an interface if one was specified, and also NOT to
2471
1148
bind to an address or port if they were not specified."""
2472
global SO_BINDTODEVICE
2473
1149
if self.interface is not None:
2474
1150
if SO_BINDTODEVICE is None:
2475
# Fall back to a hard-coded value which seems to be
2477
logger.warning("SO_BINDTODEVICE not found, trying 25")
2478
SO_BINDTODEVICE = 25
2480
self.socket.setsockopt(
2481
socket.SOL_SOCKET, SO_BINDTODEVICE,
2482
(self.interface + "\0").encode("utf-8"))
2483
except socket.error as error:
2484
if error.errno == errno.EPERM:
2485
logger.error("No permission to bind to"
2486
" interface %s", self.interface)
2487
elif error.errno == errno.ENOPROTOOPT:
2488
logger.error("SO_BINDTODEVICE not available;"
2489
" cannot bind to interface %s",
2491
elif error.errno == errno.ENODEV:
2492
logger.error("Interface %s does not exist,"
2493
" cannot bind", self.interface)
1151
logger.error(u"SO_BINDTODEVICE does not exist;"
1152
u" cannot bind to interface %s",
1156
self.socket.setsockopt(socket.SOL_SOCKET,
1160
except socket.error, error:
1161
if error[0] == errno.EPERM:
1162
logger.error(u"No permission to"
1163
u" bind to interface %s",
1165
elif error[0] == errno.ENOPROTOOPT:
1166
logger.error(u"SO_BINDTODEVICE not available;"
1167
u" cannot bind to interface %s",
2496
1171
# Only bind(2) the socket if we really need to.
2497
1172
if self.server_address[0] or self.server_address[1]:
2498
1173
if not self.server_address[0]:
2499
1174
if self.address_family == socket.AF_INET6:
2500
any_address = "::" # in6addr_any
1175
any_address = u"::" # in6addr_any
2502
any_address = "0.0.0.0" # INADDR_ANY
1177
any_address = socket.INADDR_ANY
2503
1178
self.server_address = (any_address,
2504
1179
self.server_address[1])
2505
1180
elif not self.server_address[1]:
2506
self.server_address = (self.server_address[0], 0)
1181
self.server_address = (self.server_address[0],
2507
1183
# if self.interface:
2508
1184
# self.server_address = (self.server_address[0],
2516
1192
class MandosServer(IPv6_TCPServer):
2517
1193
"""Mandos server.
2520
1196
clients: set of Client objects
2521
1197
gnutls_priority GnuTLS priority string
2522
1198
use_dbus: Boolean; to emit D-Bus signals or not
2524
Assumes a GLib.MainLoop event loop.
1200
Assumes a gobject.MainLoop event loop.
2527
1202
def __init__(self, server_address, RequestHandlerClass,
2531
gnutls_priority=None,
1203
interface=None, use_ipv6=True, clients=None,
1204
gnutls_priority=None, use_dbus=True):
2534
1205
self.enabled = False
2535
1206
self.clients = clients
2536
1207
if self.clients is None:
1208
self.clients = set()
2538
1209
self.use_dbus = use_dbus
2539
1210
self.gnutls_priority = gnutls_priority
2540
1211
IPv6_TCPServer.__init__(self, server_address,
2541
1212
RequestHandlerClass,
2542
interface=interface,
1213
interface = interface,
1214
use_ipv6 = use_ipv6)
2546
1215
def server_activate(self):
2547
1216
if self.enabled:
2548
1217
return socketserver.TCPServer.server_activate(self)
2550
1218
def enable(self):
2551
1219
self.enabled = True
2553
def add_pipe(self, parent_pipe, proc):
1220
def add_pipe(self, pipe):
2554
1221
# Call "handle_ipc" for both data and EOF events
2556
parent_pipe.fileno(),
2557
GLib.IO_IN | GLib.IO_HUP,
2558
functools.partial(self.handle_ipc,
2559
parent_pipe=parent_pipe,
2562
def handle_ipc(self, source, condition,
2565
client_object=None):
2566
# error, or the other end of multiprocessing.Pipe has closed
2567
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2568
# Wait for other process to exit
2572
# Read a request from the child
2573
request = parent_pipe.recv()
2574
command = request[0]
2576
if command == 'init':
2578
address = request[2]
2580
for c in self.clients.values():
2581
if c.fingerprint == fpr:
2585
logger.info("Client not found for fingerprint: %s, ad"
2586
"dress: %s", fpr, address)
2589
mandos_dbus_service.ClientNotFound(fpr,
2591
parent_pipe.send(False)
2595
parent_pipe.fileno(),
2596
GLib.IO_IN | GLib.IO_HUP,
2597
functools.partial(self.handle_ipc,
2598
parent_pipe=parent_pipe,
2600
client_object=client))
2601
parent_pipe.send(True)
2602
# remove the old hook in favor of the new above hook on
2605
if command == 'funcall':
2606
funcname = request[1]
2610
parent_pipe.send(('data', getattr(client_object,
2614
if command == 'getattr':
2615
attrname = request[1]
2616
if isinstance(client_object.__getattribute__(attrname),
2617
collections.Callable):
2618
parent_pipe.send(('function', ))
2621
'data', client_object.__getattribute__(attrname)))
2623
if command == 'setattr':
2624
attrname = request[1]
2626
setattr(client_object, attrname, value)
1222
gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1224
def handle_ipc(self, source, condition, file_objects={}):
1226
gobject.IO_IN: u"IN", # There is data to read.
1227
gobject.IO_OUT: u"OUT", # Data can be written (without
1229
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1230
gobject.IO_ERR: u"ERR", # Error condition.
1231
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1232
# broken, usually for pipes and
1235
conditions_string = ' | '.join(name
1237
condition_names.iteritems()
1238
if cond & condition)
1239
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1242
# Turn the pipe file descriptor into a Python file object
1243
if source not in file_objects:
1244
file_objects[source] = os.fdopen(source, u"r", 1)
1246
# Read a line from the file object
1247
cmdline = file_objects[source].readline()
1248
if not cmdline: # Empty line means end of file
1249
# close the IPC pipe
1250
file_objects[source].close()
1251
del file_objects[source]
1253
# Stop calling this function
1256
logger.debug(u"IPC command: %r", cmdline)
1258
# Parse and act on command
1259
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1261
if cmd == u"NOTFOUND":
1262
logger.warning(u"Client not found for fingerprint: %s",
1266
mandos_dbus_service.ClientNotFound(args)
1267
elif cmd == u"INVALID":
1268
for client in self.clients:
1269
if client.name == args:
1270
logger.warning(u"Client %s is invalid", args)
1276
logger.error(u"Unknown client %s is invalid", args)
1277
elif cmd == u"SENDING":
1278
for client in self.clients:
1279
if client.name == args:
1280
logger.info(u"Sending secret to %s", client.name)
1284
client.ReceivedSecret()
1287
logger.error(u"Sending secret to unknown client %s",
1290
logger.error(u"Unknown IPC command: %r", cmdline)
1292
# Keep calling this function
2631
def rfc3339_duration_to_delta(duration):
2632
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2634
>>> rfc3339_duration_to_delta("P7D")
2635
datetime.timedelta(7)
2636
>>> rfc3339_duration_to_delta("PT60S")
2637
datetime.timedelta(0, 60)
2638
>>> rfc3339_duration_to_delta("PT60M")
2639
datetime.timedelta(0, 3600)
2640
>>> rfc3339_duration_to_delta("PT24H")
2641
datetime.timedelta(1)
2642
>>> rfc3339_duration_to_delta("P1W")
2643
datetime.timedelta(7)
2644
>>> rfc3339_duration_to_delta("PT5M30S")
2645
datetime.timedelta(0, 330)
2646
>>> rfc3339_duration_to_delta("P1DT3M20S")
2647
datetime.timedelta(1, 200)
2650
# Parsing an RFC 3339 duration with regular expressions is not
2651
# possible - there would have to be multiple places for the same
2652
# values, like seconds. The current code, while more esoteric, is
2653
# cleaner without depending on a parsing library. If Python had a
2654
# built-in library for parsing we would use it, but we'd like to
2655
# avoid excessive use of external libraries.
2657
# New type for defining tokens, syntax, and semantics all-in-one
2658
Token = collections.namedtuple("Token", (
2659
"regexp", # To match token; if "value" is not None, must have
2660
# a "group" containing digits
2661
"value", # datetime.timedelta or None
2662
"followers")) # Tokens valid after this token
2663
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2664
# the "duration" ABNF definition in RFC 3339, Appendix A.
2665
token_end = Token(re.compile(r"$"), None, frozenset())
2666
token_second = Token(re.compile(r"(\d+)S"),
2667
datetime.timedelta(seconds=1),
2668
frozenset((token_end, )))
2669
token_minute = Token(re.compile(r"(\d+)M"),
2670
datetime.timedelta(minutes=1),
2671
frozenset((token_second, token_end)))
2672
token_hour = Token(re.compile(r"(\d+)H"),
2673
datetime.timedelta(hours=1),
2674
frozenset((token_minute, token_end)))
2675
token_time = Token(re.compile(r"T"),
2677
frozenset((token_hour, token_minute,
2679
token_day = Token(re.compile(r"(\d+)D"),
2680
datetime.timedelta(days=1),
2681
frozenset((token_time, token_end)))
2682
token_month = Token(re.compile(r"(\d+)M"),
2683
datetime.timedelta(weeks=4),
2684
frozenset((token_day, token_end)))
2685
token_year = Token(re.compile(r"(\d+)Y"),
2686
datetime.timedelta(weeks=52),
2687
frozenset((token_month, token_end)))
2688
token_week = Token(re.compile(r"(\d+)W"),
2689
datetime.timedelta(weeks=1),
2690
frozenset((token_end, )))
2691
token_duration = Token(re.compile(r"P"), None,
2692
frozenset((token_year, token_month,
2693
token_day, token_time,
2695
# Define starting values:
2697
value = datetime.timedelta()
2699
# Following valid tokens
2700
followers = frozenset((token_duration, ))
2701
# String left to parse
2703
# Loop until end token is found
2704
while found_token is not token_end:
2705
# Search for any currently valid tokens
2706
for token in followers:
2707
match = token.regexp.match(s)
2708
if match is not None:
2710
if token.value is not None:
2711
# Value found, parse digits
2712
factor = int(match.group(1), 10)
2713
# Add to value so far
2714
value += factor * token.value
2715
# Strip token from string
2716
s = token.regexp.sub("", s, 1)
2719
# Set valid next tokens
2720
followers = found_token.followers
2723
# No currently valid tokens were found
2724
raise ValueError("Invalid RFC 3339 duration: {!r}"
2730
1296
def string_to_delta(interval):
2731
1297
"""Parse a string and return a datetime.timedelta
2733
>>> string_to_delta('7d')
1299
>>> string_to_delta(u'7d')
2734
1300
datetime.timedelta(7)
2735
>>> string_to_delta('60s')
1301
>>> string_to_delta(u'60s')
2736
1302
datetime.timedelta(0, 60)
2737
>>> string_to_delta('60m')
1303
>>> string_to_delta(u'60m')
2738
1304
datetime.timedelta(0, 3600)
2739
>>> string_to_delta('24h')
1305
>>> string_to_delta(u'24h')
2740
1306
datetime.timedelta(1)
2741
>>> string_to_delta('1w')
1307
>>> string_to_delta(u'1w')
2742
1308
datetime.timedelta(7)
2743
>>> string_to_delta('5m 30s')
1309
>>> string_to_delta(u'5m 30s')
2744
1310
datetime.timedelta(0, 330)
2748
return rfc3339_duration_to_delta(interval)
2752
1312
timevalue = datetime.timedelta(0)
2753
1313
for s in interval.split():
1315
suffix = unicode(s[-1])
2756
1316
value = int(s[:-1])
2758
1318
delta = datetime.timedelta(value)
1319
elif suffix == u"s":
2760
1320
delta = datetime.timedelta(0, value)
1321
elif suffix == u"m":
2762
1322
delta = datetime.timedelta(0, 0, 0, 0, value)
1323
elif suffix == u"h":
2764
1324
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1325
elif suffix == u"w":
2766
1326
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2768
raise ValueError("Unknown suffix {!r}".format(suffix))
2769
except IndexError as e:
2770
raise ValueError(*(e.args))
1329
except (ValueError, IndexError):
2771
1331
timevalue += delta
2772
1332
return timevalue
2775
def daemon(nochdir=False, noclose=False):
1335
def if_nametoindex(interface):
1336
"""Call the C function if_nametoindex(), or equivalent
1338
Note: This function cannot accept a unicode string."""
1339
global if_nametoindex
1341
if_nametoindex = (ctypes.cdll.LoadLibrary
1342
(ctypes.util.find_library(u"c"))
1344
except (OSError, AttributeError):
1345
logger.warning(u"Doing if_nametoindex the hard way")
1346
def if_nametoindex(interface):
1347
"Get an interface index the hard way, i.e. using fcntl()"
1348
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1349
with closing(socket.socket()) as s:
1350
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1351
struct.pack(str(u"16s16x"),
1353
interface_index = struct.unpack(str(u"I"),
1355
return interface_index
1356
return if_nametoindex(interface)
1359
def daemon(nochdir = False, noclose = False):
2776
1360
"""See daemon(3). Standard BSD Unix function.
2778
1362
This should really exist as os.daemon, but it doesn't (yet)."""
2782
1366
if not nochdir:
2786
1370
if not noclose:
2787
1371
# Close all standard open file descriptors
2788
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1372
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2789
1373
if not stat.S_ISCHR(os.fstat(null).st_mode):
2790
1374
raise OSError(errno.ENODEV,
2791
"{} not a character device"
2792
.format(os.devnull))
1375
u"/dev/null not a character device")
2793
1376
os.dup2(null, sys.stdin.fileno())
2794
1377
os.dup2(null, sys.stdout.fileno())
2795
1378
os.dup2(null, sys.stderr.fileno())
2802
1385
##################################################################
2803
1386
# Parsing of options, both command line and config file
2805
parser = argparse.ArgumentParser()
2806
parser.add_argument("-v", "--version", action="version",
2807
version="%(prog)s {}".format(version),
2808
help="show version number and exit")
2809
parser.add_argument("-i", "--interface", metavar="IF",
2810
help="Bind to interface IF")
2811
parser.add_argument("-a", "--address",
2812
help="Address to listen for requests on")
2813
parser.add_argument("-p", "--port", type=int,
2814
help="Port number to receive requests on")
2815
parser.add_argument("--check", action="store_true",
2816
help="Run self-test")
2817
parser.add_argument("--debug", action="store_true",
2818
help="Debug mode; run in foreground and log"
2819
" to terminal", default=None)
2820
parser.add_argument("--debuglevel", metavar="LEVEL",
2821
help="Debug level for stdout output")
2822
parser.add_argument("--priority", help="GnuTLS"
2823
" priority string (see GnuTLS documentation)")
2824
parser.add_argument("--servicename",
2825
metavar="NAME", help="Zeroconf service name")
2826
parser.add_argument("--configdir",
2827
default="/etc/mandos", metavar="DIR",
2828
help="Directory to search for configuration"
2830
parser.add_argument("--no-dbus", action="store_false",
2831
dest="use_dbus", help="Do not provide D-Bus"
2832
" system bus interface", default=None)
2833
parser.add_argument("--no-ipv6", action="store_false",
2834
dest="use_ipv6", help="Do not use IPv6",
2836
parser.add_argument("--no-restore", action="store_false",
2837
dest="restore", help="Do not restore stored"
2838
" state", default=None)
2839
parser.add_argument("--socket", type=int,
2840
help="Specify a file descriptor to a network"
2841
" socket to use instead of creating one")
2842
parser.add_argument("--statedir", metavar="DIR",
2843
help="Directory to save/restore state in")
2844
parser.add_argument("--foreground", action="store_true",
2845
help="Run in foreground", default=None)
2846
parser.add_argument("--no-zeroconf", action="store_false",
2847
dest="zeroconf", help="Do not use Zeroconf",
2850
options = parser.parse_args()
1388
parser = optparse.OptionParser(version = "%%prog %s" % version)
1389
parser.add_option("-i", u"--interface", type=u"string",
1390
metavar="IF", help=u"Bind to interface IF")
1391
parser.add_option("-a", u"--address", type=u"string",
1392
help=u"Address to listen for requests on")
1393
parser.add_option("-p", u"--port", type=u"int",
1394
help=u"Port number to receive requests on")
1395
parser.add_option("--check", action=u"store_true",
1396
help=u"Run self-test")
1397
parser.add_option("--debug", action=u"store_true",
1398
help=u"Debug mode; run in foreground and log to"
1400
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1401
u" priority string (see GnuTLS documentation)")
1402
parser.add_option("--servicename", type=u"string",
1403
metavar=u"NAME", help=u"Zeroconf service name")
1404
parser.add_option("--configdir", type=u"string",
1405
default=u"/etc/mandos", metavar=u"DIR",
1406
help=u"Directory to search for configuration"
1408
parser.add_option("--no-dbus", action=u"store_false",
1409
dest=u"use_dbus", help=u"Do not provide D-Bus"
1410
u" system bus interface")
1411
parser.add_option("--no-ipv6", action=u"store_false",
1412
dest=u"use_ipv6", help=u"Do not use IPv6")
1413
options = parser.parse_args()[0]
2852
1415
if options.check:
2854
fail_count, test_count = doctest.testmod()
2855
sys.exit(os.EX_OK if fail_count == 0 else 1)
2857
1420
# Default values for config file for server-global settings
2858
server_defaults = {"interface": "",
2863
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2864
":+SIGN-DSA-SHA256",
2865
"servicename": "Mandos",
2871
"statedir": "/var/lib/mandos",
2872
"foreground": "False",
1421
server_defaults = { u"interface": u"",
1426
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1427
u"servicename": u"Mandos",
1428
u"use_dbus": u"True",
1429
u"use_ipv6": u"True",
2876
1432
# Parse config file for server-global settings
2877
1433
server_config = configparser.SafeConfigParser(server_defaults)
2878
1434
del server_defaults
2879
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1435
server_config.read(os.path.join(options.configdir,
2880
1437
# Convert the SafeConfigParser object to a dict
2881
1438
server_settings = server_config.defaults()
2882
1439
# Use the appropriate methods on the non-string config options
2883
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2884
server_settings[option] = server_config.getboolean("DEFAULT",
1440
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1441
server_settings[option] = server_config.getboolean(u"DEFAULT",
2886
1443
if server_settings["port"]:
2887
server_settings["port"] = server_config.getint("DEFAULT",
2889
if server_settings["socket"]:
2890
server_settings["socket"] = server_config.getint("DEFAULT",
2892
# Later, stdin will, and stdout and stderr might, be dup'ed
2893
# over with an opened os.devnull. But we don't want this to
2894
# happen with a supplied network socket.
2895
if 0 <= server_settings["socket"] <= 2:
2896
server_settings["socket"] = os.dup(server_settings
1444
server_settings["port"] = server_config.getint(u"DEFAULT",
2898
1446
del server_config
2900
1448
# Override the settings from the config file with command line
2901
1449
# options, if set.
2902
for option in ("interface", "address", "port", "debug",
2903
"priority", "servicename", "configdir", "use_dbus",
2904
"use_ipv6", "debuglevel", "restore", "statedir",
2905
"socket", "foreground", "zeroconf"):
1450
for option in (u"interface", u"address", u"port", u"debug",
1451
u"priority", u"servicename", u"configdir",
1452
u"use_dbus", u"use_ipv6"):
2906
1453
value = getattr(options, option)
2907
1454
if value is not None:
2908
1455
server_settings[option] = value
2910
1457
# Force all strings to be unicode
2911
1458
for option in server_settings.keys():
2912
if isinstance(server_settings[option], bytes):
2913
server_settings[option] = (server_settings[option]
2915
# Force all boolean options to be boolean
2916
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2917
"foreground", "zeroconf"):
2918
server_settings[option] = bool(server_settings[option])
2919
# Debug implies foreground
2920
if server_settings["debug"]:
2921
server_settings["foreground"] = True
1459
if type(server_settings[option]) is str:
1460
server_settings[option] = unicode(server_settings[option])
2922
1461
# Now we have our good server settings in "server_settings"
2924
1463
##################################################################
2926
if (not server_settings["zeroconf"]
2927
and not (server_settings["port"]
2928
or server_settings["socket"] != "")):
2929
parser.error("Needs port or socket to work without Zeroconf")
2931
1465
# For convenience
2932
debug = server_settings["debug"]
2933
debuglevel = server_settings["debuglevel"]
2934
use_dbus = server_settings["use_dbus"]
2935
use_ipv6 = server_settings["use_ipv6"]
2936
stored_state_path = os.path.join(server_settings["statedir"],
2938
foreground = server_settings["foreground"]
2939
zeroconf = server_settings["zeroconf"]
2942
initlogger(debug, logging.DEBUG)
2947
level = getattr(logging, debuglevel.upper())
2948
initlogger(debug, level)
2950
if server_settings["servicename"] != "Mandos":
2951
syslogger.setFormatter(
2952
logging.Formatter('Mandos ({}) [%(process)d]:'
2953
' %(levelname)s: %(message)s'.format(
2954
server_settings["servicename"])))
1466
debug = server_settings[u"debug"]
1467
use_dbus = server_settings[u"use_dbus"]
1468
use_ipv6 = server_settings[u"use_ipv6"]
1471
syslogger.setLevel(logging.WARNING)
1472
console.setLevel(logging.WARNING)
1474
if server_settings[u"servicename"] != u"Mandos":
1475
syslogger.setFormatter(logging.Formatter
1476
(u'Mandos (%s) [%%(process)d]:'
1477
u' %%(levelname)s: %%(message)s'
1478
% server_settings[u"servicename"]))
2956
1480
# Parse config file with clients
2957
client_config = configparser.SafeConfigParser(Client
2959
client_config.read(os.path.join(server_settings["configdir"],
1481
client_defaults = { u"timeout": u"1h",
1483
u"checker": u"fping -q -- %%(host)s",
1486
client_config = configparser.SafeConfigParser(client_defaults)
1487
client_config.read(os.path.join(server_settings[u"configdir"],
2962
1490
global mandos_dbus_service
2963
1491
mandos_dbus_service = None
2966
if server_settings["socket"] != "":
2967
socketfd = server_settings["socket"]
2968
tcp_server = MandosServer(
2969
(server_settings["address"], server_settings["port"]),
2971
interface=(server_settings["interface"] or None),
2973
gnutls_priority=server_settings["priority"],
2977
pidfilename = "/run/mandos.pid"
2978
if not os.path.isdir("/run/."):
2979
pidfilename = "/var/run/mandos.pid"
2982
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2983
except IOError as e:
2984
logger.error("Could not open file %r", pidfilename,
2987
for name, group in (("_mandos", "_mandos"),
2988
("mandos", "mandos"),
2989
("nobody", "nogroup")):
2991
uid = pwd.getpwnam(name).pw_uid
2992
gid = pwd.getpwnam(group).pw_gid
1493
tcp_server = MandosServer((server_settings[u"address"],
1494
server_settings[u"port"]),
1496
interface=server_settings[u"interface"],
1499
server_settings[u"priority"],
1501
pidfilename = u"/var/run/mandos.pid"
1503
pidfile = open(pidfilename, u"w")
1505
logger.error(u"Could not open file %r", pidfilename)
1508
uid = pwd.getpwnam(u"_mandos").pw_uid
1509
gid = pwd.getpwnam(u"_mandos").pw_gid
1512
uid = pwd.getpwnam(u"mandos").pw_uid
1513
gid = pwd.getpwnam(u"mandos").pw_gid
2994
1514
except KeyError:
1516
uid = pwd.getpwnam(u"nobody").pw_uid
1517
gid = pwd.getpwnam(u"nobody").pw_gid
3003
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3005
except OSError as error:
3006
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3007
.format(uid, gid, os.strerror(error.errno)))
3008
if error.errno != errno.EPERM:
1524
except OSError, error:
1525
if error[0] != errno.EPERM:
1528
# Enable all possible GnuTLS debugging
3012
# Enable all possible GnuTLS debugging
3014
1530
# "Use a log level over 10 to enable all debugging options."
3015
1531
# - GnuTLS manual
3016
gnutls.global_set_log_level(11)
1532
gnutls.library.functions.gnutls_global_set_log_level(11)
1534
@gnutls.library.types.gnutls_log_func
3019
1535
def debug_gnutls(level, string):
3020
logger.debug("GnuTLS: %s", string[:-1])
3022
gnutls.global_set_log_function(debug_gnutls)
3024
# Redirect stdin so all checkers get /dev/null
3025
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3026
os.dup2(null, sys.stdin.fileno())
3030
# Need to fork before connecting to D-Bus
3032
# Close all input and output, do double fork, etc.
3035
# multiprocessing will use threads, so before we use GLib we need
3036
# to inform GLib that threads will be used.
1536
logger.debug(u"GnuTLS: %s", string[:-1])
1538
(gnutls.library.functions
1539
.gnutls_global_set_log_function(debug_gnutls))
3039
1541
global main_loop
3040
1542
# From the Avahi example code
3041
DBusGMainLoop(set_as_default=True)
3042
main_loop = GLib.MainLoop()
1543
DBusGMainLoop(set_as_default=True )
1544
main_loop = gobject.MainLoop()
3043
1545
bus = dbus.SystemBus()
3044
1546
# End of Avahi example code
3047
bus_name = dbus.service.BusName("se.recompile.Mandos",
3050
old_bus_name = dbus.service.BusName(
3051
"se.bsnet.fukt.Mandos", bus,
3053
except dbus.exceptions.DBusException as e:
3054
logger.error("Disabling D-Bus:", exc_info=e)
3056
server_settings["use_dbus"] = False
3057
tcp_server.use_dbus = False
3059
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3060
service = AvahiServiceToSyslog(
3061
name=server_settings["servicename"],
3062
servicetype="_mandos._tcp",
3065
if server_settings["interface"]:
3066
service.interface = if_nametoindex(
3067
server_settings["interface"].encode("utf-8"))
3069
global multiprocessing_manager
3070
multiprocessing_manager = multiprocessing.Manager()
1548
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1549
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1550
service = AvahiService(name = server_settings[u"servicename"],
1551
servicetype = u"_mandos._tcp",
1552
protocol = protocol, bus = bus)
1553
if server_settings["interface"]:
1554
service.interface = (if_nametoindex
1555
(str(server_settings[u"interface"])))
3072
1557
client_class = Client
3074
client_class = functools.partial(ClientDBus, bus=bus)
3076
client_settings = Client.config_parser(client_config)
3077
old_client_settings = {}
3080
# This is used to redirect stdout and stderr for checker processes
3082
wnull = open(os.devnull, "w") # A writable /dev/null
3083
# Only used if server is running in foreground but not in debug
3085
if debug or not foreground:
3088
# Get client data and settings from last running state.
3089
if server_settings["restore"]:
3091
with open(stored_state_path, "rb") as stored_state:
3092
if sys.version_info.major == 2:
3093
clients_data, old_client_settings = pickle.load(
3096
bytes_clients_data, bytes_old_client_settings = (
3097
pickle.load(stored_state, encoding="bytes"))
3098
# Fix bytes to strings
3101
clients_data = {(key.decode("utf-8")
3102
if isinstance(key, bytes)
3105
bytes_clients_data.items()}
3106
del bytes_clients_data
3107
for key in clients_data:
3108
value = {(k.decode("utf-8")
3109
if isinstance(k, bytes) else k): v
3111
clients_data[key].items()}
3112
clients_data[key] = value
3114
value["client_structure"] = [
3116
if isinstance(s, bytes)
3118
value["client_structure"]]
3120
for k in ("name", "host"):
3121
if isinstance(value[k], bytes):
3122
value[k] = value[k].decode("utf-8")
3123
# old_client_settings
3125
old_client_settings = {
3126
(key.decode("utf-8")
3127
if isinstance(key, bytes)
3130
bytes_old_client_settings.items()}
3131
del bytes_old_client_settings
3133
for value in old_client_settings.values():
3134
if isinstance(value["host"], bytes):
3135
value["host"] = (value["host"]
3137
os.remove(stored_state_path)
3138
except IOError as e:
3139
if e.errno == errno.ENOENT:
3140
logger.warning("Could not load persistent state:"
3141
" {}".format(os.strerror(e.errno)))
3143
logger.critical("Could not load persistent state:",
3146
except EOFError as e:
3147
logger.warning("Could not load persistent state: "
3151
with PGPEngine() as pgp:
3152
for client_name, client in clients_data.items():
3153
# Skip removed clients
3154
if client_name not in client_settings:
3157
# Decide which value to use after restoring saved state.
3158
# We have three different values: Old config file,
3159
# new config file, and saved state.
3160
# New config value takes precedence if it differs from old
3161
# config value, otherwise use saved state.
3162
for name, value in client_settings[client_name].items():
3164
# For each value in new config, check if it
3165
# differs from the old config value (Except for
3166
# the "secret" attribute)
3167
if (name != "secret"
3169
old_client_settings[client_name][name])):
3170
client[name] = value
3174
# Clients who has passed its expire date can still be
3175
# enabled if its last checker was successful. A Client
3176
# whose checker succeeded before we stored its state is
3177
# assumed to have successfully run all checkers during
3179
if client["enabled"]:
3180
if datetime.datetime.utcnow() >= client["expires"]:
3181
if not client["last_checked_ok"]:
3183
"disabling client {} - Client never "
3184
"performed a successful checker".format(
3186
client["enabled"] = False
3187
elif client["last_checker_status"] != 0:
3189
"disabling client {} - Client last"
3190
" checker failed with error code"
3193
client["last_checker_status"]))
3194
client["enabled"] = False
3196
client["expires"] = (
3197
datetime.datetime.utcnow()
3198
+ client["timeout"])
3199
logger.debug("Last checker succeeded,"
3200
" keeping {} enabled".format(
3203
client["secret"] = pgp.decrypt(
3204
client["encrypted_secret"],
3205
client_settings[client_name]["secret"])
3207
# If decryption fails, we use secret from new settings
3208
logger.debug("Failed to decrypt {} old secret".format(
3210
client["secret"] = (client_settings[client_name]
3213
# Add/remove clients based on new changes made to config
3214
for client_name in (set(old_client_settings)
3215
- set(client_settings)):
3216
del clients_data[client_name]
3217
for client_name in (set(client_settings)
3218
- set(old_client_settings)):
3219
clients_data[client_name] = client_settings[client_name]
3221
# Create all client objects
3222
for client_name, client in clients_data.items():
3223
tcp_server.clients[client_name] = client_class(
3226
server_settings=server_settings)
1559
client_class = functools.partial(ClientDBus, bus = bus)
1560
tcp_server.clients.update(set(
1561
client_class(name = section,
1562
config= dict(client_config.items(section)))
1563
for section in client_config.sections()))
3228
1564
if not tcp_server.clients:
3229
logger.warning("No clients defined")
3232
if pidfile is not None:
1565
logger.warning(u"No clients defined")
1568
# Redirect stdin so all checkers get /dev/null
1569
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1570
os.dup2(null, sys.stdin.fileno())
1574
# No console logging
1575
logger.removeHandler(console)
1576
# Close all input and output, do double fork, etc.
1580
with closing(pidfile):
3233
1581
pid = os.getpid()
3236
print(pid, file=pidfile)
3238
logger.error("Could not write to file %r with PID %d",
1582
pidfile.write(str(pid) + "\n")
3243
for termsig in (signal.SIGHUP, signal.SIGTERM):
3244
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3245
lambda: main_loop.quit() and False)
1585
logger.error(u"Could not write to file %r with PID %d",
1588
# "pidfile" was never created
1593
"Cleanup function; run on exit"
1596
while tcp_server.clients:
1597
client = tcp_server.clients.pop()
1598
client.disable_hook = None
1601
atexit.register(cleanup)
1604
signal.signal(signal.SIGINT, signal.SIG_IGN)
1605
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1606
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3249
@alternate_dbus_interfaces(
3250
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3251
class MandosDBusService(DBusObjectWithObjectManager):
1609
class MandosDBusService(dbus.service.Object):
3252
1610
"""A D-Bus proxy object"""
3254
1611
def __init__(self):
3255
dbus.service.Object.__init__(self, bus, "/")
3257
_interface = "se.recompile.Mandos"
3259
@dbus.service.signal(_interface, signature="o")
3260
def ClientAdded(self, objpath):
3264
@dbus.service.signal(_interface, signature="ss")
3265
def ClientNotFound(self, fingerprint, address):
3269
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3271
@dbus.service.signal(_interface, signature="os")
1612
dbus.service.Object.__init__(self, bus, u"/")
1613
_interface = u"se.bsnet.fukt.Mandos"
1615
@dbus.service.signal(_interface, signature=u"oa{sv}")
1616
def ClientAdded(self, objpath, properties):
1620
@dbus.service.signal(_interface, signature=u"s")
1621
def ClientNotFound(self, fingerprint):
1625
@dbus.service.signal(_interface, signature=u"os")
3272
1626
def ClientRemoved(self, objpath, name):
3276
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3278
@dbus.service.method(_interface, out_signature="ao")
1630
@dbus.service.method(_interface, out_signature=u"ao")
3279
1631
def GetAllClients(self):
3281
return dbus.Array(c.dbus_object_path for c in
3282
tcp_server.clients.values())
3284
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1633
return dbus.Array(c.dbus_object_path
1634
for c in tcp_server.clients)
3286
1636
@dbus.service.method(_interface,
3287
out_signature="a{oa{sv}}")
1637
out_signature=u"a{oa{sv}}")
3288
1638
def GetAllClientsWithProperties(self):
3290
1640
return dbus.Dictionary(
3291
{c.dbus_object_path: c.GetAll(
3292
"se.recompile.Mandos.Client")
3293
for c in tcp_server.clients.values()},
3296
@dbus.service.method(_interface, in_signature="o")
1641
((c.dbus_object_path, c.GetAll(u""))
1642
for c in tcp_server.clients),
1643
signature=u"oa{sv}")
1645
@dbus.service.method(_interface, in_signature=u"o")
3297
1646
def RemoveClient(self, object_path):
3299
for c in tcp_server.clients.values():
1648
for c in tcp_server.clients:
3300
1649
if c.dbus_object_path == object_path:
3301
del tcp_server.clients[c.name]
1650
tcp_server.clients.remove(c)
3302
1651
c.remove_from_connection()
3303
# Don't signal the disabling
3304
c.disable(quiet=True)
3305
# Emit D-Bus signal for removal
3306
self.client_removed_signal(c)
1652
# Don't signal anything except ClientRemoved
1653
c.disable(signal=False)
1655
self.ClientRemoved(object_path, c.name)
3308
raise KeyError(object_path)
3312
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3313
out_signature="a{oa{sa{sv}}}")
3314
def GetManagedObjects(self):
3316
return dbus.Dictionary(
3317
{client.dbus_object_path:
3319
{interface: client.GetAll(interface)
3321
client._get_all_interface_names()})
3322
for client in tcp_server.clients.values()})
3324
def client_added_signal(self, client):
3325
"""Send the new standard signal and the old signal"""
3327
# New standard signal
3328
self.InterfacesAdded(
3329
client.dbus_object_path,
3331
{interface: client.GetAll(interface)
3333
client._get_all_interface_names()}))
3335
self.ClientAdded(client.dbus_object_path)
3337
def client_removed_signal(self, client):
3338
"""Send the new standard signal and the old signal"""
3340
# New standard signal
3341
self.InterfacesRemoved(
3342
client.dbus_object_path,
3343
client._get_all_interface_names())
3345
self.ClientRemoved(client.dbus_object_path,
3348
1661
mandos_dbus_service = MandosDBusService()
3350
# Save modules to variables to exempt the modules from being
3351
# unloaded before the function registered with atexit() is run.
3352
mp = multiprocessing
3356
"Cleanup function; run on exit"
3360
mp.active_children()
3362
if not (tcp_server.clients or client_settings):
3365
# Store client before exiting. Secrets are encrypted with key
3366
# based on what config file has. If config file is
3367
# removed/edited, old secret will thus be unrecovable.
3369
with PGPEngine() as pgp:
3370
for client in tcp_server.clients.values():
3371
key = client_settings[client.name]["secret"]
3372
client.encrypted_secret = pgp.encrypt(client.secret,
3376
# A list of attributes that can not be pickled
3378
exclude = {"bus", "changedstate", "secret",
3379
"checker", "server_settings"}
3380
for name, typ in inspect.getmembers(dbus.service
3384
client_dict["encrypted_secret"] = (client
3386
for attr in client.client_structure:
3387
if attr not in exclude:
3388
client_dict[attr] = getattr(client, attr)
3390
clients[client.name] = client_dict
3391
del client_settings[client.name]["secret"]
3394
with tempfile.NamedTemporaryFile(
3398
dir=os.path.dirname(stored_state_path),
3399
delete=False) as stored_state:
3400
pickle.dump((clients, client_settings), stored_state,
3402
tempname = stored_state.name
3403
os.rename(tempname, stored_state_path)
3404
except (IOError, OSError) as e:
3410
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3411
logger.warning("Could not save persistent state: {}"
3412
.format(os.strerror(e.errno)))
3414
logger.warning("Could not save persistent state:",
3418
# Delete all clients, and settings from config
3419
while tcp_server.clients:
3420
name, client = tcp_server.clients.popitem()
3422
client.remove_from_connection()
3423
# Don't signal the disabling
3424
client.disable(quiet=True)
3425
# Emit D-Bus signal for removal
3427
mandos_dbus_service.client_removed_signal(client)
3428
client_settings.clear()
3430
atexit.register(cleanup)
3432
for client in tcp_server.clients.values():
1663
for client in tcp_server.clients:
3434
# Emit D-Bus signal for adding
3435
mandos_dbus_service.client_added_signal(client)
3436
# Need to initiate checking of clients
3438
client.init_checker()
1666
mandos_dbus_service.ClientAdded(client.dbus_object_path,
3440
1670
tcp_server.enable()
3441
1671
tcp_server.server_activate()
3443
1673
# Find out what port we got
3445
service.port = tcp_server.socket.getsockname()[1]
1674
service.port = tcp_server.socket.getsockname()[1]
3447
logger.info("Now listening on address %r, port %d,"
3448
" flowinfo %d, scope_id %d",
3449
*tcp_server.socket.getsockname())
1676
logger.info(u"Now listening on address %r, port %d,"
1677
" flowinfo %d, scope_id %d"
1678
% tcp_server.socket.getsockname())
3451
logger.info("Now listening on address %r, port %d",
3452
*tcp_server.socket.getsockname())
3454
# service.interface = tcp_server.socket.getsockname()[3]
1680
logger.info(u"Now listening on address %r, port %d"
1681
% tcp_server.socket.getsockname())
1683
#service.interface = tcp_server.socket.getsockname()[3]
3458
# From the Avahi example code
3461
except dbus.exceptions.DBusException as error:
3462
logger.critical("D-Bus Exception", exc_info=error)
3465
# End of Avahi example code
3467
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3468
lambda *args, **kwargs:
3469
(tcp_server.handle_request
3470
(*args[2:], **kwargs) or True))
3472
logger.debug("Starting main loop")
1686
# From the Avahi example code
1689
except dbus.exceptions.DBusException, error:
1690
logger.critical(u"DBusException: %s", error)
1692
# End of Avahi example code
1694
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1695
lambda *args, **kwargs:
1696
(tcp_server.handle_request
1697
(*args[2:], **kwargs) or True))
1699
logger.debug(u"Starting main loop")
3473
1700
main_loop.run()
3474
except AvahiError as error:
3475
logger.critical("Avahi Error", exc_info=error)
1701
except AvahiError, error:
1702
logger.critical(u"AvahiError: %s", error)
3478
1704
except KeyboardInterrupt:
3480
print("", file=sys.stderr)
3481
logger.debug("Server received KeyboardInterrupt")
3482
logger.debug("Server exiting")
3483
# Must run before the D-Bus bus name gets deregistered
1707
logger.debug(u"Server received KeyboardInterrupt")
1708
logger.debug(u"Server exiting")
3487
1710
if __name__ == '__main__':