190
419
dbus.UInt16(self.port),
191
420
avahi.string_array_to_txt_array(self.TXT))
192
421
self.group.Commit()
193
423
def entry_group_state_changed(self, state, error):
194
424
"""Derived from the Avahi example code"""
195
logger.debug(u"Avahi state change: %i", state)
425
logger.debug("Avahi entry group state change: %i", state)
197
427
if state == avahi.ENTRY_GROUP_ESTABLISHED:
198
logger.debug(u"Zeroconf service established.")
428
logger.debug("Zeroconf service established.")
199
429
elif state == avahi.ENTRY_GROUP_COLLISION:
200
logger.warning(u"Zeroconf service name collision.")
430
logger.info("Zeroconf service name collision.")
202
432
elif state == avahi.ENTRY_GROUP_FAILURE:
203
logger.critical(u"Avahi: Error in group state changed %s",
205
raise AvahiGroupError(u"State changed: %s"
433
logger.critical("Avahi: Error in group state changed %s",
435
raise AvahiGroupError("State changed: {!s}".format(error))
207
437
def cleanup(self):
208
438
"""Derived from the Avahi example code"""
209
439
if self.group is not None:
442
except (dbus.exceptions.UnknownMethodException,
443
dbus.exceptions.DBusException):
211
445
self.group = None
212
def server_state_changed(self, state):
448
def server_state_changed(self, state, error=None):
213
449
"""Derived from the Avahi example code"""
214
if state == avahi.SERVER_COLLISION:
215
logger.error(u"Zeroconf server name collision")
450
logger.debug("Avahi server state change: %i", state)
452
avahi.SERVER_INVALID: "Zeroconf server invalid",
453
avahi.SERVER_REGISTERING: None,
454
avahi.SERVER_COLLISION: "Zeroconf server name collision",
455
avahi.SERVER_FAILURE: "Zeroconf server failure",
457
if state in bad_states:
458
if bad_states[state] is not None:
460
logger.error(bad_states[state])
462
logger.error(bad_states[state] + ": %r", error)
217
464
elif state == avahi.SERVER_RUNNING:
467
except dbus.exceptions.DBusException as error:
468
if (error.get_dbus_name()
469
== "org.freedesktop.Avahi.CollisionError"):
470
logger.info("Local Zeroconf service name"
472
return self.rename(remove=False)
474
logger.critical("D-Bus Exception", exc_info=error)
479
logger.debug("Unknown state: %r", state)
481
logger.debug("Unknown state: %r: %r", state, error)
219
483
def activate(self):
220
484
"""Derived from the Avahi example code"""
221
485
if self.server is None:
222
486
self.server = dbus.Interface(
223
487
self.bus.get_object(avahi.DBUS_NAME,
224
avahi.DBUS_PATH_SERVER),
488
avahi.DBUS_PATH_SERVER,
489
follow_name_owner_changes=True),
225
490
avahi.DBUS_INTERFACE_SERVER)
226
self.server.connect_to_signal(u"StateChanged",
227
self.server_state_changed)
491
self.server.connect_to_signal("StateChanged",
492
self.server_state_changed)
228
493
self.server_state_changed(self.server.GetState())
496
class AvahiServiceToSyslog(AvahiService):
497
def rename(self, *args, **kwargs):
498
"""Add the new name to the syslog messages"""
499
ret = super(AvahiServiceToSyslog, self).rename(self, *args,
501
syslogger.setFormatter(logging.Formatter(
502
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
507
# Pretend that we have a GnuTLS module
508
class GnuTLS(object):
509
"""This isn't so much a class as it is a module-like namespace.
510
It is instantiated once, and simulates having a GnuTLS module."""
512
library = ctypes.util.find_library("gnutls")
514
library = ctypes.util.find_library("gnutls-deb0")
515
_library = ctypes.cdll.LoadLibrary(library)
517
_need_version = b"3.3.0"
520
# Need to use "self" here, since this method is called before
521
# the assignment to the "gnutls" global variable happens.
522
if self.check_version(self._need_version) is None:
523
raise self.Error("Needs GnuTLS {} or later"
524
.format(self._need_version))
526
# Unless otherwise indicated, the constants and types below are
527
# all from the gnutls/gnutls.h C header file.
537
E_NO_CERTIFICATE_FOUND = -49
538
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
541
class session_int(ctypes.Structure):
543
session_t = ctypes.POINTER(session_int)
545
class certificate_credentials_st(ctypes.Structure):
547
certificate_credentials_t = ctypes.POINTER(
548
certificate_credentials_st)
549
certificate_type_t = ctypes.c_int
551
class datum_t(ctypes.Structure):
552
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
553
('size', ctypes.c_uint)]
555
class openpgp_crt_int(ctypes.Structure):
557
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
558
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
559
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
560
credentials_type_t = ctypes.c_int
561
transport_ptr_t = ctypes.c_void_p
562
close_request_t = ctypes.c_int
565
class Error(Exception):
566
# We need to use the class name "GnuTLS" here, since this
567
# exception might be raised from within GnuTLS.__init__,
568
# which is called before the assignment to the "gnutls"
569
# global variable has happened.
570
def __init__(self, message=None, code=None, args=()):
571
# Default usage is by a message string, but if a return
572
# code is passed, convert it to a string with
575
if message is None and code is not None:
576
message = GnuTLS.strerror(code)
577
return super(GnuTLS.Error, self).__init__(
580
class CertificateSecurityError(Error):
584
class Credentials(object):
586
self._c_object = gnutls.certificate_credentials_t()
587
gnutls.certificate_allocate_credentials(
588
ctypes.byref(self._c_object))
589
self.type = gnutls.CRD_CERTIFICATE
592
gnutls.certificate_free_credentials(self._c_object)
594
class ClientSession(object):
595
def __init__(self, socket, credentials=None):
596
self._c_object = gnutls.session_t()
597
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
598
gnutls.set_default_priority(self._c_object)
599
gnutls.transport_set_ptr(self._c_object, socket.fileno())
600
gnutls.handshake_set_private_extensions(self._c_object,
603
if credentials is None:
604
credentials = gnutls.Credentials()
605
gnutls.credentials_set(self._c_object, credentials.type,
606
ctypes.cast(credentials._c_object,
608
self.credentials = credentials
611
gnutls.deinit(self._c_object)
614
return gnutls.handshake(self._c_object)
616
def send(self, data):
620
data_len -= gnutls.record_send(self._c_object,
625
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
627
# Error handling functions
628
def _error_code(result):
629
"""A function to raise exceptions on errors, suitable
630
for the 'restype' attribute on ctypes functions"""
633
if result == gnutls.E_NO_CERTIFICATE_FOUND:
634
raise gnutls.CertificateSecurityError(code=result)
635
raise gnutls.Error(code=result)
637
def _retry_on_error(result, func, arguments):
638
"""A function to retry on some errors, suitable
639
for the 'errcheck' attribute on ctypes functions"""
641
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
642
return _error_code(result)
643
result = func(*arguments)
646
# Unless otherwise indicated, the function declarations below are
647
# all from the gnutls/gnutls.h C header file.
650
priority_set_direct = _library.gnutls_priority_set_direct
651
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
652
ctypes.POINTER(ctypes.c_char_p)]
653
priority_set_direct.restype = _error_code
655
init = _library.gnutls_init
656
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
657
init.restype = _error_code
659
set_default_priority = _library.gnutls_set_default_priority
660
set_default_priority.argtypes = [session_t]
661
set_default_priority.restype = _error_code
663
record_send = _library.gnutls_record_send
664
record_send.argtypes = [session_t, ctypes.c_void_p,
666
record_send.restype = ctypes.c_ssize_t
667
record_send.errcheck = _retry_on_error
669
certificate_allocate_credentials = (
670
_library.gnutls_certificate_allocate_credentials)
671
certificate_allocate_credentials.argtypes = [
672
ctypes.POINTER(certificate_credentials_t)]
673
certificate_allocate_credentials.restype = _error_code
675
certificate_free_credentials = (
676
_library.gnutls_certificate_free_credentials)
677
certificate_free_credentials.argtypes = [
678
certificate_credentials_t]
679
certificate_free_credentials.restype = None
681
handshake_set_private_extensions = (
682
_library.gnutls_handshake_set_private_extensions)
683
handshake_set_private_extensions.argtypes = [session_t,
685
handshake_set_private_extensions.restype = None
687
credentials_set = _library.gnutls_credentials_set
688
credentials_set.argtypes = [session_t, credentials_type_t,
690
credentials_set.restype = _error_code
692
strerror = _library.gnutls_strerror
693
strerror.argtypes = [ctypes.c_int]
694
strerror.restype = ctypes.c_char_p
696
certificate_type_get = _library.gnutls_certificate_type_get
697
certificate_type_get.argtypes = [session_t]
698
certificate_type_get.restype = _error_code
700
certificate_get_peers = _library.gnutls_certificate_get_peers
701
certificate_get_peers.argtypes = [session_t,
702
ctypes.POINTER(ctypes.c_uint)]
703
certificate_get_peers.restype = ctypes.POINTER(datum_t)
705
global_set_log_level = _library.gnutls_global_set_log_level
706
global_set_log_level.argtypes = [ctypes.c_int]
707
global_set_log_level.restype = None
709
global_set_log_function = _library.gnutls_global_set_log_function
710
global_set_log_function.argtypes = [log_func]
711
global_set_log_function.restype = None
713
deinit = _library.gnutls_deinit
714
deinit.argtypes = [session_t]
715
deinit.restype = None
717
handshake = _library.gnutls_handshake
718
handshake.argtypes = [session_t]
719
handshake.restype = _error_code
720
handshake.errcheck = _retry_on_error
722
transport_set_ptr = _library.gnutls_transport_set_ptr
723
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
724
transport_set_ptr.restype = None
726
bye = _library.gnutls_bye
727
bye.argtypes = [session_t, close_request_t]
728
bye.restype = _error_code
729
bye.errcheck = _retry_on_error
731
check_version = _library.gnutls_check_version
732
check_version.argtypes = [ctypes.c_char_p]
733
check_version.restype = ctypes.c_char_p
735
# All the function declarations below are from gnutls/openpgp.h
737
openpgp_crt_init = _library.gnutls_openpgp_crt_init
738
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
739
openpgp_crt_init.restype = _error_code
741
openpgp_crt_import = _library.gnutls_openpgp_crt_import
742
openpgp_crt_import.argtypes = [openpgp_crt_t,
743
ctypes.POINTER(datum_t),
745
openpgp_crt_import.restype = _error_code
747
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
748
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
749
ctypes.POINTER(ctypes.c_uint)]
750
openpgp_crt_verify_self.restype = _error_code
752
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
753
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
754
openpgp_crt_deinit.restype = None
756
openpgp_crt_get_fingerprint = (
757
_library.gnutls_openpgp_crt_get_fingerprint)
758
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
762
openpgp_crt_get_fingerprint.restype = _error_code
764
# Remove non-public functions
765
del _error_code, _retry_on_error
766
# Create the global "gnutls" object, simulating a module
770
def call_pipe(connection, # : multiprocessing.Connection
771
func, *args, **kwargs):
772
"""This function is meant to be called by multiprocessing.Process
774
This function runs func(*args, **kwargs), and writes the resulting
775
return value on the provided multiprocessing.Connection.
777
connection.send(func(*args, **kwargs))
231
781
class Client(object):
232
782
"""A representation of a client host served by this server.
235
name: string; from the config file, used in log messages and
785
approved: bool(); 'None' if not yet approved/disapproved
786
approval_delay: datetime.timedelta(); Time to wait for approval
787
approval_duration: datetime.timedelta(); Duration of one approval
788
checker: subprocess.Popen(); a running checker process used
789
to see if the client lives.
790
'None' if no process is running.
791
checker_callback_tag: a GLib event source tag, or None
792
checker_command: string; External command which is run to check
793
if client lives. %() expansions are done at
794
runtime with vars(self) as dict, so that for
795
instance %(name)s can be used in the command.
796
checker_initiator_tag: a GLib event source tag, or None
797
created: datetime.datetime(); (UTC) object creation
798
client_structure: Object describing what attributes a client has
799
and is used for storing the client at exit
800
current_checker_command: string; current running checker_command
801
disable_initiator_tag: a GLib event source tag, or None
237
803
fingerprint: string (40 or 32 hexadecimal digits); used to
238
804
uniquely identify the client
239
secret: bytestring; sent verbatim (over TLS) to client
240
805
host: string; available for use by the checker command
241
created: datetime.datetime(); (UTC) object creation
242
last_enabled: datetime.datetime(); (UTC)
806
interval: datetime.timedelta(); How often to start a new checker
807
last_approval_request: datetime.datetime(); (UTC) or None
244
808
last_checked_ok: datetime.datetime(); (UTC) or None
809
last_checker_status: integer between 0 and 255 reflecting exit
810
status of last checker. -1 reflects crashed
811
checker, -2 means no checker completed yet.
812
last_checker_signal: The signal which killed the last checker, if
813
last_checker_status is -1
814
last_enabled: datetime.datetime(); (UTC) or None
815
name: string; from the config file, used in log messages and
817
secret: bytestring; sent verbatim (over TLS) to client
245
818
timeout: datetime.timedelta(); How long from last_checked_ok
246
819
until this client is disabled
247
interval: datetime.timedelta(); How often to start a new checker
248
disable_hook: If set, called by disable() as disable_hook(self)
249
checker: subprocess.Popen(); a running checker process used
250
to see if the client lives.
251
'None' if no process is running.
252
checker_initiator_tag: a gobject event source tag, or None
253
disable_initiator_tag: - '' -
254
checker_callback_tag: - '' -
255
checker_command: string; External command which is run to check if
256
client lives. %() expansions are done at
257
runtime with vars(self) as dict, so that for
258
instance %(name)s can be used in the command.
259
current_checker_command: string; current running checker_command
260
changesignal: File descriptor; written to on object change
261
_reset: File descriptor; for flushing changesignal
262
delay: datetime.timedelta(); how long to wait for approval/secret
263
approved: bool(); None if not yet approved/disapproved
820
extended_timeout: extra long timeout when secret has been sent
821
runtime_expansions: Allowed attributes for runtime expansion.
822
expires: datetime.datetime(); time (UTC) when a client will be
824
server_settings: The server_settings dict from main()
827
runtime_expansions = ("approval_delay", "approval_duration",
828
"created", "enabled", "expires",
829
"fingerprint", "host", "interval",
830
"last_approval_request", "last_checked_ok",
831
"last_enabled", "name", "timeout")
834
"extended_timeout": "PT15M",
836
"checker": "fping -q -- %%(host)s",
838
"approval_delay": "PT0S",
839
"approval_duration": "PT1S",
840
"approved_by_default": "True",
267
def _timedelta_to_milliseconds(td):
268
"Convert a datetime.timedelta() to milliseconds"
269
return ((td.days * 24 * 60 * 60 * 1000)
270
+ (td.seconds * 1000)
271
+ (td.microseconds // 1000))
273
def timeout_milliseconds(self):
274
"Return the 'timeout' attribute in milliseconds"
275
return self._timedelta_to_milliseconds(self.timeout)
277
def interval_milliseconds(self):
278
"Return the 'interval' attribute in milliseconds"
279
return self._timedelta_to_milliseconds(self.interval)
281
def __init__(self, name = None, disable_hook=None, config=None):
282
"""Note: the 'checker' key in 'config' sets the
283
'checker_command' attribute and *not* the 'checker'
845
def config_parser(config):
846
"""Construct a new dict of client settings of this form:
847
{ client_name: {setting_name: value, ...}, ...}
848
with exceptions for any special settings as defined above.
849
NOTE: Must be a pure function. Must return the same result
850
value given the same arguments.
853
for client_name in config.sections():
854
section = dict(config.items(client_name))
855
client = settings[client_name] = {}
857
client["host"] = section["host"]
858
# Reformat values from string types to Python types
859
client["approved_by_default"] = config.getboolean(
860
client_name, "approved_by_default")
861
client["enabled"] = config.getboolean(client_name,
864
# Uppercase and remove spaces from fingerprint for later
865
# comparison purposes with return value from the
866
# fingerprint() function
867
client["fingerprint"] = (section["fingerprint"].upper()
869
if "secret" in section:
870
client["secret"] = codecs.decode(section["secret"]
873
elif "secfile" in section:
874
with open(os.path.expanduser(os.path.expandvars
875
(section["secfile"])),
877
client["secret"] = secfile.read()
879
raise TypeError("No secret or secfile for section {}"
881
client["timeout"] = string_to_delta(section["timeout"])
882
client["extended_timeout"] = string_to_delta(
883
section["extended_timeout"])
884
client["interval"] = string_to_delta(section["interval"])
885
client["approval_delay"] = string_to_delta(
886
section["approval_delay"])
887
client["approval_duration"] = string_to_delta(
888
section["approval_duration"])
889
client["checker_command"] = section["checker"]
890
client["last_approval_request"] = None
891
client["last_checked_ok"] = None
892
client["last_checker_status"] = -2
896
def __init__(self, settings, name=None, server_settings=None):
288
logger.debug(u"Creating client %r", self.name)
289
# Uppercase and remove spaces from fingerprint for later
290
# comparison purposes with return value from the fingerprint()
292
self.fingerprint = (config[u"fingerprint"].upper()
294
logger.debug(u" Fingerprint: %s", self.fingerprint)
295
if u"secret" in config:
296
self._secret = config[u"secret"].decode(u"base64")
297
elif u"secfile" in config:
298
with open(os.path.expanduser(os.path.expandvars
299
(config[u"secfile"])),
301
self._secret = secfile.read()
898
if server_settings is None:
900
self.server_settings = server_settings
901
# adding all client settings
902
for setting, value in settings.items():
903
setattr(self, setting, value)
906
if not hasattr(self, "last_enabled"):
907
self.last_enabled = datetime.datetime.utcnow()
908
if not hasattr(self, "expires"):
909
self.expires = (datetime.datetime.utcnow()
303
#XXX Need to allow secret on demand!
304
raise TypeError(u"No secret or secfile for client %s"
306
self.host = config.get(u"host", u"")
307
self.created = datetime.datetime.utcnow()
309
self.last_enabled = None
310
self.last_checked_ok = None
311
self.timeout = string_to_delta(config[u"timeout"])
312
self.interval = string_to_delta(config[u"interval"])
313
self.disable_hook = disable_hook
912
self.last_enabled = None
915
logger.debug("Creating client %r", self.name)
916
logger.debug(" Fingerprint: %s", self.fingerprint)
917
self.created = settings.get("created",
918
datetime.datetime.utcnow())
920
# attributes specific for this server instance
314
921
self.checker = None
315
922
self.checker_initiator_tag = None
316
923
self.disable_initiator_tag = None
317
924
self.checker_callback_tag = None
318
self.checker_command = config[u"checker"]
319
925
self.current_checker_command = None
320
self.last_connect = None
321
self.changesignal, self._reset = os.pipe()
322
self._approved = None #XXX should be based on configfile
323
self.delay = 10; #XXX Should be based on configfile
325
def setsecret(self, value):
327
os.write(self.changesignal, "\0")
328
os.read(self._reset, 1)
330
secret = property(lambda self: self._secret, setsecret)
333
def setapproved(self, value):
334
self._approved = value
335
os.write(self.changesignal, "\0")
336
os.read(self._reset, 1)
338
approved = property(lambda self: self._approved, setapproved)
927
self.approvals_pending = 0
928
self.changedstate = multiprocessing_manager.Condition(
929
multiprocessing_manager.Lock())
930
self.client_structure = [attr
931
for attr in self.__dict__.keys()
932
if not attr.startswith("_")]
933
self.client_structure.append("client_structure")
935
for name, t in inspect.getmembers(
936
type(self), lambda obj: isinstance(obj, property)):
937
if not name.startswith("_"):
938
self.client_structure.append(name)
940
# Send notice to process children that client state has changed
941
def send_changedstate(self):
942
with self.changedstate:
943
self.changedstate.notify_all()
341
945
def enable(self):
342
946
"""Start this client's checker and timeout hooks"""
343
if getattr(self, u"enabled", False):
947
if getattr(self, "enabled", False):
344
948
# Already enabled
950
self.expires = datetime.datetime.utcnow() + self.timeout
346
952
self.last_enabled = datetime.datetime.utcnow()
954
self.send_changedstate()
956
def disable(self, quiet=True):
957
"""Disable this client."""
958
if not getattr(self, "enabled", False):
961
logger.info("Disabling client %s", self.name)
962
if getattr(self, "disable_initiator_tag", None) is not None:
963
GLib.source_remove(self.disable_initiator_tag)
964
self.disable_initiator_tag = None
966
if getattr(self, "checker_initiator_tag", None) is not None:
967
GLib.source_remove(self.checker_initiator_tag)
968
self.checker_initiator_tag = None
972
self.send_changedstate()
973
# Do not run this again if called by a GLib.timeout_add
979
def init_checker(self):
347
980
# Schedule a new checker to be started an 'interval' from now,
348
981
# and every interval from then on.
349
self.checker_initiator_tag = (gobject.timeout_add
350
(self.interval_milliseconds(),
982
if self.checker_initiator_tag is not None:
983
GLib.source_remove(self.checker_initiator_tag)
984
self.checker_initiator_tag = GLib.timeout_add(
985
int(self.interval.total_seconds() * 1000),
352
987
# Schedule a disable() when 'timeout' has passed
353
self.disable_initiator_tag = (gobject.timeout_add
354
(self.timeout_milliseconds(),
988
if self.disable_initiator_tag is not None:
989
GLib.source_remove(self.disable_initiator_tag)
990
self.disable_initiator_tag = GLib.timeout_add(
991
int(self.timeout.total_seconds() * 1000), self.disable)
357
992
# Also start a new checker *right now*.
358
993
self.start_checker()
360
def disable(self, quiet=True):
361
"""Disable this client."""
362
if not getattr(self, "enabled", False):
365
logger.info(u"Disabling client %s", self.name)
366
if getattr(self, u"disable_initiator_tag", False):
367
gobject.source_remove(self.disable_initiator_tag)
368
self.disable_initiator_tag = None
369
if getattr(self, u"checker_initiator_tag", False):
370
gobject.source_remove(self.checker_initiator_tag)
371
self.checker_initiator_tag = None
373
if self.disable_hook:
374
self.disable_hook(self)
376
# Do not run this again if called by a gobject.timeout_add
380
self.disable_hook = None
383
def checker_callback(self, pid, condition, command):
995
def checker_callback(self, source, condition, connection,
384
997
"""The checker has completed, so take appropriate actions."""
385
998
self.checker_callback_tag = None
386
999
self.checker = None
387
if os.WIFEXITED(condition):
388
exitstatus = os.WEXITSTATUS(condition)
390
logger.info(u"Checker for %(name)s succeeded",
1000
# Read return code from connection (see call_pipe)
1001
returncode = connection.recv()
1005
self.last_checker_status = returncode
1006
self.last_checker_signal = None
1007
if self.last_checker_status == 0:
1008
logger.info("Checker for %(name)s succeeded",
392
1010
self.checked_ok()
394
logger.info(u"Checker for %(name)s failed",
1012
logger.info("Checker for %(name)s failed", vars(self))
397
logger.warning(u"Checker for %(name)s crashed?",
1014
self.last_checker_status = -1
1015
self.last_checker_signal = -returncode
1016
logger.warning("Checker for %(name)s crashed?",
400
1020
def checked_ok(self):
401
"""Bump up the timeout for this client.
403
This should only be called when the client has been seen,
1021
"""Assert that the client has been seen, alive and well."""
406
1022
self.last_checked_ok = datetime.datetime.utcnow()
407
gobject.source_remove(self.disable_initiator_tag)
408
self.disable_initiator_tag = (gobject.timeout_add
409
(self.timeout_milliseconds(),
1023
self.last_checker_status = 0
1024
self.last_checker_signal = None
1027
def bump_timeout(self, timeout=None):
1028
"""Bump up the timeout for this client."""
1030
timeout = self.timeout
1031
if self.disable_initiator_tag is not None:
1032
GLib.source_remove(self.disable_initiator_tag)
1033
self.disable_initiator_tag = None
1034
if getattr(self, "enabled", False):
1035
self.disable_initiator_tag = GLib.timeout_add(
1036
int(timeout.total_seconds() * 1000), self.disable)
1037
self.expires = datetime.datetime.utcnow() + timeout
1039
def need_approval(self):
1040
self.last_approval_request = datetime.datetime.utcnow()
412
1042
def start_checker(self):
413
1043
"""Start a new checker subprocess if one is not running.
415
1045
If a checker already exists, leave it running and do
417
1047
# The reason for not killing a running checker is that if we
418
# did that, then if a checker (for some reason) started
419
# running slowly and taking more than 'interval' time, the
420
# client would inevitably timeout, since no checker would get
421
# a chance to run to completion. If we instead leave running
1048
# did that, and if a checker (for some reason) started running
1049
# slowly and taking more than 'interval' time, then the client
1050
# would inevitably timeout, since no checker would get a
1051
# chance to run to completion. If we instead leave running
422
1052
# checkers alone, the checker would have to take more time
423
1053
# than 'timeout' for the client to be disabled, which is as it
426
# If a checker exists, make sure it is not a zombie
428
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
429
except (AttributeError, OSError), error:
430
if (isinstance(error, OSError)
431
and error.errno != errno.ECHILD):
435
logger.warning(u"Checker was a zombie")
436
gobject.source_remove(self.checker_callback_tag)
437
self.checker_callback(pid, status,
438
self.current_checker_command)
1056
if self.checker is not None and not self.checker.is_alive():
1057
logger.warning("Checker was not alive; joining")
439
1060
# Start a new checker if needed
440
1061
if self.checker is None:
1062
# Escape attributes for the shell
1064
attr: re.escape(str(getattr(self, attr)))
1065
for attr in self.runtime_expansions}
442
# In case checker_command has exactly one % operator
443
command = self.checker_command % self.host
445
# Escape attributes for the shell
446
escaped_attrs = dict((key,
447
re.escape(unicode(str(val),
451
vars(self).iteritems())
453
command = self.checker_command % escaped_attrs
454
except TypeError, error:
455
logger.error(u'Could not format string "%s":'
456
u' %s', self.checker_command, error)
457
return True # Try again later
1067
command = self.checker_command % escaped_attrs
1068
except TypeError as error:
1069
logger.error('Could not format string "%s"',
1070
self.checker_command,
1072
return True # Try again later
458
1073
self.current_checker_command = command
460
logger.info(u"Starting checker %r for %s",
462
# We don't need to redirect stdout and stderr, since
463
# in normal mode, that is already done by daemon(),
464
# and in debug mode we don't want to. (Stdin is
465
# always replaced by /dev/null.)
466
self.checker = subprocess.Popen(command,
468
shell=True, cwd=u"/")
469
self.checker_callback_tag = (gobject.child_watch_add
471
self.checker_callback,
473
# The checker may have completed before the gobject
474
# watch was added. Check for this.
475
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
477
gobject.source_remove(self.checker_callback_tag)
478
self.checker_callback(pid, status, command)
479
except OSError, error:
480
logger.error(u"Failed to start subprocess: %s",
482
# Re-run this periodically if run by gobject.timeout_add
1074
logger.info("Starting checker %r for %s", command,
1076
# We don't need to redirect stdout and stderr, since
1077
# in normal mode, that is already done by daemon(),
1078
# and in debug mode we don't want to. (Stdin is
1079
# always replaced by /dev/null.)
1080
# The exception is when not debugging but nevertheless
1081
# running in the foreground; use the previously
1083
popen_args = {"close_fds": True,
1086
if (not self.server_settings["debug"]
1087
and self.server_settings["foreground"]):
1088
popen_args.update({"stdout": wnull,
1090
pipe = multiprocessing.Pipe(duplex=False)
1091
self.checker = multiprocessing.Process(
1093
args=(pipe[1], subprocess.call, command),
1095
self.checker.start()
1096
self.checker_callback_tag = GLib.io_add_watch(
1097
pipe[0].fileno(), GLib.IO_IN,
1098
self.checker_callback, pipe[0], command)
1099
# Re-run this periodically if run by GLib.timeout_add
485
1102
def stop_checker(self):
486
1103
"""Force the checker process, if any, to stop."""
487
1104
if self.checker_callback_tag:
488
gobject.source_remove(self.checker_callback_tag)
1105
GLib.source_remove(self.checker_callback_tag)
489
1106
self.checker_callback_tag = None
490
if getattr(self, u"checker", None) is None:
1107
if getattr(self, "checker", None) is None:
492
logger.debug(u"Stopping checker for %(name)s", vars(self))
494
os.kill(self.checker.pid, signal.SIGTERM)
496
#if self.checker.poll() is None:
497
# os.kill(self.checker.pid, signal.SIGKILL)
498
except OSError, error:
499
if error.errno != errno.ESRCH: # No such process
1109
logger.debug("Stopping checker for %(name)s", vars(self))
1110
self.checker.terminate()
501
1111
self.checker = None
504
def dbus_service_property(dbus_interface, signature=u"v",
505
access=u"readwrite", byte_arrays=False):
1114
def dbus_service_property(dbus_interface,
506
1118
"""Decorators for marking methods of a DBusObjectWithProperties to
507
1119
become properties on the D-Bus.
509
1121
The decorated method will be called with no arguments by "Get"
510
1122
and with one argument by "Set".
512
1124
The parameters, where they are supported, are the same as
513
1125
dbus.service.method, except there is only "signature", since the
514
1126
type from Get() and the type sent to Set() is the same.
516
1128
# Encoding deeply encoded byte arrays is not supported yet by the
517
1129
# "Set" method, so we fail early here:
518
if byte_arrays and signature != u"ay":
519
raise ValueError(u"Byte arrays not supported for non-'ay'"
520
u" signature %r" % signature)
1130
if byte_arrays and signature != "ay":
1131
raise ValueError("Byte arrays not supported for non-'ay'"
1132
" signature {!r}".format(signature))
521
1134
def decorator(func):
522
1135
func._dbus_is_property = True
523
1136
func._dbus_interface = dbus_interface
524
1137
func._dbus_signature = signature
525
1138
func._dbus_access = access
526
1139
func._dbus_name = func.__name__
527
if func._dbus_name.endswith(u"_dbus_property"):
1140
if func._dbus_name.endswith("_dbus_property"):
528
1141
func._dbus_name = func._dbus_name[:-14]
529
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1142
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1148
def dbus_interface_annotations(dbus_interface):
1149
"""Decorator for marking functions returning interface annotations
1153
@dbus_interface_annotations("org.example.Interface")
1154
def _foo(self): # Function name does not matter
1155
return {"org.freedesktop.DBus.Deprecated": "true",
1156
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1160
def decorator(func):
1161
func._dbus_is_interface = True
1162
func._dbus_interface = dbus_interface
1163
func._dbus_name = dbus_interface
1169
def dbus_annotations(annotations):
1170
"""Decorator to annotate D-Bus methods, signals or properties
1173
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1174
"org.freedesktop.DBus.Property."
1175
"EmitsChangedSignal": "false"})
1176
@dbus_service_property("org.example.Interface", signature="b",
1178
def Property_dbus_property(self):
1179
return dbus.Boolean(False)
1181
See also the DBusObjectWithAnnotations class.
1184
def decorator(func):
1185
func._dbus_annotations = annotations
531
1188
return decorator
534
1191
class DBusPropertyException(dbus.exceptions.DBusException):
535
1192
"""A base class for D-Bus property-related exceptions
537
def __unicode__(self):
538
return unicode(str(self))
541
1197
class DBusPropertyAccessException(DBusPropertyException):
553
class DBusObjectWithProperties(dbus.service.Object):
1209
class DBusObjectWithAnnotations(dbus.service.Object):
1210
"""A D-Bus object with annotations.
1212
Classes inheriting from this can use the dbus_annotations
1213
decorator to add annotations to methods or signals.
1217
def _is_dbus_thing(thing):
1218
"""Returns a function testing if an attribute is a D-Bus thing
1220
If called like _is_dbus_thing("method") it returns a function
1221
suitable for use as predicate to inspect.getmembers().
1223
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1226
def _get_all_dbus_things(self, thing):
1227
"""Returns a generator of (name, attribute) pairs
1229
return ((getattr(athing.__get__(self), "_dbus_name", name),
1230
athing.__get__(self))
1231
for cls in self.__class__.__mro__
1233
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1235
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1237
path_keyword='object_path',
1238
connection_keyword='connection')
1239
def Introspect(self, object_path, connection):
1240
"""Overloading of standard D-Bus method.
1242
Inserts annotation tags on methods and signals.
1244
xmlstring = dbus.service.Object.Introspect(self, object_path,
1247
document = xml.dom.minidom.parseString(xmlstring)
1249
for if_tag in document.getElementsByTagName("interface"):
1250
# Add annotation tags
1251
for typ in ("method", "signal"):
1252
for tag in if_tag.getElementsByTagName(typ):
1254
for name, prop in (self.
1255
_get_all_dbus_things(typ)):
1256
if (name == tag.getAttribute("name")
1257
and prop._dbus_interface
1258
== if_tag.getAttribute("name")):
1259
annots.update(getattr(
1260
prop, "_dbus_annotations", {}))
1261
for name, value in annots.items():
1262
ann_tag = document.createElement(
1264
ann_tag.setAttribute("name", name)
1265
ann_tag.setAttribute("value", value)
1266
tag.appendChild(ann_tag)
1267
# Add interface annotation tags
1268
for annotation, value in dict(
1269
itertools.chain.from_iterable(
1270
annotations().items()
1271
for name, annotations
1272
in self._get_all_dbus_things("interface")
1273
if name == if_tag.getAttribute("name")
1275
ann_tag = document.createElement("annotation")
1276
ann_tag.setAttribute("name", annotation)
1277
ann_tag.setAttribute("value", value)
1278
if_tag.appendChild(ann_tag)
1279
# Fix argument name for the Introspect method itself
1280
if (if_tag.getAttribute("name")
1281
== dbus.INTROSPECTABLE_IFACE):
1282
for cn in if_tag.getElementsByTagName("method"):
1283
if cn.getAttribute("name") == "Introspect":
1284
for arg in cn.getElementsByTagName("arg"):
1285
if (arg.getAttribute("direction")
1287
arg.setAttribute("name",
1289
xmlstring = document.toxml("utf-8")
1291
except (AttributeError, xml.dom.DOMException,
1292
xml.parsers.expat.ExpatError) as error:
1293
logger.error("Failed to override Introspection method",
1298
class DBusObjectWithProperties(DBusObjectWithAnnotations):
554
1299
"""A D-Bus object with properties.
556
1301
Classes inheriting from this can use the dbus_service_property
557
1302
decorator to expose methods as D-Bus properties. It exposes the
558
1303
standard Get(), Set(), and GetAll() methods on the D-Bus.
562
def _is_dbus_property(obj):
563
return getattr(obj, u"_dbus_is_property", False)
565
def _get_all_dbus_properties(self):
566
"""Returns a generator of (name, attribute) pairs
568
return ((prop._dbus_name, prop)
570
inspect.getmembers(self, self._is_dbus_property))
572
1306
def _get_dbus_property(self, interface_name, property_name):
573
1307
"""Returns a bound method if one exists which is a D-Bus
574
1308
property with the specified name and interface.
576
for name in (property_name,
577
property_name + u"_dbus_property"):
578
prop = getattr(self, name, None)
580
or not self._is_dbus_property(prop)
581
or prop._dbus_name != property_name
582
or (interface_name and prop._dbus_interface
583
and interface_name != prop._dbus_interface)):
1310
for cls in self.__class__.__mro__:
1311
for name, value in inspect.getmembers(
1312
cls, self._is_dbus_thing("property")):
1313
if (value._dbus_name == property_name
1314
and value._dbus_interface == interface_name):
1315
return value.__get__(self)
586
1317
# No such property
587
raise DBusPropertyNotFound(self.dbus_object_path + u":"
588
+ interface_name + u"."
591
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1318
raise DBusPropertyNotFound("{}:{}.{}".format(
1319
self.dbus_object_path, interface_name, property_name))
1322
def _get_all_interface_names(cls):
1323
"""Get a sequence of all interfaces supported by an object"""
1324
return (name for name in set(getattr(getattr(x, attr),
1325
"_dbus_interface", None)
1326
for x in (inspect.getmro(cls))
1328
if name is not None)
1330
@dbus.service.method(dbus.PROPERTIES_IFACE,
593
1333
def Get(self, interface_name, property_name):
594
1334
"""Standard D-Bus property Get() method, see D-Bus standard.
596
1336
prop = self._get_dbus_property(interface_name, property_name)
597
if prop._dbus_access == u"write":
1337
if prop._dbus_access == "write":
598
1338
raise DBusPropertyAccessException(property_name)
600
if not hasattr(value, u"variant_level"):
1340
if not hasattr(value, "variant_level"):
602
1342
return type(value)(value, variant_level=value.variant_level+1)
604
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1344
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
605
1345
def Set(self, interface_name, property_name, value):
606
1346
"""Standard D-Bus property Set() method, see D-Bus standard.
608
1348
prop = self._get_dbus_property(interface_name, property_name)
609
if prop._dbus_access == u"read":
1349
if prop._dbus_access == "read":
610
1350
raise DBusPropertyAccessException(property_name)
611
if prop._dbus_get_args_options[u"byte_arrays"]:
1351
if prop._dbus_get_args_options["byte_arrays"]:
612
1352
# The byte_arrays option is not supported yet on
613
1353
# signatures other than "ay".
614
if prop._dbus_signature != u"ay":
616
value = dbus.ByteArray(''.join(unichr(byte)
1354
if prop._dbus_signature != "ay":
1355
raise ValueError("Byte arrays not supported for non-"
1356
"'ay' signature {!r}"
1357
.format(prop._dbus_signature))
1358
value = dbus.ByteArray(b''.join(chr(byte)
620
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
621
out_signature=u"a{sv}")
1362
@dbus.service.method(dbus.PROPERTIES_IFACE,
1364
out_signature="a{sv}")
622
1365
def GetAll(self, interface_name):
623
1366
"""Standard D-Bus property GetAll() method, see D-Bus
626
1369
Note: Will not include properties with access="write".
629
for name, prop in self._get_all_dbus_properties():
1372
for name, prop in self._get_all_dbus_things("property"):
630
1373
if (interface_name
631
1374
and interface_name != prop._dbus_interface):
632
1375
# Interface non-empty but did not match
634
1377
# Ignore write-only properties
635
if prop._dbus_access == u"write":
1378
if prop._dbus_access == "write":
638
if not hasattr(value, u"variant_level"):
1381
if not hasattr(value, "variant_level"):
1382
properties[name] = value
641
all[name] = type(value)(value, variant_level=
642
value.variant_level+1)
643
return dbus.Dictionary(all, signature=u"sv")
1384
properties[name] = type(value)(
1385
value, variant_level=value.variant_level + 1)
1386
return dbus.Dictionary(properties, signature="sv")
1388
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1389
def PropertiesChanged(self, interface_name, changed_properties,
1390
invalidated_properties):
1391
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
645
1396
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
647
1398
path_keyword='object_path',
648
1399
connection_keyword='connection')
649
1400
def Introspect(self, object_path, connection):
650
"""Standard D-Bus method, overloaded to insert property tags.
1401
"""Overloading of standard D-Bus method.
1403
Inserts property tags and interface annotation tags.
652
xmlstring = dbus.service.Object.Introspect(self, object_path,
1405
xmlstring = DBusObjectWithAnnotations.Introspect(self,
655
1409
document = xml.dom.minidom.parseString(xmlstring)
656
1411
def make_tag(document, name, prop):
657
e = document.createElement(u"property")
658
e.setAttribute(u"name", name)
659
e.setAttribute(u"type", prop._dbus_signature)
660
e.setAttribute(u"access", prop._dbus_access)
1412
e = document.createElement("property")
1413
e.setAttribute("name", name)
1414
e.setAttribute("type", prop._dbus_signature)
1415
e.setAttribute("access", prop._dbus_access)
662
for if_tag in document.getElementsByTagName(u"interface"):
1418
for if_tag in document.getElementsByTagName("interface"):
663
1420
for tag in (make_tag(document, name, prop)
665
in self._get_all_dbus_properties()
1422
in self._get_all_dbus_things("property")
666
1423
if prop._dbus_interface
667
== if_tag.getAttribute(u"name")):
1424
== if_tag.getAttribute("name")):
668
1425
if_tag.appendChild(tag)
1426
# Add annotation tags for properties
1427
for tag in if_tag.getElementsByTagName("property"):
1429
for name, prop in self._get_all_dbus_things(
1431
if (name == tag.getAttribute("name")
1432
and prop._dbus_interface
1433
== if_tag.getAttribute("name")):
1434
annots.update(getattr(
1435
prop, "_dbus_annotations", {}))
1436
for name, value in annots.items():
1437
ann_tag = document.createElement(
1439
ann_tag.setAttribute("name", name)
1440
ann_tag.setAttribute("value", value)
1441
tag.appendChild(ann_tag)
669
1442
# Add the names to the return values for the
670
1443
# "org.freedesktop.DBus.Properties" methods
671
if (if_tag.getAttribute(u"name")
672
== u"org.freedesktop.DBus.Properties"):
673
for cn in if_tag.getElementsByTagName(u"method"):
674
if cn.getAttribute(u"name") == u"Get":
675
for arg in cn.getElementsByTagName(u"arg"):
676
if (arg.getAttribute(u"direction")
678
arg.setAttribute(u"name", u"value")
679
elif cn.getAttribute(u"name") == u"GetAll":
680
for arg in cn.getElementsByTagName(u"arg"):
681
if (arg.getAttribute(u"direction")
683
arg.setAttribute(u"name", u"props")
684
xmlstring = document.toxml(u"utf-8")
686
except (AttributeError, xml.dom.DOMException,
687
xml.parsers.expat.ExpatError), error:
688
logger.error(u"Failed to override Introspection method",
1444
if (if_tag.getAttribute("name")
1445
== "org.freedesktop.DBus.Properties"):
1446
for cn in if_tag.getElementsByTagName("method"):
1447
if cn.getAttribute("name") == "Get":
1448
for arg in cn.getElementsByTagName("arg"):
1449
if (arg.getAttribute("direction")
1451
arg.setAttribute("name", "value")
1452
elif cn.getAttribute("name") == "GetAll":
1453
for arg in cn.getElementsByTagName("arg"):
1454
if (arg.getAttribute("direction")
1456
arg.setAttribute("name", "props")
1457
xmlstring = document.toxml("utf-8")
1459
except (AttributeError, xml.dom.DOMException,
1460
xml.parsers.expat.ExpatError) as error:
1461
logger.error("Failed to override Introspection method",
1467
dbus.OBJECT_MANAGER_IFACE
1468
except AttributeError:
1469
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1472
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1473
"""A D-Bus object with an ObjectManager.
1475
Classes inheriting from this exposes the standard
1476
GetManagedObjects call and the InterfacesAdded and
1477
InterfacesRemoved signals on the standard
1478
"org.freedesktop.DBus.ObjectManager" interface.
1480
Note: No signals are sent automatically; they must be sent
1483
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1484
out_signature="a{oa{sa{sv}}}")
1485
def GetManagedObjects(self):
1486
"""This function must be overridden"""
1487
raise NotImplementedError()
1489
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1490
signature="oa{sa{sv}}")
1491
def InterfacesAdded(self, object_path, interfaces_and_properties):
1494
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1495
def InterfacesRemoved(self, object_path, interfaces):
1498
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1500
path_keyword='object_path',
1501
connection_keyword='connection')
1502
def Introspect(self, object_path, connection):
1503
"""Overloading of standard D-Bus method.
1505
Override return argument name of GetManagedObjects to be
1506
"objpath_interfaces_and_properties"
1508
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1512
document = xml.dom.minidom.parseString(xmlstring)
1514
for if_tag in document.getElementsByTagName("interface"):
1515
# Fix argument name for the GetManagedObjects method
1516
if (if_tag.getAttribute("name")
1517
== dbus.OBJECT_MANAGER_IFACE):
1518
for cn in if_tag.getElementsByTagName("method"):
1519
if (cn.getAttribute("name")
1520
== "GetManagedObjects"):
1521
for arg in cn.getElementsByTagName("arg"):
1522
if (arg.getAttribute("direction")
1526
"objpath_interfaces"
1528
xmlstring = document.toxml("utf-8")
1530
except (AttributeError, xml.dom.DOMException,
1531
xml.parsers.expat.ExpatError) as error:
1532
logger.error("Failed to override Introspection method",
1537
def datetime_to_dbus(dt, variant_level=0):
1538
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1540
return dbus.String("", variant_level=variant_level)
1541
return dbus.String(dt.isoformat(), variant_level=variant_level)
1544
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1545
"""A class decorator; applied to a subclass of
1546
dbus.service.Object, it will add alternate D-Bus attributes with
1547
interface names according to the "alt_interface_names" mapping.
1550
@alternate_dbus_interfaces({"org.example.Interface":
1551
"net.example.AlternateInterface"})
1552
class SampleDBusObject(dbus.service.Object):
1553
@dbus.service.method("org.example.Interface")
1554
def SampleDBusMethod():
1557
The above "SampleDBusMethod" on "SampleDBusObject" will be
1558
reachable via two interfaces: "org.example.Interface" and
1559
"net.example.AlternateInterface", the latter of which will have
1560
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1561
"true", unless "deprecate" is passed with a False value.
1563
This works for methods and signals, and also for D-Bus properties
1564
(from DBusObjectWithProperties) and interfaces (from the
1565
dbus_interface_annotations decorator).
1569
for orig_interface_name, alt_interface_name in (
1570
alt_interface_names.items()):
1572
interface_names = set()
1573
# Go though all attributes of the class
1574
for attrname, attribute in inspect.getmembers(cls):
1575
# Ignore non-D-Bus attributes, and D-Bus attributes
1576
# with the wrong interface name
1577
if (not hasattr(attribute, "_dbus_interface")
1578
or not attribute._dbus_interface.startswith(
1579
orig_interface_name)):
1581
# Create an alternate D-Bus interface name based on
1583
alt_interface = attribute._dbus_interface.replace(
1584
orig_interface_name, alt_interface_name)
1585
interface_names.add(alt_interface)
1586
# Is this a D-Bus signal?
1587
if getattr(attribute, "_dbus_is_signal", False):
1588
# Extract the original non-method undecorated
1589
# function by black magic
1590
if sys.version_info.major == 2:
1591
nonmethod_func = (dict(
1592
zip(attribute.func_code.co_freevars,
1593
attribute.__closure__))
1594
["func"].cell_contents)
1596
nonmethod_func = (dict(
1597
zip(attribute.__code__.co_freevars,
1598
attribute.__closure__))
1599
["func"].cell_contents)
1600
# Create a new, but exactly alike, function
1601
# object, and decorate it to be a new D-Bus signal
1602
# with the alternate D-Bus interface name
1603
new_function = copy_function(nonmethod_func)
1604
new_function = (dbus.service.signal(
1606
attribute._dbus_signature)(new_function))
1607
# Copy annotations, if any
1609
new_function._dbus_annotations = dict(
1610
attribute._dbus_annotations)
1611
except AttributeError:
1614
# Define a creator of a function to call both the
1615
# original and alternate functions, so both the
1616
# original and alternate signals gets sent when
1617
# the function is called
1618
def fixscope(func1, func2):
1619
"""This function is a scope container to pass
1620
func1 and func2 to the "call_both" function
1621
outside of its arguments"""
1623
@functools.wraps(func2)
1624
def call_both(*args, **kwargs):
1625
"""This function will emit two D-Bus
1626
signals by calling func1 and func2"""
1627
func1(*args, **kwargs)
1628
func2(*args, **kwargs)
1629
# Make wrapper function look like a D-Bus
1631
for name, attr in inspect.getmembers(func2):
1632
if name.startswith("_dbus_"):
1633
setattr(call_both, name, attr)
1636
# Create the "call_both" function and add it to
1638
attr[attrname] = fixscope(attribute, new_function)
1639
# Is this a D-Bus method?
1640
elif getattr(attribute, "_dbus_is_method", False):
1641
# Create a new, but exactly alike, function
1642
# object. Decorate it to be a new D-Bus method
1643
# with the alternate D-Bus interface name. Add it
1646
dbus.service.method(
1648
attribute._dbus_in_signature,
1649
attribute._dbus_out_signature)
1650
(copy_function(attribute)))
1651
# Copy annotations, if any
1653
attr[attrname]._dbus_annotations = dict(
1654
attribute._dbus_annotations)
1655
except AttributeError:
1657
# Is this a D-Bus property?
1658
elif getattr(attribute, "_dbus_is_property", False):
1659
# Create a new, but exactly alike, function
1660
# object, and decorate it to be a new D-Bus
1661
# property with the alternate D-Bus interface
1662
# name. Add it to the class.
1663
attr[attrname] = (dbus_service_property(
1664
alt_interface, attribute._dbus_signature,
1665
attribute._dbus_access,
1666
attribute._dbus_get_args_options
1668
(copy_function(attribute)))
1669
# Copy annotations, if any
1671
attr[attrname]._dbus_annotations = dict(
1672
attribute._dbus_annotations)
1673
except AttributeError:
1675
# Is this a D-Bus interface?
1676
elif getattr(attribute, "_dbus_is_interface", False):
1677
# Create a new, but exactly alike, function
1678
# object. Decorate it to be a new D-Bus interface
1679
# with the alternate D-Bus interface name. Add it
1682
dbus_interface_annotations(alt_interface)
1683
(copy_function(attribute)))
1685
# Deprecate all alternate interfaces
1686
iname = "_AlternateDBusNames_interface_annotation{}"
1687
for interface_name in interface_names:
1689
@dbus_interface_annotations(interface_name)
1691
return {"org.freedesktop.DBus.Deprecated":
1693
# Find an unused name
1694
for aname in (iname.format(i)
1695
for i in itertools.count()):
1696
if aname not in attr:
1700
# Replace the class with a new subclass of it with
1701
# methods, signals, etc. as created above.
1702
if sys.version_info.major == 2:
1703
cls = type(b"{}Alternate".format(cls.__name__),
1706
cls = type("{}Alternate".format(cls.__name__),
1713
@alternate_dbus_interfaces({"se.recompile.Mandos":
1714
"se.bsnet.fukt.Mandos"})
693
1715
class ClientDBus(Client, DBusObjectWithProperties):
694
1716
"""A Client class using D-Bus
697
1719
dbus_object_path: dbus.ObjectPath
698
1720
bus: dbus.SystemBus()
1723
runtime_expansions = (Client.runtime_expansions
1724
+ ("dbus_object_path", ))
1726
_interface = "se.recompile.Mandos.Client"
700
1728
# dbus.service.Object doesn't use super(), so we can't either.
702
def __init__(self, bus = None, *args, **kwargs):
1730
def __init__(self, bus=None, *args, **kwargs):
704
1732
Client.__init__(self, *args, **kwargs)
705
1733
# Only now, when this client is initialized, can it show up on
707
self.dbus_object_path = (dbus.ObjectPath
709
+ self.name.replace(u".", u"_")))
1735
client_object_name = str(self.name).translate(
1736
{ord("."): ord("_"),
1737
ord("-"): ord("_")})
1738
self.dbus_object_path = dbus.ObjectPath(
1739
"/clients/" + client_object_name)
710
1740
DBusObjectWithProperties.__init__(self, self.bus,
711
1741
self.dbus_object_path)
714
def _datetime_to_dbus(dt, variant_level=0):
715
"""Convert a UTC datetime.datetime() to a D-Bus type."""
716
return dbus.String(dt.isoformat(),
717
variant_level=variant_level)
720
oldstate = getattr(self, u"enabled", False)
721
r = Client.enable(self)
722
if oldstate != self.enabled:
724
self.PropertyChanged(dbus.String(u"enabled"),
725
dbus.Boolean(True, variant_level=1))
726
self.PropertyChanged(
727
dbus.String(u"last_enabled"),
728
self._datetime_to_dbus(self.last_enabled,
732
def disable(self, quiet = False):
733
oldstate = getattr(self, u"enabled", False)
734
r = Client.disable(self, quiet=quiet)
735
if not quiet and oldstate != self.enabled:
737
self.PropertyChanged(dbus.String(u"enabled"),
738
dbus.Boolean(False, variant_level=1))
1743
def notifychangeproperty(transform_func, dbus_name,
1744
type_func=lambda x: x,
1746
invalidate_only=False,
1747
_interface=_interface):
1748
""" Modify a variable so that it's a property which announces
1749
its changes to DBus.
1751
transform_fun: Function that takes a value and a variant_level
1752
and transforms it to a D-Bus type.
1753
dbus_name: D-Bus name of the variable
1754
type_func: Function that transform the value before sending it
1755
to the D-Bus. Default: no transform
1756
variant_level: D-Bus variant level. Default: 1
1758
attrname = "_{}".format(dbus_name)
1760
def setter(self, value):
1761
if hasattr(self, "dbus_object_path"):
1762
if (not hasattr(self, attrname) or
1763
type_func(getattr(self, attrname, None))
1764
!= type_func(value)):
1766
self.PropertiesChanged(
1767
_interface, dbus.Dictionary(),
1768
dbus.Array((dbus_name, )))
1770
dbus_value = transform_func(
1772
variant_level=variant_level)
1773
self.PropertyChanged(dbus.String(dbus_name),
1775
self.PropertiesChanged(
1777
dbus.Dictionary({dbus.String(dbus_name):
1780
setattr(self, attrname, value)
1782
return property(lambda self: getattr(self, attrname), setter)
1784
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1785
approvals_pending = notifychangeproperty(dbus.Boolean,
1788
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1789
last_enabled = notifychangeproperty(datetime_to_dbus,
1791
checker = notifychangeproperty(
1792
dbus.Boolean, "CheckerRunning",
1793
type_func=lambda checker: checker is not None)
1794
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1796
last_checker_status = notifychangeproperty(dbus.Int16,
1797
"LastCheckerStatus")
1798
last_approval_request = notifychangeproperty(
1799
datetime_to_dbus, "LastApprovalRequest")
1800
approved_by_default = notifychangeproperty(dbus.Boolean,
1801
"ApprovedByDefault")
1802
approval_delay = notifychangeproperty(
1803
dbus.UInt64, "ApprovalDelay",
1804
type_func=lambda td: td.total_seconds() * 1000)
1805
approval_duration = notifychangeproperty(
1806
dbus.UInt64, "ApprovalDuration",
1807
type_func=lambda td: td.total_seconds() * 1000)
1808
host = notifychangeproperty(dbus.String, "Host")
1809
timeout = notifychangeproperty(
1810
dbus.UInt64, "Timeout",
1811
type_func=lambda td: td.total_seconds() * 1000)
1812
extended_timeout = notifychangeproperty(
1813
dbus.UInt64, "ExtendedTimeout",
1814
type_func=lambda td: td.total_seconds() * 1000)
1815
interval = notifychangeproperty(
1816
dbus.UInt64, "Interval",
1817
type_func=lambda td: td.total_seconds() * 1000)
1818
checker_command = notifychangeproperty(dbus.String, "Checker")
1819
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1820
invalidate_only=True)
1822
del notifychangeproperty
741
1824
def __del__(self, *args, **kwargs):
743
1826
self.remove_from_connection()
744
1827
except LookupError:
746
if hasattr(DBusObjectWithProperties, u"__del__"):
1829
if hasattr(DBusObjectWithProperties, "__del__"):
747
1830
DBusObjectWithProperties.__del__(self, *args, **kwargs)
748
1831
Client.__del__(self, *args, **kwargs)
750
def checker_callback(self, pid, condition, command,
752
self.checker_callback_tag = None
755
self.PropertyChanged(dbus.String(u"checker_running"),
756
dbus.Boolean(False, variant_level=1))
757
if os.WIFEXITED(condition):
758
exitstatus = os.WEXITSTATUS(condition)
1833
def checker_callback(self, source, condition,
1834
connection, command, *args, **kwargs):
1835
ret = Client.checker_callback(self, source, condition,
1836
connection, command, *args,
1838
exitstatus = self.last_checker_status
759
1840
# Emit D-Bus signal
760
1841
self.CheckerCompleted(dbus.Int16(exitstatus),
761
dbus.Int64(condition),
1842
# This is specific to GNU libC
1843
dbus.Int64(exitstatus << 8),
762
1844
dbus.String(command))
764
1846
# Emit D-Bus signal
765
1847
self.CheckerCompleted(dbus.Int16(-1),
766
dbus.Int64(condition),
1849
# This is specific to GNU libC
1851
| self.last_checker_signal),
767
1852
dbus.String(command))
769
return Client.checker_callback(self, pid, condition, command,
772
def checked_ok(self, *args, **kwargs):
773
r = Client.checked_ok(self, *args, **kwargs)
775
self.PropertyChanged(
776
dbus.String(u"last_checked_ok"),
777
(self._datetime_to_dbus(self.last_checked_ok,
781
1855
def start_checker(self, *args, **kwargs):
782
old_checker = self.checker
783
if self.checker is not None:
784
old_checker_pid = self.checker.pid
786
old_checker_pid = None
1856
old_checker_pid = getattr(self.checker, "pid", None)
787
1857
r = Client.start_checker(self, *args, **kwargs)
788
1858
# Only if new checker process was started
789
1859
if (self.checker is not None
790
1860
and old_checker_pid != self.checker.pid):
791
1861
# Emit D-Bus signal
792
1862
self.CheckerStarted(self.current_checker_command)
793
self.PropertyChanged(
794
dbus.String(u"checker_running"),
795
dbus.Boolean(True, variant_level=1))
798
def stop_checker(self, *args, **kwargs):
799
old_checker = getattr(self, u"checker", None)
800
r = Client.stop_checker(self, *args, **kwargs)
801
if (old_checker is not None
802
and getattr(self, u"checker", None) is None):
803
self.PropertyChanged(dbus.String(u"checker_running"),
804
dbus.Boolean(False, variant_level=1))
807
## D-Bus methods, signals & properties
808
_interface = u"se.bsnet.fukt.Mandos.Client"
1865
def _reset_approved(self):
1866
self.approved = None
1869
def approve(self, value=True):
1870
self.approved = value
1871
GLib.timeout_add(int(self.approval_duration.total_seconds()
1872
* 1000), self._reset_approved)
1873
self.send_changedstate()
1875
# D-Bus methods, signals & properties
812
1881
# CheckerCompleted - signal
813
@dbus.service.signal(_interface, signature=u"nxs")
1882
@dbus.service.signal(_interface, signature="nxs")
814
1883
def CheckerCompleted(self, exitcode, waitstatus, command):
818
1887
# CheckerStarted - signal
819
@dbus.service.signal(_interface, signature=u"s")
1888
@dbus.service.signal(_interface, signature="s")
820
1889
def CheckerStarted(self, command):
824
1893
# PropertyChanged - signal
825
@dbus.service.signal(_interface, signature=u"sv")
1894
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1895
@dbus.service.signal(_interface, signature="sv")
826
1896
def PropertyChanged(self, property, value):
830
1900
# GotSecret - signal
831
1901
@dbus.service.signal(_interface)
832
1902
def GotSecret(self):
1904
Is sent after a successful transfer of secret from the Mandos
1905
server to mandos-client
836
1909
# Rejected - signal
837
@dbus.service.signal(_interface)
1910
@dbus.service.signal(_interface, signature="s")
1911
def Rejected(self, reason):
1915
# NeedApproval - signal
1916
@dbus.service.signal(_interface, signature="tb")
1917
def NeedApproval(self, timeout, default):
1919
return self.need_approval()
1924
@dbus.service.method(_interface, in_signature="b")
1925
def Approve(self, value):
844
1928
# CheckedOK - method
845
1929
@dbus.service.method(_interface)
846
1930
def CheckedOK(self):
847
return self.checked_ok()
849
1933
# Enable - method
1934
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
850
1935
@dbus.service.method(_interface)
851
1936
def Enable(self):
855
1940
# StartChecker - method
1941
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
856
1942
@dbus.service.method(_interface)
857
1943
def StartChecker(self):
859
1945
self.start_checker()
861
1947
# Disable - method
1948
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
862
1949
@dbus.service.method(_interface)
863
1950
def Disable(self):
867
1954
# StopChecker - method
1955
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
868
1956
@dbus.service.method(_interface)
869
1957
def StopChecker(self):
870
1958
self.stop_checker()
875
@dbus_service_property(_interface, signature=u"s", access=u"read")
876
def name_dbus_property(self):
1962
# ApprovalPending - property
1963
@dbus_service_property(_interface, signature="b", access="read")
1964
def ApprovalPending_dbus_property(self):
1965
return dbus.Boolean(bool(self.approvals_pending))
1967
# ApprovedByDefault - property
1968
@dbus_service_property(_interface,
1971
def ApprovedByDefault_dbus_property(self, value=None):
1972
if value is None: # get
1973
return dbus.Boolean(self.approved_by_default)
1974
self.approved_by_default = bool(value)
1976
# ApprovalDelay - property
1977
@dbus_service_property(_interface,
1980
def ApprovalDelay_dbus_property(self, value=None):
1981
if value is None: # get
1982
return dbus.UInt64(self.approval_delay.total_seconds()
1984
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1986
# ApprovalDuration - property
1987
@dbus_service_property(_interface,
1990
def ApprovalDuration_dbus_property(self, value=None):
1991
if value is None: # get
1992
return dbus.UInt64(self.approval_duration.total_seconds()
1994
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1998
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1999
@dbus_service_property(_interface, signature="s", access="read")
2000
def Name_dbus_property(self):
877
2001
return dbus.String(self.name)
879
# fingerprint - property
880
@dbus_service_property(_interface, signature=u"s", access=u"read")
881
def fingerprint_dbus_property(self):
2003
# Fingerprint - property
2005
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2006
@dbus_service_property(_interface, signature="s", access="read")
2007
def Fingerprint_dbus_property(self):
882
2008
return dbus.String(self.fingerprint)
885
@dbus_service_property(_interface, signature=u"s",
887
def host_dbus_property(self, value=None):
2011
@dbus_service_property(_interface,
2014
def Host_dbus_property(self, value=None):
888
2015
if value is None: # get
889
2016
return dbus.String(self.host)
892
self.PropertyChanged(dbus.String(u"host"),
893
dbus.String(value, variant_level=1))
896
@dbus_service_property(_interface, signature=u"s", access=u"read")
897
def created_dbus_property(self):
898
return dbus.String(self._datetime_to_dbus(self.created))
900
# last_enabled - property
901
@dbus_service_property(_interface, signature=u"s", access=u"read")
902
def last_enabled_dbus_property(self):
903
if self.last_enabled is None:
904
return dbus.String(u"")
905
return dbus.String(self._datetime_to_dbus(self.last_enabled))
908
@dbus_service_property(_interface, signature=u"b",
910
def enabled_dbus_property(self, value=None):
2017
self.host = str(value)
2019
# Created - property
2021
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2022
@dbus_service_property(_interface, signature="s", access="read")
2023
def Created_dbus_property(self):
2024
return datetime_to_dbus(self.created)
2026
# LastEnabled - property
2027
@dbus_service_property(_interface, signature="s", access="read")
2028
def LastEnabled_dbus_property(self):
2029
return datetime_to_dbus(self.last_enabled)
2031
# Enabled - property
2032
@dbus_service_property(_interface,
2035
def Enabled_dbus_property(self, value=None):
911
2036
if value is None: # get
912
2037
return dbus.Boolean(self.enabled)
918
# last_checked_ok - property
919
@dbus_service_property(_interface, signature=u"s",
921
def last_checked_ok_dbus_property(self, value=None):
2043
# LastCheckedOK - property
2044
@dbus_service_property(_interface,
2047
def LastCheckedOK_dbus_property(self, value=None):
922
2048
if value is not None:
923
2049
self.checked_ok()
925
if self.last_checked_ok is None:
926
return dbus.String(u"")
927
return dbus.String(self._datetime_to_dbus(self
931
@dbus_service_property(_interface, signature=u"t",
933
def timeout_dbus_property(self, value=None):
2051
return datetime_to_dbus(self.last_checked_ok)
2053
# LastCheckerStatus - property
2054
@dbus_service_property(_interface, signature="n", access="read")
2055
def LastCheckerStatus_dbus_property(self):
2056
return dbus.Int16(self.last_checker_status)
2058
# Expires - property
2059
@dbus_service_property(_interface, signature="s", access="read")
2060
def Expires_dbus_property(self):
2061
return datetime_to_dbus(self.expires)
2063
# LastApprovalRequest - property
2064
@dbus_service_property(_interface, signature="s", access="read")
2065
def LastApprovalRequest_dbus_property(self):
2066
return datetime_to_dbus(self.last_approval_request)
2068
# Timeout - property
2069
@dbus_service_property(_interface,
2072
def Timeout_dbus_property(self, value=None):
934
2073
if value is None: # get
935
return dbus.UInt64(self.timeout_milliseconds())
2074
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2075
old_timeout = self.timeout
936
2076
self.timeout = datetime.timedelta(0, 0, 0, value)
938
self.PropertyChanged(dbus.String(u"timeout"),
939
dbus.UInt64(value, variant_level=1))
940
if getattr(self, u"disable_initiator_tag", None) is None:
943
gobject.source_remove(self.disable_initiator_tag)
944
self.disable_initiator_tag = None
946
_timedelta_to_milliseconds((self
952
# The timeout has passed
955
self.disable_initiator_tag = (gobject.timeout_add
956
(time_to_die, self.disable))
958
# interval - property
959
@dbus_service_property(_interface, signature=u"t",
961
def interval_dbus_property(self, value=None):
962
if value is None: # get
963
return dbus.UInt64(self.interval_milliseconds())
2077
# Reschedule disabling
2079
now = datetime.datetime.utcnow()
2080
self.expires += self.timeout - old_timeout
2081
if self.expires <= now:
2082
# The timeout has passed
2085
if (getattr(self, "disable_initiator_tag", None)
2088
GLib.source_remove(self.disable_initiator_tag)
2089
self.disable_initiator_tag = GLib.timeout_add(
2090
int((self.expires - now).total_seconds() * 1000),
2093
# ExtendedTimeout - property
2094
@dbus_service_property(_interface,
2097
def ExtendedTimeout_dbus_property(self, value=None):
2098
if value is None: # get
2099
return dbus.UInt64(self.extended_timeout.total_seconds()
2101
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2103
# Interval - property
2104
@dbus_service_property(_interface,
2107
def Interval_dbus_property(self, value=None):
2108
if value is None: # get
2109
return dbus.UInt64(self.interval.total_seconds() * 1000)
964
2110
self.interval = datetime.timedelta(0, 0, 0, value)
966
self.PropertyChanged(dbus.String(u"interval"),
967
dbus.UInt64(value, variant_level=1))
968
if getattr(self, u"checker_initiator_tag", None) is None:
2111
if getattr(self, "checker_initiator_tag", None) is None:
970
# Reschedule checker run
971
gobject.source_remove(self.checker_initiator_tag)
972
self.checker_initiator_tag = (gobject.timeout_add
973
(value, self.start_checker))
974
self.start_checker() # Start one now, too
2114
# Reschedule checker run
2115
GLib.source_remove(self.checker_initiator_tag)
2116
self.checker_initiator_tag = GLib.timeout_add(
2117
value, self.start_checker)
2118
self.start_checker() # Start one now, too
977
@dbus_service_property(_interface, signature=u"s",
979
def checker_dbus_property(self, value=None):
2120
# Checker - property
2121
@dbus_service_property(_interface,
2124
def Checker_dbus_property(self, value=None):
980
2125
if value is None: # get
981
2126
return dbus.String(self.checker_command)
982
self.checker_command = value
984
self.PropertyChanged(dbus.String(u"checker"),
985
dbus.String(self.checker_command,
988
# checker_running - property
989
@dbus_service_property(_interface, signature=u"b",
991
def checker_running_dbus_property(self, value=None):
2127
self.checker_command = str(value)
2129
# CheckerRunning - property
2130
@dbus_service_property(_interface,
2133
def CheckerRunning_dbus_property(self, value=None):
992
2134
if value is None: # get
993
2135
return dbus.Boolean(self.checker is not None)
995
2137
self.start_checker()
997
2139
self.stop_checker()
999
# object_path - property
1000
@dbus_service_property(_interface, signature=u"o", access=u"read")
1001
def object_path_dbus_property(self):
1002
return self.dbus_object_path # is already a dbus.ObjectPath
1005
@dbus_service_property(_interface, signature=u"ay",
1006
access=u"write", byte_arrays=True)
1007
def secret_dbus_property(self, value):
1008
self.secret = str(value)
2141
# ObjectPath - property
2143
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2144
"org.freedesktop.DBus.Deprecated": "true"})
2145
@dbus_service_property(_interface, signature="o", access="read")
2146
def ObjectPath_dbus_property(self):
2147
return self.dbus_object_path # is already a dbus.ObjectPath
2151
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2153
@dbus_service_property(_interface,
2157
def Secret_dbus_property(self, value):
2158
self.secret = bytes(value)
2163
class ProxyClient(object):
2164
def __init__(self, child_pipe, fpr, address):
2165
self._pipe = child_pipe
2166
self._pipe.send(('init', fpr, address))
2167
if not self._pipe.recv():
2170
def __getattribute__(self, name):
2172
return super(ProxyClient, self).__getattribute__(name)
2173
self._pipe.send(('getattr', name))
2174
data = self._pipe.recv()
2175
if data[0] == 'data':
2177
if data[0] == 'function':
2179
def func(*args, **kwargs):
2180
self._pipe.send(('funcall', name, args, kwargs))
2181
return self._pipe.recv()[1]
2185
def __setattr__(self, name, value):
2187
return super(ProxyClient, self).__setattr__(name, value)
2188
self._pipe.send(('setattr', name, value))
1013
2191
class ClientHandler(socketserver.BaseRequestHandler, object):
1014
2192
"""A class to handle client connections.
1016
2194
Instantiated once for each connection to handle it.
1017
2195
Note: This will run in its own forked process."""
1019
2197
def handle(self):
1020
logger.info(u"TCP connection from: %s",
1021
unicode(self.client_address))
1022
logger.debug(u"IPC Pipe FD: %d",
1023
self.server.child_pipe[1].fileno())
1024
# Open IPC pipe to parent process
1025
with contextlib.nested(self.server.child_pipe[1],
1026
self.server.parent_pipe[0]
1027
) as (ipc, ipc_return):
1028
session = (gnutls.connection
1029
.ClientSession(self.request,
1031
.X509Credentials()))
1033
line = self.request.makefile().readline()
1034
logger.debug(u"Protocol version: %r", line)
1036
if int(line.strip().split()[0]) > 1:
1038
except (ValueError, IndexError, RuntimeError), error:
1039
logger.error(u"Unknown protocol version: %s", error)
1042
# Note: gnutls.connection.X509Credentials is really a
1043
# generic GnuTLS certificate credentials object so long as
1044
# no X.509 keys are added to it. Therefore, we can use it
1045
# here despite using OpenPGP certificates.
1047
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1048
# u"+AES-256-CBC", u"+SHA1",
1049
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2198
with contextlib.closing(self.server.child_pipe) as child_pipe:
2199
logger.info("TCP connection from: %s",
2200
str(self.client_address))
2201
logger.debug("Pipe FD: %d",
2202
self.server.child_pipe.fileno())
2204
session = gnutls.ClientSession(self.request)
2206
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2207
# "+AES-256-CBC", "+SHA1",
2208
# "+COMP-NULL", "+CTYPE-OPENPGP",
1051
2210
# Use a fallback default, since this MUST be set.
1052
2211
priority = self.server.gnutls_priority
1053
2212
if priority is None:
1054
priority = u"NORMAL"
1055
(gnutls.library.functions
1056
.gnutls_priority_set_direct(session._c_object,
2214
gnutls.priority_set_direct(session._c_object,
2215
priority.encode("utf-8"),
2218
# Start communication using the Mandos protocol
2219
# Get protocol number
2220
line = self.request.makefile().readline()
2221
logger.debug("Protocol version: %r", line)
2223
if int(line.strip().split()[0]) > 1:
2224
raise RuntimeError(line)
2225
except (ValueError, IndexError, RuntimeError) as error:
2226
logger.error("Unknown protocol version: %s", error)
2229
# Start GnuTLS connection
1060
2231
session.handshake()
1061
except gnutls.errors.GNUTLSError, error:
1062
logger.warning(u"Handshake failed: %s", error)
2232
except gnutls.Error as error:
2233
logger.warning("Handshake failed: %s", error)
1063
2234
# Do not run session.bye() here: the session is not
1064
2235
# established. Just abandon the request.
1066
logger.debug(u"Handshake succeeded")
2237
logger.debug("Handshake succeeded")
2239
approval_required = False
1069
fpr = self.fingerprint(self.peer_certificate
1071
except (TypeError, gnutls.errors.GNUTLSError), error:
1072
logger.warning(u"Bad certificate: %s", error)
1074
logger.debug(u"Fingerprint: %s", fpr)
1076
for c in self.server.clients:
1077
if c.fingerprint == fpr:
1081
ipc.write(u"NOTFOUND %s %s\n"
1082
% (fpr, unicode(self.client_address)))
1085
class proxyclient(object):
1086
def __getattribute__(self, name):
1087
ipc.write(u"GETATTR %s %s\n" % name, client.fpr)
1088
return pickle.load(ipc_reply)
1089
p = proxyclient(client)
2242
fpr = self.fingerprint(
2243
self.peer_certificate(session))
2244
except (TypeError, gnutls.Error) as error:
2245
logger.warning("Bad certificate: %s", error)
2247
logger.debug("Fingerprint: %s", fpr)
2250
client = ProxyClient(child_pipe, fpr,
2251
self.client_address)
2255
if client.approval_delay:
2256
delay = client.approval_delay
2257
client.approvals_pending += 1
2258
approval_required = True
1092
if not p.client.enabled:
1093
icp.write("DISABLED %s\n" % client.fpr)
1095
if p.client.approved == False:
1096
icp.write("Disaproved")
1099
if not p.client.secret:
1100
icp.write("No password")
1101
elif not p.client.approved:
1102
icp.write("Need approval"):
1104
#We have a password and are approved
2261
if not client.enabled:
2262
logger.info("Client %s is disabled",
2264
if self.server.use_dbus:
2266
client.Rejected("Disabled")
2269
if client.approved or not client.approval_delay:
2270
# We are approved or approval is disabled
1106
i, o, e = select(p.changesignal, (), (), client.delay)
1108
icp.write("Timeout passed")
2272
elif client.approved is None:
2273
logger.info("Client %s needs approval",
2275
if self.server.use_dbus:
2277
client.NeedApproval(
2278
client.approval_delay.total_seconds()
2279
* 1000, client.approved_by_default)
2281
logger.warning("Client %s was not approved",
2283
if self.server.use_dbus:
2285
client.Rejected("Denied")
1111
ipc.write(u"SENDING %s\n" % client.name)
1113
while sent_size < len(client.secret):
1114
sent = session.send(client.secret[sent_size:])
1115
logger.debug(u"Sent: %d, remaining: %d",
1116
sent, len(client.secret)
1117
- (sent_size + sent))
2288
# wait until timeout or approved
2289
time = datetime.datetime.now()
2290
client.changedstate.acquire()
2291
client.changedstate.wait(delay.total_seconds())
2292
client.changedstate.release()
2293
time2 = datetime.datetime.now()
2294
if (time2 - time) >= delay:
2295
if not client.approved_by_default:
2296
logger.warning("Client %s timed out while"
2297
" waiting for approval",
2299
if self.server.use_dbus:
2301
client.Rejected("Approval timed out")
2306
delay -= time2 - time
2309
session.send(client.secret)
2310
except gnutls.Error as error:
2311
logger.warning("gnutls send failed",
2315
logger.info("Sending secret to %s", client.name)
2316
# bump the timeout using extended_timeout
2317
client.bump_timeout(client.extended_timeout)
2318
if self.server.use_dbus:
2323
if approval_required:
2324
client.approvals_pending -= 1
2327
except gnutls.Error as error:
2328
logger.warning("GnuTLS bye failed",
1123
2332
def peer_certificate(session):
1124
2333
"Return the peer's OpenPGP certificate as a bytestring"
1125
2334
# If not an OpenPGP certificate...
1126
if (gnutls.library.functions
1127
.gnutls_certificate_type_get(session._c_object)
1128
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1129
# ...do the normal thing
1130
return session.peer_certificate
2335
if (gnutls.certificate_type_get(session._c_object)
2336
!= gnutls.CRT_OPENPGP):
2337
# ...return invalid data
1131
2339
list_size = ctypes.c_uint(1)
1132
cert_list = (gnutls.library.functions
1133
.gnutls_certificate_get_peers
2340
cert_list = (gnutls.certificate_get_peers
1134
2341
(session._c_object, ctypes.byref(list_size)))
1135
2342
if not bool(cert_list) and list_size.value != 0:
1136
raise gnutls.errors.GNUTLSError(u"error getting peer"
2343
raise gnutls.Error("error getting peer certificate")
1138
2344
if list_size.value == 0:
1140
2346
cert = cert_list[0]
1141
2347
return ctypes.string_at(cert.data, cert.size)
1144
2350
def fingerprint(openpgp):
1145
2351
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1146
2352
# New GnuTLS "datum" with the OpenPGP public key
1147
datum = (gnutls.library.types
1148
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1151
ctypes.c_uint(len(openpgp))))
2353
datum = gnutls.datum_t(
2354
ctypes.cast(ctypes.c_char_p(openpgp),
2355
ctypes.POINTER(ctypes.c_ubyte)),
2356
ctypes.c_uint(len(openpgp)))
1152
2357
# New empty GnuTLS certificate
1153
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1154
(gnutls.library.functions
1155
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2358
crt = gnutls.openpgp_crt_t()
2359
gnutls.openpgp_crt_init(ctypes.byref(crt))
1156
2360
# Import the OpenPGP public key into the certificate
1157
(gnutls.library.functions
1158
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1159
gnutls.library.constants
1160
.GNUTLS_OPENPGP_FMT_RAW))
2361
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2362
gnutls.OPENPGP_FMT_RAW)
1161
2363
# Verify the self signature in the key
1162
2364
crtverify = ctypes.c_uint()
1163
(gnutls.library.functions
1164
.gnutls_openpgp_crt_verify_self(crt, 0,
1165
ctypes.byref(crtverify)))
2365
gnutls.openpgp_crt_verify_self(crt, 0,
2366
ctypes.byref(crtverify))
1166
2367
if crtverify.value != 0:
1167
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1168
raise (gnutls.errors.CertificateSecurityError
2368
gnutls.openpgp_crt_deinit(crt)
2369
raise gnutls.CertificateSecurityError("Verify failed")
1170
2370
# New buffer for the fingerprint
1171
2371
buf = ctypes.create_string_buffer(20)
1172
2372
buf_len = ctypes.c_size_t()
1173
2373
# Get the fingerprint from the certificate into the buffer
1174
(gnutls.library.functions
1175
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1176
ctypes.byref(buf_len)))
2374
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2375
ctypes.byref(buf_len))
1177
2376
# Deinit the certificate
1178
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2377
gnutls.openpgp_crt_deinit(crt)
1179
2378
# Convert the buffer to a Python bytestring
1180
2379
fpr = ctypes.string_at(buf, buf_len.value)
1181
2380
# Convert the bytestring to hexadecimal notation
1182
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2381
hex_fpr = binascii.hexlify(fpr).upper()
1186
class ForkingMixInWithPipes(socketserver.ForkingMixIn, object):
1187
"""Like socketserver.ForkingMixIn, but also pass a pipe pair."""
2385
class MultiprocessingMixIn(object):
2386
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2388
def sub_process_main(self, request, address):
2390
self.finish_request(request, address)
2392
self.handle_error(request, address)
2393
self.close_request(request)
2395
def process_request(self, request, address):
2396
"""Start a new process to process the request."""
2397
proc = multiprocessing.Process(target=self.sub_process_main,
2398
args=(request, address))
2403
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2404
""" adds a pipe to the MixIn """
1188
2406
def process_request(self, request, client_address):
1189
2407
"""Overrides and wraps the original process_request().
1191
2409
This function creates a new pipe in self.pipe
1193
# Child writes to child_pipe
1194
self.child_pipe = map(os.fdopen, os.pipe(), u"rw", (1, 0))
1195
# Parent writes to parent_pipe
1196
self.parent_pipe = map(os.fdopen, os.pipe(), u"rw", (1, 0))
1197
super(ForkingMixInWithPipes,
1198
self).process_request(request, client_address)
1199
# Close unused ends for parent
1200
self.parent_pipe[0].close() # close read end
1201
self.child_pipe[1].close() # close write end
1202
self.add_pipe_fds(self.child_pipe[0], self.parent_pipe[1])
1203
def add_pipe_fds(self, child_pipe_fd, parent_pipe_fd):
2411
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2413
proc = MultiprocessingMixIn.process_request(self, request,
2415
self.child_pipe.close()
2416
self.add_pipe(parent_pipe, proc)
2418
def add_pipe(self, parent_pipe, proc):
1204
2419
"""Dummy function; override as necessary"""
1205
child_pipe_fd.close()
1206
parent_pipe_fd.close()
1209
class IPv6_TCPServer(ForkingMixInWithPipes,
2420
raise NotImplementedError()
2423
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1210
2424
socketserver.TCPServer, object):
1211
2425
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1214
2428
enabled: Boolean; whether this server is activated yet
1215
2429
interface: None or a network interface name (string)
1216
2430
use_ipv6: Boolean; to use IPv6 or not
1218
2433
def __init__(self, server_address, RequestHandlerClass,
1219
interface=None, use_ipv6=True):
2437
"""If socketfd is set, use that file descriptor instead of
2438
creating a new one with socket.socket().
1220
2440
self.interface = interface
1222
2442
self.address_family = socket.AF_INET6
2443
if socketfd is not None:
2444
# Save the file descriptor
2445
self.socketfd = socketfd
2446
# Save the original socket.socket() function
2447
self.socket_socket = socket.socket
2449
# To implement --socket, we monkey patch socket.socket.
2451
# (When socketserver.TCPServer is a new-style class, we
2452
# could make self.socket into a property instead of monkey
2453
# patching socket.socket.)
2455
# Create a one-time-only replacement for socket.socket()
2456
@functools.wraps(socket.socket)
2457
def socket_wrapper(*args, **kwargs):
2458
# Restore original function so subsequent calls are
2460
socket.socket = self.socket_socket
2461
del self.socket_socket
2462
# This time only, return a new socket object from the
2463
# saved file descriptor.
2464
return socket.fromfd(self.socketfd, *args, **kwargs)
2465
# Replace socket.socket() function with wrapper
2466
socket.socket = socket_wrapper
2467
# The socketserver.TCPServer.__init__ will call
2468
# socket.socket(), which might be our replacement,
2469
# socket_wrapper(), if socketfd was set.
1223
2470
socketserver.TCPServer.__init__(self, server_address,
1224
2471
RequestHandlerClass)
1225
2473
def server_bind(self):
1226
2474
"""This overrides the normal server_bind() function
1227
2475
to bind to an interface if one was specified, and also NOT to
1228
2476
bind to an address or port if they were not specified."""
2477
global SO_BINDTODEVICE
1229
2478
if self.interface is not None:
1230
2479
if SO_BINDTODEVICE is None:
1231
logger.error(u"SO_BINDTODEVICE does not exist;"
1232
u" cannot bind to interface %s",
1236
self.socket.setsockopt(socket.SOL_SOCKET,
1240
except socket.error, error:
1241
if error[0] == errno.EPERM:
1242
logger.error(u"No permission to"
1243
u" bind to interface %s",
1245
elif error[0] == errno.ENOPROTOOPT:
1246
logger.error(u"SO_BINDTODEVICE not available;"
1247
u" cannot bind to interface %s",
2480
# Fall back to a hard-coded value which seems to be
2482
logger.warning("SO_BINDTODEVICE not found, trying 25")
2483
SO_BINDTODEVICE = 25
2485
self.socket.setsockopt(
2486
socket.SOL_SOCKET, SO_BINDTODEVICE,
2487
(self.interface + "\0").encode("utf-8"))
2488
except socket.error as error:
2489
if error.errno == errno.EPERM:
2490
logger.error("No permission to bind to"
2491
" interface %s", self.interface)
2492
elif error.errno == errno.ENOPROTOOPT:
2493
logger.error("SO_BINDTODEVICE not available;"
2494
" cannot bind to interface %s",
2496
elif error.errno == errno.ENODEV:
2497
logger.error("Interface %s does not exist,"
2498
" cannot bind", self.interface)
1251
2501
# Only bind(2) the socket if we really need to.
1252
2502
if self.server_address[0] or self.server_address[1]:
1253
2503
if not self.server_address[0]:
1254
2504
if self.address_family == socket.AF_INET6:
1255
any_address = u"::" # in6addr_any
2505
any_address = "::" # in6addr_any
1257
any_address = socket.INADDR_ANY
2507
any_address = "0.0.0.0" # INADDR_ANY
1258
2508
self.server_address = (any_address,
1259
2509
self.server_address[1])
1260
2510
elif not self.server_address[1]:
1261
self.server_address = (self.server_address[0],
2511
self.server_address = (self.server_address[0], 0)
1263
2512
# if self.interface:
1264
2513
# self.server_address = (self.server_address[0],
1272
2521
class MandosServer(IPv6_TCPServer):
1273
2522
"""Mandos server.
1276
2525
clients: set of Client objects
1277
2526
gnutls_priority GnuTLS priority string
1278
2527
use_dbus: Boolean; to emit D-Bus signals or not
1280
Assumes a gobject.MainLoop event loop.
2529
Assumes a GLib.MainLoop event loop.
1282
2532
def __init__(self, server_address, RequestHandlerClass,
1283
interface=None, use_ipv6=True, clients=None,
1284
gnutls_priority=None, use_dbus=True):
2536
gnutls_priority=None,
1285
2539
self.enabled = False
1286
2540
self.clients = clients
1287
2541
if self.clients is None:
1288
self.clients = set()
1289
2543
self.use_dbus = use_dbus
1290
2544
self.gnutls_priority = gnutls_priority
1291
2545
IPv6_TCPServer.__init__(self, server_address,
1292
2546
RequestHandlerClass,
1293
interface = interface,
1294
use_ipv6 = use_ipv6)
2547
interface=interface,
1295
2551
def server_activate(self):
1296
2552
if self.enabled:
1297
2553
return socketserver.TCPServer.server_activate(self)
1298
2555
def enable(self):
1299
2556
self.enabled = True
1300
def add_pipe_fds(self, child_pipe_fd, parent_pipe_fd):
2558
def add_pipe(self, parent_pipe, proc):
1301
2559
# Call "handle_ipc" for both data and EOF events
1302
gobject.io_add_watch(child_pipe_fd.fileno(),
1303
gobject.IO_IN | gobject.IO_HUP,
1304
functools.partial(self.handle_ipc,
1305
reply = parent_pipe_fd,
1306
sender= child_pipe_fd))
1307
def handle_ipc(self, source, condition, reply=None, sender=None):
1309
gobject.IO_IN: u"IN", # There is data to read.
1310
gobject.IO_OUT: u"OUT", # Data can be written (without
1312
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1313
gobject.IO_ERR: u"ERR", # Error condition.
1314
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1315
# broken, usually for pipes and
1318
conditions_string = ' | '.join(name
1320
condition_names.iteritems()
1321
if cond & condition)
1322
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1325
# Read a line from the file object
1326
cmdline = sender.readline()
1327
if not cmdline: # Empty line means end of file
1328
# close the IPC pipes
1332
# Stop calling this function
1335
logger.debug(u"IPC command: %r", cmdline)
1337
# Parse and act on command
1338
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1340
if cmd == u"NOTFOUND":
1341
fpr, address = args.split(None, 1)
1342
logger.warning(u"Client not found for fingerprint: %s, ad"
1343
u"dress: %s", fpr, address)
1346
mandos_dbus_service.ClientNotFound(fpr, address)
1347
elif cmd == u"DISABLED":
1348
for client in self.clients:
1349
if client.name == args:
1350
logger.warning(u"Client %s is disabled", args)
1356
logger.error(u"Unknown client %s is disabled", args)
1357
elif cmd == u"SENDING":
1358
for client in self.clients:
1359
if client.name == args:
1360
logger.info(u"Sending secret to %s", client.name)
1367
logger.error(u"Sending secret to unknown client %s",
1369
elif cmd == u"GETATTR":
1370
attr_name, fpr = args.split(None, 1)
1371
for client in self.clients:
1372
if client.fingerprint == fpr:
1373
attr_value = getattr(client, attr_name, None)
1374
logger.debug("IPC reply: %r", attr_value)
1375
pickle.dump(attr_value, reply)
1378
logger.error(u"Client %s on address %s requesting "
1379
u"attribute %s not found", fpr, address,
1381
pickle.dump(None, reply)
2561
parent_pipe.fileno(),
2562
GLib.IO_IN | GLib.IO_HUP,
2563
functools.partial(self.handle_ipc,
2564
parent_pipe=parent_pipe,
2567
def handle_ipc(self, source, condition,
2570
client_object=None):
2571
# error, or the other end of multiprocessing.Pipe has closed
2572
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2573
# Wait for other process to exit
2577
# Read a request from the child
2578
request = parent_pipe.recv()
2579
command = request[0]
2581
if command == 'init':
2582
fpr = request[1].decode("ascii")
2583
address = request[2]
2585
for c in self.clients.values():
2586
if c.fingerprint == fpr:
2590
logger.info("Client not found for fingerprint: %s, ad"
2591
"dress: %s", fpr, address)
2594
mandos_dbus_service.ClientNotFound(fpr,
2596
parent_pipe.send(False)
2600
parent_pipe.fileno(),
2601
GLib.IO_IN | GLib.IO_HUP,
2602
functools.partial(self.handle_ipc,
2603
parent_pipe=parent_pipe,
2605
client_object=client))
2606
parent_pipe.send(True)
2607
# remove the old hook in favor of the new above hook on
2610
if command == 'funcall':
2611
funcname = request[1]
2615
parent_pipe.send(('data', getattr(client_object,
2619
if command == 'getattr':
2620
attrname = request[1]
2621
if isinstance(client_object.__getattribute__(attrname),
2622
collections.Callable):
2623
parent_pipe.send(('function', ))
2626
'data', client_object.__getattribute__(attrname)))
2628
if command == 'setattr':
2629
attrname = request[1]
2631
setattr(client_object, attrname, value)
2636
def rfc3339_duration_to_delta(duration):
2637
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2639
>>> rfc3339_duration_to_delta("P7D")
2640
datetime.timedelta(7)
2641
>>> rfc3339_duration_to_delta("PT60S")
2642
datetime.timedelta(0, 60)
2643
>>> rfc3339_duration_to_delta("PT60M")
2644
datetime.timedelta(0, 3600)
2645
>>> rfc3339_duration_to_delta("PT24H")
2646
datetime.timedelta(1)
2647
>>> rfc3339_duration_to_delta("P1W")
2648
datetime.timedelta(7)
2649
>>> rfc3339_duration_to_delta("PT5M30S")
2650
datetime.timedelta(0, 330)
2651
>>> rfc3339_duration_to_delta("P1DT3M20S")
2652
datetime.timedelta(1, 200)
2655
# Parsing an RFC 3339 duration with regular expressions is not
2656
# possible - there would have to be multiple places for the same
2657
# values, like seconds. The current code, while more esoteric, is
2658
# cleaner without depending on a parsing library. If Python had a
2659
# built-in library for parsing we would use it, but we'd like to
2660
# avoid excessive use of external libraries.
2662
# New type for defining tokens, syntax, and semantics all-in-one
2663
Token = collections.namedtuple("Token", (
2664
"regexp", # To match token; if "value" is not None, must have
2665
# a "group" containing digits
2666
"value", # datetime.timedelta or None
2667
"followers")) # Tokens valid after this token
2668
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2669
# the "duration" ABNF definition in RFC 3339, Appendix A.
2670
token_end = Token(re.compile(r"$"), None, frozenset())
2671
token_second = Token(re.compile(r"(\d+)S"),
2672
datetime.timedelta(seconds=1),
2673
frozenset((token_end, )))
2674
token_minute = Token(re.compile(r"(\d+)M"),
2675
datetime.timedelta(minutes=1),
2676
frozenset((token_second, token_end)))
2677
token_hour = Token(re.compile(r"(\d+)H"),
2678
datetime.timedelta(hours=1),
2679
frozenset((token_minute, token_end)))
2680
token_time = Token(re.compile(r"T"),
2682
frozenset((token_hour, token_minute,
2684
token_day = Token(re.compile(r"(\d+)D"),
2685
datetime.timedelta(days=1),
2686
frozenset((token_time, token_end)))
2687
token_month = Token(re.compile(r"(\d+)M"),
2688
datetime.timedelta(weeks=4),
2689
frozenset((token_day, token_end)))
2690
token_year = Token(re.compile(r"(\d+)Y"),
2691
datetime.timedelta(weeks=52),
2692
frozenset((token_month, token_end)))
2693
token_week = Token(re.compile(r"(\d+)W"),
2694
datetime.timedelta(weeks=1),
2695
frozenset((token_end, )))
2696
token_duration = Token(re.compile(r"P"), None,
2697
frozenset((token_year, token_month,
2698
token_day, token_time,
2700
# Define starting values:
2702
value = datetime.timedelta()
2704
# Following valid tokens
2705
followers = frozenset((token_duration, ))
2706
# String left to parse
2708
# Loop until end token is found
2709
while found_token is not token_end:
2710
# Search for any currently valid tokens
2711
for token in followers:
2712
match = token.regexp.match(s)
2713
if match is not None:
2715
if token.value is not None:
2716
# Value found, parse digits
2717
factor = int(match.group(1), 10)
2718
# Add to value so far
2719
value += factor * token.value
2720
# Strip token from string
2721
s = token.regexp.sub("", s, 1)
2724
# Set valid next tokens
2725
followers = found_token.followers
1383
logger.error(u"Unknown IPC command: %r", cmdline)
1385
# Keep calling this function
2728
# No currently valid tokens were found
2729
raise ValueError("Invalid RFC 3339 duration: {!r}"
1389
2735
def string_to_delta(interval):
1390
2736
"""Parse a string and return a datetime.timedelta
1392
>>> string_to_delta(u'7d')
2738
>>> string_to_delta('7d')
1393
2739
datetime.timedelta(7)
1394
>>> string_to_delta(u'60s')
2740
>>> string_to_delta('60s')
1395
2741
datetime.timedelta(0, 60)
1396
>>> string_to_delta(u'60m')
2742
>>> string_to_delta('60m')
1397
2743
datetime.timedelta(0, 3600)
1398
>>> string_to_delta(u'24h')
2744
>>> string_to_delta('24h')
1399
2745
datetime.timedelta(1)
1400
>>> string_to_delta(u'1w')
2746
>>> string_to_delta('1w')
1401
2747
datetime.timedelta(7)
1402
>>> string_to_delta(u'5m 30s')
2748
>>> string_to_delta('5m 30s')
1403
2749
datetime.timedelta(0, 330)
2753
return rfc3339_duration_to_delta(interval)
1405
2757
timevalue = datetime.timedelta(0)
1406
2758
for s in interval.split():
1408
suffix = unicode(s[-1])
1409
2761
value = int(s[:-1])
1411
2763
delta = datetime.timedelta(value)
1412
elif suffix == u"s":
1413
2765
delta = datetime.timedelta(0, value)
1414
elif suffix == u"m":
1415
2767
delta = datetime.timedelta(0, 0, 0, 0, value)
1416
elif suffix == u"h":
1417
2769
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1418
elif suffix == u"w":
1419
2771
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1421
raise ValueError(u"Unknown suffix %r" % suffix)
1422
except (ValueError, IndexError), e:
1423
raise ValueError(e.message)
2773
raise ValueError("Unknown suffix {!r}".format(suffix))
2774
except IndexError as e:
2775
raise ValueError(*(e.args))
1424
2776
timevalue += delta
1425
2777
return timevalue
1428
def if_nametoindex(interface):
1429
"""Call the C function if_nametoindex(), or equivalent
1431
Note: This function cannot accept a unicode string."""
1432
global if_nametoindex
1434
if_nametoindex = (ctypes.cdll.LoadLibrary
1435
(ctypes.util.find_library(u"c"))
1437
except (OSError, AttributeError):
1438
logger.warning(u"Doing if_nametoindex the hard way")
1439
def if_nametoindex(interface):
1440
"Get an interface index the hard way, i.e. using fcntl()"
1441
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1442
with contextlib.closing(socket.socket()) as s:
1443
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1444
struct.pack(str(u"16s16x"),
1446
interface_index = struct.unpack(str(u"I"),
1448
return interface_index
1449
return if_nametoindex(interface)
1452
def daemon(nochdir = False, noclose = False):
2780
def daemon(nochdir=False, noclose=False):
1453
2781
"""See daemon(3). Standard BSD Unix function.
1455
2783
This should really exist as os.daemon, but it doesn't (yet)."""
1459
2787
if not nochdir:
1463
2791
if not noclose:
1464
2792
# Close all standard open file descriptors
1465
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2793
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1466
2794
if not stat.S_ISCHR(os.fstat(null).st_mode):
1467
2795
raise OSError(errno.ENODEV,
1468
u"%s not a character device"
2796
"{} not a character device"
2797
.format(os.devnull))
1470
2798
os.dup2(null, sys.stdin.fileno())
1471
2799
os.dup2(null, sys.stdout.fileno())
1472
2800
os.dup2(null, sys.stderr.fileno())
1479
2807
##################################################################
1480
2808
# Parsing of options, both command line and config file
1482
parser = optparse.OptionParser(version = "%%prog %s" % version)
1483
parser.add_option("-i", u"--interface", type=u"string",
1484
metavar="IF", help=u"Bind to interface IF")
1485
parser.add_option("-a", u"--address", type=u"string",
1486
help=u"Address to listen for requests on")
1487
parser.add_option("-p", u"--port", type=u"int",
1488
help=u"Port number to receive requests on")
1489
parser.add_option("--check", action=u"store_true",
1490
help=u"Run self-test")
1491
parser.add_option("--debug", action=u"store_true",
1492
help=u"Debug mode; run in foreground and log to"
1494
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1495
u" priority string (see GnuTLS documentation)")
1496
parser.add_option("--servicename", type=u"string",
1497
metavar=u"NAME", help=u"Zeroconf service name")
1498
parser.add_option("--configdir", type=u"string",
1499
default=u"/etc/mandos", metavar=u"DIR",
1500
help=u"Directory to search for configuration"
1502
parser.add_option("--no-dbus", action=u"store_false",
1503
dest=u"use_dbus", help=u"Do not provide D-Bus"
1504
u" system bus interface")
1505
parser.add_option("--no-ipv6", action=u"store_false",
1506
dest=u"use_ipv6", help=u"Do not use IPv6")
1507
options = parser.parse_args()[0]
2810
parser = argparse.ArgumentParser()
2811
parser.add_argument("-v", "--version", action="version",
2812
version="%(prog)s {}".format(version),
2813
help="show version number and exit")
2814
parser.add_argument("-i", "--interface", metavar="IF",
2815
help="Bind to interface IF")
2816
parser.add_argument("-a", "--address",
2817
help="Address to listen for requests on")
2818
parser.add_argument("-p", "--port", type=int,
2819
help="Port number to receive requests on")
2820
parser.add_argument("--check", action="store_true",
2821
help="Run self-test")
2822
parser.add_argument("--debug", action="store_true",
2823
help="Debug mode; run in foreground and log"
2824
" to terminal", default=None)
2825
parser.add_argument("--debuglevel", metavar="LEVEL",
2826
help="Debug level for stdout output")
2827
parser.add_argument("--priority", help="GnuTLS"
2828
" priority string (see GnuTLS documentation)")
2829
parser.add_argument("--servicename",
2830
metavar="NAME", help="Zeroconf service name")
2831
parser.add_argument("--configdir",
2832
default="/etc/mandos", metavar="DIR",
2833
help="Directory to search for configuration"
2835
parser.add_argument("--no-dbus", action="store_false",
2836
dest="use_dbus", help="Do not provide D-Bus"
2837
" system bus interface", default=None)
2838
parser.add_argument("--no-ipv6", action="store_false",
2839
dest="use_ipv6", help="Do not use IPv6",
2841
parser.add_argument("--no-restore", action="store_false",
2842
dest="restore", help="Do not restore stored"
2843
" state", default=None)
2844
parser.add_argument("--socket", type=int,
2845
help="Specify a file descriptor to a network"
2846
" socket to use instead of creating one")
2847
parser.add_argument("--statedir", metavar="DIR",
2848
help="Directory to save/restore state in")
2849
parser.add_argument("--foreground", action="store_true",
2850
help="Run in foreground", default=None)
2851
parser.add_argument("--no-zeroconf", action="store_false",
2852
dest="zeroconf", help="Do not use Zeroconf",
2855
options = parser.parse_args()
1509
2857
if options.check:
2859
fail_count, test_count = doctest.testmod()
2860
sys.exit(os.EX_OK if fail_count == 0 else 1)
1514
2862
# Default values for config file for server-global settings
1515
server_defaults = { u"interface": u"",
1520
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1521
u"servicename": u"Mandos",
1522
u"use_dbus": u"True",
1523
u"use_ipv6": u"True",
2863
server_defaults = {"interface": "",
2868
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2869
":+SIGN-DSA-SHA256",
2870
"servicename": "Mandos",
2876
"statedir": "/var/lib/mandos",
2877
"foreground": "False",
1526
2881
# Parse config file for server-global settings
1527
2882
server_config = configparser.SafeConfigParser(server_defaults)
1528
2883
del server_defaults
1529
server_config.read(os.path.join(options.configdir,
2884
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1531
2885
# Convert the SafeConfigParser object to a dict
1532
2886
server_settings = server_config.defaults()
1533
2887
# Use the appropriate methods on the non-string config options
1534
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1535
server_settings[option] = server_config.getboolean(u"DEFAULT",
2888
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2889
"foreground", "zeroconf"):
2890
server_settings[option] = server_config.getboolean("DEFAULT",
1537
2892
if server_settings["port"]:
1538
server_settings["port"] = server_config.getint(u"DEFAULT",
2893
server_settings["port"] = server_config.getint("DEFAULT",
2895
if server_settings["socket"]:
2896
server_settings["socket"] = server_config.getint("DEFAULT",
2898
# Later, stdin will, and stdout and stderr might, be dup'ed
2899
# over with an opened os.devnull. But we don't want this to
2900
# happen with a supplied network socket.
2901
if 0 <= server_settings["socket"] <= 2:
2902
server_settings["socket"] = os.dup(server_settings
1540
2904
del server_config
1542
2906
# Override the settings from the config file with command line
1543
2907
# options, if set.
1544
for option in (u"interface", u"address", u"port", u"debug",
1545
u"priority", u"servicename", u"configdir",
1546
u"use_dbus", u"use_ipv6"):
2908
for option in ("interface", "address", "port", "debug",
2909
"priority", "servicename", "configdir", "use_dbus",
2910
"use_ipv6", "debuglevel", "restore", "statedir",
2911
"socket", "foreground", "zeroconf"):
1547
2912
value = getattr(options, option)
1548
2913
if value is not None:
1549
2914
server_settings[option] = value
1551
2916
# Force all strings to be unicode
1552
2917
for option in server_settings.keys():
1553
if type(server_settings[option]) is str:
1554
server_settings[option] = unicode(server_settings[option])
2918
if isinstance(server_settings[option], bytes):
2919
server_settings[option] = (server_settings[option]
2921
# Force all boolean options to be boolean
2922
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2923
"foreground", "zeroconf"):
2924
server_settings[option] = bool(server_settings[option])
2925
# Debug implies foreground
2926
if server_settings["debug"]:
2927
server_settings["foreground"] = True
1555
2928
# Now we have our good server settings in "server_settings"
1557
2930
##################################################################
2932
if (not server_settings["zeroconf"]
2933
and not (server_settings["port"]
2934
or server_settings["socket"] != "")):
2935
parser.error("Needs port or socket to work without Zeroconf")
1559
2937
# For convenience
1560
debug = server_settings[u"debug"]
1561
use_dbus = server_settings[u"use_dbus"]
1562
use_ipv6 = server_settings[u"use_ipv6"]
1565
syslogger.setLevel(logging.WARNING)
1566
console.setLevel(logging.WARNING)
1568
if server_settings[u"servicename"] != u"Mandos":
1569
syslogger.setFormatter(logging.Formatter
1570
(u'Mandos (%s) [%%(process)d]:'
1571
u' %%(levelname)s: %%(message)s'
1572
% server_settings[u"servicename"]))
2938
debug = server_settings["debug"]
2939
debuglevel = server_settings["debuglevel"]
2940
use_dbus = server_settings["use_dbus"]
2941
use_ipv6 = server_settings["use_ipv6"]
2942
stored_state_path = os.path.join(server_settings["statedir"],
2944
foreground = server_settings["foreground"]
2945
zeroconf = server_settings["zeroconf"]
2948
initlogger(debug, logging.DEBUG)
2953
level = getattr(logging, debuglevel.upper())
2954
initlogger(debug, level)
2956
if server_settings["servicename"] != "Mandos":
2957
syslogger.setFormatter(
2958
logging.Formatter('Mandos ({}) [%(process)d]:'
2959
' %(levelname)s: %(message)s'.format(
2960
server_settings["servicename"])))
1574
2962
# Parse config file with clients
1575
client_defaults = { u"timeout": u"1h",
1577
u"checker": u"fping -q -- %%(host)s",
1580
client_config = configparser.SafeConfigParser(client_defaults)
1581
client_config.read(os.path.join(server_settings[u"configdir"],
2963
client_config = configparser.SafeConfigParser(Client
2965
client_config.read(os.path.join(server_settings["configdir"],
1584
2968
global mandos_dbus_service
1585
2969
mandos_dbus_service = None
1587
tcp_server = MandosServer((server_settings[u"address"],
1588
server_settings[u"port"]),
1590
interface=server_settings[u"interface"],
1593
server_settings[u"priority"],
1595
pidfilename = u"/var/run/mandos.pid"
1597
pidfile = open(pidfilename, u"w")
1599
logger.error(u"Could not open file %r", pidfilename)
1602
uid = pwd.getpwnam(u"_mandos").pw_uid
1603
gid = pwd.getpwnam(u"_mandos").pw_gid
1606
uid = pwd.getpwnam(u"mandos").pw_uid
1607
gid = pwd.getpwnam(u"mandos").pw_gid
2972
if server_settings["socket"] != "":
2973
socketfd = server_settings["socket"]
2974
tcp_server = MandosServer(
2975
(server_settings["address"], server_settings["port"]),
2977
interface=(server_settings["interface"] or None),
2979
gnutls_priority=server_settings["priority"],
2983
pidfilename = "/run/mandos.pid"
2984
if not os.path.isdir("/run/."):
2985
pidfilename = "/var/run/mandos.pid"
2988
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2989
except IOError as e:
2990
logger.error("Could not open file %r", pidfilename,
2993
for name, group in (("_mandos", "_mandos"),
2994
("mandos", "mandos"),
2995
("nobody", "nogroup")):
2997
uid = pwd.getpwnam(name).pw_uid
2998
gid = pwd.getpwnam(group).pw_gid
1608
3000
except KeyError:
1610
uid = pwd.getpwnam(u"nobody").pw_uid
1611
gid = pwd.getpwnam(u"nobody").pw_gid
1618
except OSError, error:
1619
if error[0] != errno.EPERM:
1622
# Enable all possible GnuTLS debugging
3009
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3011
except OSError as error:
3012
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3013
.format(uid, gid, os.strerror(error.errno)))
3014
if error.errno != errno.EPERM:
3018
# Enable all possible GnuTLS debugging
1624
3020
# "Use a log level over 10 to enable all debugging options."
1625
3021
# - GnuTLS manual
1626
gnutls.library.functions.gnutls_global_set_log_level(11)
1628
@gnutls.library.types.gnutls_log_func
3022
gnutls.global_set_log_level(11)
1629
3025
def debug_gnutls(level, string):
1630
logger.debug(u"GnuTLS: %s", string[:-1])
1632
(gnutls.library.functions
1633
.gnutls_global_set_log_function(debug_gnutls))
3026
logger.debug("GnuTLS: %s", string[:-1])
3028
gnutls.global_set_log_function(debug_gnutls)
3030
# Redirect stdin so all checkers get /dev/null
3031
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3032
os.dup2(null, sys.stdin.fileno())
3036
# Need to fork before connecting to D-Bus
3038
# Close all input and output, do double fork, etc.
3041
# multiprocessing will use threads, so before we use GLib we need
3042
# to inform GLib that threads will be used.
1635
3045
global main_loop
1636
3046
# From the Avahi example code
1637
DBusGMainLoop(set_as_default=True )
1638
main_loop = gobject.MainLoop()
3047
DBusGMainLoop(set_as_default=True)
3048
main_loop = GLib.MainLoop()
1639
3049
bus = dbus.SystemBus()
1640
3050
# End of Avahi example code
1643
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1644
bus, do_not_queue=True)
1645
except dbus.exceptions.NameExistsException, e:
1646
logger.error(unicode(e) + u", disabling D-Bus")
3053
bus_name = dbus.service.BusName("se.recompile.Mandos",
3056
old_bus_name = dbus.service.BusName(
3057
"se.bsnet.fukt.Mandos", bus,
3059
except dbus.exceptions.DBusException as e:
3060
logger.error("Disabling D-Bus:", exc_info=e)
1647
3061
use_dbus = False
1648
server_settings[u"use_dbus"] = False
3062
server_settings["use_dbus"] = False
1649
3063
tcp_server.use_dbus = False
1650
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1651
service = AvahiService(name = server_settings[u"servicename"],
1652
servicetype = u"_mandos._tcp",
1653
protocol = protocol, bus = bus)
1654
if server_settings["interface"]:
1655
service.interface = (if_nametoindex
1656
(str(server_settings[u"interface"])))
3065
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3066
service = AvahiServiceToSyslog(
3067
name=server_settings["servicename"],
3068
servicetype="_mandos._tcp",
3071
if server_settings["interface"]:
3072
service.interface = if_nametoindex(
3073
server_settings["interface"].encode("utf-8"))
3075
global multiprocessing_manager
3076
multiprocessing_manager = multiprocessing.Manager()
1658
3078
client_class = Client
1660
client_class = functools.partial(ClientDBus, bus = bus)
1661
tcp_server.clients.update(set(
1662
client_class(name = section,
1663
config= dict(client_config.items(section)))
1664
for section in client_config.sections()))
3080
client_class = functools.partial(ClientDBus, bus=bus)
3082
client_settings = Client.config_parser(client_config)
3083
old_client_settings = {}
3086
# This is used to redirect stdout and stderr for checker processes
3088
wnull = open(os.devnull, "w") # A writable /dev/null
3089
# Only used if server is running in foreground but not in debug
3091
if debug or not foreground:
3094
# Get client data and settings from last running state.
3095
if server_settings["restore"]:
3097
with open(stored_state_path, "rb") as stored_state:
3098
if sys.version_info.major == 2:
3099
clients_data, old_client_settings = pickle.load(
3102
bytes_clients_data, bytes_old_client_settings = (
3103
pickle.load(stored_state, encoding="bytes"))
3104
# Fix bytes to strings
3107
clients_data = {(key.decode("utf-8")
3108
if isinstance(key, bytes)
3111
bytes_clients_data.items()}
3112
del bytes_clients_data
3113
for key in clients_data:
3114
value = {(k.decode("utf-8")
3115
if isinstance(k, bytes) else k): v
3117
clients_data[key].items()}
3118
clients_data[key] = value
3120
value["client_structure"] = [
3122
if isinstance(s, bytes)
3124
value["client_structure"]]
3126
for k in ("name", "host"):
3127
if isinstance(value[k], bytes):
3128
value[k] = value[k].decode("utf-8")
3129
# old_client_settings
3131
old_client_settings = {
3132
(key.decode("utf-8")
3133
if isinstance(key, bytes)
3136
bytes_old_client_settings.items()}
3137
del bytes_old_client_settings
3139
for value in old_client_settings.values():
3140
if isinstance(value["host"], bytes):
3141
value["host"] = (value["host"]
3143
os.remove(stored_state_path)
3144
except IOError as e:
3145
if e.errno == errno.ENOENT:
3146
logger.warning("Could not load persistent state:"
3147
" {}".format(os.strerror(e.errno)))
3149
logger.critical("Could not load persistent state:",
3152
except EOFError as e:
3153
logger.warning("Could not load persistent state: "
3157
with PGPEngine() as pgp:
3158
for client_name, client in clients_data.items():
3159
# Skip removed clients
3160
if client_name not in client_settings:
3163
# Decide which value to use after restoring saved state.
3164
# We have three different values: Old config file,
3165
# new config file, and saved state.
3166
# New config value takes precedence if it differs from old
3167
# config value, otherwise use saved state.
3168
for name, value in client_settings[client_name].items():
3170
# For each value in new config, check if it
3171
# differs from the old config value (Except for
3172
# the "secret" attribute)
3173
if (name != "secret"
3175
old_client_settings[client_name][name])):
3176
client[name] = value
3180
# Clients who has passed its expire date can still be
3181
# enabled if its last checker was successful. A Client
3182
# whose checker succeeded before we stored its state is
3183
# assumed to have successfully run all checkers during
3185
if client["enabled"]:
3186
if datetime.datetime.utcnow() >= client["expires"]:
3187
if not client["last_checked_ok"]:
3189
"disabling client {} - Client never "
3190
"performed a successful checker".format(
3192
client["enabled"] = False
3193
elif client["last_checker_status"] != 0:
3195
"disabling client {} - Client last"
3196
" checker failed with error code"
3199
client["last_checker_status"]))
3200
client["enabled"] = False
3202
client["expires"] = (
3203
datetime.datetime.utcnow()
3204
+ client["timeout"])
3205
logger.debug("Last checker succeeded,"
3206
" keeping {} enabled".format(
3209
client["secret"] = pgp.decrypt(
3210
client["encrypted_secret"],
3211
client_settings[client_name]["secret"])
3213
# If decryption fails, we use secret from new settings
3214
logger.debug("Failed to decrypt {} old secret".format(
3216
client["secret"] = (client_settings[client_name]
3219
# Add/remove clients based on new changes made to config
3220
for client_name in (set(old_client_settings)
3221
- set(client_settings)):
3222
del clients_data[client_name]
3223
for client_name in (set(client_settings)
3224
- set(old_client_settings)):
3225
clients_data[client_name] = client_settings[client_name]
3227
# Create all client objects
3228
for client_name, client in clients_data.items():
3229
tcp_server.clients[client_name] = client_class(
3232
server_settings=server_settings)
1665
3234
if not tcp_server.clients:
1666
logger.warning(u"No clients defined")
1669
# Redirect stdin so all checkers get /dev/null
1670
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1671
os.dup2(null, sys.stdin.fileno())
1675
# No console logging
1676
logger.removeHandler(console)
1677
# Close all input and output, do double fork, etc.
3235
logger.warning("No clients defined")
3238
if pidfile is not None:
1682
3239
pid = os.getpid()
1683
pidfile.write(str(pid) + "\n")
3242
print(pid, file=pidfile)
3244
logger.error("Could not write to file %r with PID %d",
1686
logger.error(u"Could not write to file %r with PID %d",
1689
# "pidfile" was never created
1694
signal.signal(signal.SIGINT, signal.SIG_IGN)
1695
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1696
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3249
for termsig in (signal.SIGHUP, signal.SIGTERM):
3250
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3251
lambda: main_loop.quit() and False)
1699
class MandosDBusService(dbus.service.Object):
3255
@alternate_dbus_interfaces(
3256
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3257
class MandosDBusService(DBusObjectWithObjectManager):
1700
3258
"""A D-Bus proxy object"""
1701
3260
def __init__(self):
1702
dbus.service.Object.__init__(self, bus, u"/")
1703
_interface = u"se.bsnet.fukt.Mandos"
1705
@dbus.service.signal(_interface, signature=u"o")
3261
dbus.service.Object.__init__(self, bus, "/")
3263
_interface = "se.recompile.Mandos"
3265
@dbus.service.signal(_interface, signature="o")
1706
3266
def ClientAdded(self, objpath):
1710
@dbus.service.signal(_interface, signature=u"ss")
3270
@dbus.service.signal(_interface, signature="ss")
1711
3271
def ClientNotFound(self, fingerprint, address):
1715
@dbus.service.signal(_interface, signature=u"os")
3275
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3277
@dbus.service.signal(_interface, signature="os")
1716
3278
def ClientRemoved(self, objpath, name):
1720
@dbus.service.method(_interface, out_signature=u"ao")
3282
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3284
@dbus.service.method(_interface, out_signature="ao")
1721
3285
def GetAllClients(self):
1723
return dbus.Array(c.dbus_object_path
1724
for c in tcp_server.clients)
3287
return dbus.Array(c.dbus_object_path for c in
3288
tcp_server.clients.values())
3290
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1726
3292
@dbus.service.method(_interface,
1727
out_signature=u"a{oa{sv}}")
3293
out_signature="a{oa{sv}}")
1728
3294
def GetAllClientsWithProperties(self):
1730
3296
return dbus.Dictionary(
1731
((c.dbus_object_path, c.GetAll(u""))
1732
for c in tcp_server.clients),
1733
signature=u"oa{sv}")
1735
@dbus.service.method(_interface, in_signature=u"o")
3297
{c.dbus_object_path: c.GetAll(
3298
"se.recompile.Mandos.Client")
3299
for c in tcp_server.clients.values()},
3302
@dbus.service.method(_interface, in_signature="o")
1736
3303
def RemoveClient(self, object_path):
1738
for c in tcp_server.clients:
3305
for c in tcp_server.clients.values():
1739
3306
if c.dbus_object_path == object_path:
1740
tcp_server.clients.remove(c)
3307
del tcp_server.clients[c.name]
1741
3308
c.remove_from_connection()
1742
# Don't signal anything except ClientRemoved
3309
# Don't signal the disabling
1743
3310
c.disable(quiet=True)
1745
self.ClientRemoved(object_path, c.name)
3311
# Emit D-Bus signal for removal
3312
self.client_removed_signal(c)
1747
3314
raise KeyError(object_path)
3318
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3319
out_signature="a{oa{sa{sv}}}")
3320
def GetManagedObjects(self):
3322
return dbus.Dictionary(
3323
{client.dbus_object_path:
3325
{interface: client.GetAll(interface)
3327
client._get_all_interface_names()})
3328
for client in tcp_server.clients.values()})
3330
def client_added_signal(self, client):
3331
"""Send the new standard signal and the old signal"""
3333
# New standard signal
3334
self.InterfacesAdded(
3335
client.dbus_object_path,
3337
{interface: client.GetAll(interface)
3339
client._get_all_interface_names()}))
3341
self.ClientAdded(client.dbus_object_path)
3343
def client_removed_signal(self, client):
3344
"""Send the new standard signal and the old signal"""
3346
# New standard signal
3347
self.InterfacesRemoved(
3348
client.dbus_object_path,
3349
client._get_all_interface_names())
3351
self.ClientRemoved(client.dbus_object_path,
1751
3354
mandos_dbus_service = MandosDBusService()
3356
# Save modules to variables to exempt the modules from being
3357
# unloaded before the function registered with atexit() is run.
3358
mp = multiprocessing
1754
3362
"Cleanup function; run on exit"
3366
mp.active_children()
3368
if not (tcp_server.clients or client_settings):
3371
# Store client before exiting. Secrets are encrypted with key
3372
# based on what config file has. If config file is
3373
# removed/edited, old secret will thus be unrecovable.
3375
with PGPEngine() as pgp:
3376
for client in tcp_server.clients.values():
3377
key = client_settings[client.name]["secret"]
3378
client.encrypted_secret = pgp.encrypt(client.secret,
3382
# A list of attributes that can not be pickled
3384
exclude = {"bus", "changedstate", "secret",
3385
"checker", "server_settings"}
3386
for name, typ in inspect.getmembers(dbus.service
3390
client_dict["encrypted_secret"] = (client
3392
for attr in client.client_structure:
3393
if attr not in exclude:
3394
client_dict[attr] = getattr(client, attr)
3396
clients[client.name] = client_dict
3397
del client_settings[client.name]["secret"]
3400
with tempfile.NamedTemporaryFile(
3404
dir=os.path.dirname(stored_state_path),
3405
delete=False) as stored_state:
3406
pickle.dump((clients, client_settings), stored_state,
3408
tempname = stored_state.name
3409
os.rename(tempname, stored_state_path)
3410
except (IOError, OSError) as e:
3416
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3417
logger.warning("Could not save persistent state: {}"
3418
.format(os.strerror(e.errno)))
3420
logger.warning("Could not save persistent state:",
3424
# Delete all clients, and settings from config
1757
3425
while tcp_server.clients:
1758
client = tcp_server.clients.pop()
3426
name, client = tcp_server.clients.popitem()
1760
3428
client.remove_from_connection()
1761
client.disable_hook = None
1762
# Don't signal anything except ClientRemoved
3429
# Don't signal the disabling
1763
3430
client.disable(quiet=True)
3431
# Emit D-Bus signal for removal
1766
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3433
mandos_dbus_service.client_removed_signal(client)
3434
client_settings.clear()
1769
3436
atexit.register(cleanup)
1771
for client in tcp_server.clients:
3438
for client in tcp_server.clients.values():
1774
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3440
# Emit D-Bus signal for adding
3441
mandos_dbus_service.client_added_signal(client)
3442
# Need to initiate checking of clients
3444
client.init_checker()
1777
3446
tcp_server.enable()
1778
3447
tcp_server.server_activate()
1780
3449
# Find out what port we got
1781
service.port = tcp_server.socket.getsockname()[1]
3451
service.port = tcp_server.socket.getsockname()[1]
1783
logger.info(u"Now listening on address %r, port %d,"
1784
" flowinfo %d, scope_id %d"
1785
% tcp_server.socket.getsockname())
3453
logger.info("Now listening on address %r, port %d,"
3454
" flowinfo %d, scope_id %d",
3455
*tcp_server.socket.getsockname())
1787
logger.info(u"Now listening on address %r, port %d"
1788
% tcp_server.socket.getsockname())
1790
#service.interface = tcp_server.socket.getsockname()[3]
3457
logger.info("Now listening on address %r, port %d",
3458
*tcp_server.socket.getsockname())
3460
# service.interface = tcp_server.socket.getsockname()[3]
1793
# From the Avahi example code
1796
except dbus.exceptions.DBusException, error:
1797
logger.critical(u"DBusException: %s", error)
1800
# End of Avahi example code
1802
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1803
lambda *args, **kwargs:
1804
(tcp_server.handle_request
1805
(*args[2:], **kwargs) or True))
1807
logger.debug(u"Starting main loop")
3464
# From the Avahi example code
3467
except dbus.exceptions.DBusException as error:
3468
logger.critical("D-Bus Exception", exc_info=error)
3471
# End of Avahi example code
3473
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3474
lambda *args, **kwargs:
3475
(tcp_server.handle_request
3476
(*args[2:], **kwargs) or True))
3478
logger.debug("Starting main loop")
1808
3479
main_loop.run()
1809
except AvahiError, error:
1810
logger.critical(u"AvahiError: %s", error)
3480
except AvahiError as error:
3481
logger.critical("Avahi Error", exc_info=error)
1813
3484
except KeyboardInterrupt:
1816
logger.debug(u"Server received KeyboardInterrupt")
1817
logger.debug(u"Server exiting")
3486
print("", file=sys.stderr)
3487
logger.debug("Server received KeyboardInterrupt")
3488
logger.debug("Server exiting")
1818
3489
# Must run before the D-Bus bus name gets deregistered
1821
3493
if __name__ == '__main__':