167
225
os.rmdir(self.tempdir)
168
226
self.tempdir = None
170
228
def password_encode(self, password):
171
229
# Passphrase can not be empty and can not contain newlines or
172
230
# NUL bytes. So we prefix it and hex encode it.
173
return b"mandos" + binascii.hexlify(password)
231
encoded = b"mandos" + binascii.hexlify(password)
232
if len(encoded) > 2048:
233
# GnuPG can't handle long passwords, so encode differently
234
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
235
.replace(b"\n", b"\\n")
236
.replace(b"\0", b"\\x00"))
175
239
def encrypt(self, data, password):
176
self.gnupg.passphrase = self.password_encode(password)
177
with open(os.devnull) as devnull:
179
proc = self.gnupg.run(['--symmetric'],
180
create_fhs=['stdin', 'stdout'],
181
attach_fhs={'stderr': devnull})
182
with contextlib.closing(proc.handles['stdin']) as f:
184
with contextlib.closing(proc.handles['stdout']) as f:
185
ciphertext = f.read()
189
self.gnupg.passphrase = None
240
passphrase = self.password_encode(password)
241
with tempfile.NamedTemporaryFile(
242
dir=self.tempdir) as passfile:
243
passfile.write(passphrase)
245
proc = subprocess.Popen([self.gpg, '--symmetric',
249
stdin=subprocess.PIPE,
250
stdout=subprocess.PIPE,
251
stderr=subprocess.PIPE)
252
ciphertext, err = proc.communicate(input=data)
253
if proc.returncode != 0:
190
255
return ciphertext
192
257
def decrypt(self, data, password):
193
self.gnupg.passphrase = self.password_encode(password)
194
with open(os.devnull) as devnull:
196
proc = self.gnupg.run(['--decrypt'],
197
create_fhs=['stdin', 'stdout'],
198
attach_fhs={'stderr': devnull})
199
with contextlib.closing(proc.handles['stdin'] ) as f:
201
with contextlib.closing(proc.handles['stdout']) as f:
202
decrypted_plaintext = f.read()
206
self.gnupg.passphrase = None
258
passphrase = self.password_encode(password)
259
with tempfile.NamedTemporaryFile(
260
dir=self.tempdir) as passfile:
261
passfile.write(passphrase)
263
proc = subprocess.Popen([self.gpg, '--decrypt',
267
stdin=subprocess.PIPE,
268
stdout=subprocess.PIPE,
269
stderr=subprocess.PIPE)
270
decrypted_plaintext, err = proc.communicate(input=data)
271
if proc.returncode != 0:
207
273
return decrypted_plaintext
276
# Pretend that we have an Avahi module
278
"""This isn't so much a class as it is a module-like namespace.
279
It is instantiated once, and simulates having an Avahi module."""
280
IF_UNSPEC = -1 # avahi-common/address.h
281
PROTO_UNSPEC = -1 # avahi-common/address.h
282
PROTO_INET = 0 # avahi-common/address.h
283
PROTO_INET6 = 1 # avahi-common/address.h
284
DBUS_NAME = "org.freedesktop.Avahi"
285
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
286
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
287
DBUS_PATH_SERVER = "/"
289
def string_array_to_txt_array(self, t):
290
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
291
for s in t), signature="ay")
292
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
293
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
294
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
295
SERVER_INVALID = 0 # avahi-common/defs.h
296
SERVER_REGISTERING = 1 # avahi-common/defs.h
297
SERVER_RUNNING = 2 # avahi-common/defs.h
298
SERVER_COLLISION = 3 # avahi-common/defs.h
299
SERVER_FAILURE = 4 # avahi-common/defs.h
211
303
class AvahiError(Exception):
212
304
def __init__(self, value, *args, **kwargs):
213
305
self.value = value
214
super(AvahiError, self).__init__(value, *args, **kwargs)
215
def __unicode__(self):
216
return unicode(repr(self.value))
306
return super(AvahiError, self).__init__(value, *args,
218
310
class AvahiServiceError(AvahiError):
221
314
class AvahiGroupError(AvahiError):
225
318
class AvahiService(object):
226
319
"""An Avahi (Zeroconf) service.
229
322
interface: integer; avahi.IF_UNSPEC or an interface index.
230
323
Used to optionally bind to the specified interface.
231
324
name: string; Example: 'Mandos'
232
325
type: string; Example: '_mandos._tcp'.
233
See <http://www.dns-sd.org/ServiceTypes.html>
326
See <https://www.iana.org/assignments/service-names-port-numbers>
234
327
port: integer; what port to announce
235
328
TXT: list of strings; TXT record for the service
236
329
domain: string; Domain to publish on, default to .local if empty.
365
488
follow_name_owner_changes=True),
366
489
avahi.DBUS_INTERFACE_SERVER)
367
490
self.server.connect_to_signal("StateChanged",
368
self.server_state_changed)
491
self.server_state_changed)
369
492
self.server_state_changed(self.server.GetState())
371
495
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
373
497
"""Add the new name to the syslog messages"""
374
ret = AvahiService.rename(self)
375
syslogger.setFormatter(logging.Formatter
376
('Mandos (%s) [%%(process)d]:'
377
' %%(levelname)s: %%(message)s'
498
ret = AvahiService.rename(self, *args, **kwargs)
499
syslogger.setFormatter(logging.Formatter(
500
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
381
def timedelta_to_milliseconds(td):
382
"Convert a datetime.timedelta() to milliseconds"
383
return ((td.days * 24 * 60 * 60 * 1000)
384
+ (td.seconds * 1000)
385
+ (td.microseconds // 1000))
505
# Pretend that we have a GnuTLS module
506
class GnuTLS(object):
507
"""This isn't so much a class as it is a module-like namespace.
508
It is instantiated once, and simulates having a GnuTLS module."""
510
library = ctypes.util.find_library("gnutls")
512
library = ctypes.util.find_library("gnutls-deb0")
513
_library = ctypes.cdll.LoadLibrary(library)
515
_need_version = b"3.3.0"
518
# Need to use class name "GnuTLS" here, since this method is
519
# called before the assignment to the "gnutls" global variable
521
if GnuTLS.check_version(self._need_version) is None:
522
raise GnuTLS.Error("Needs GnuTLS {} or later"
523
.format(self._need_version))
525
# Unless otherwise indicated, the constants and types below are
526
# all from the gnutls/gnutls.h C header file.
536
E_NO_CERTIFICATE_FOUND = -49
537
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
540
class session_int(ctypes.Structure):
542
session_t = ctypes.POINTER(session_int)
544
class certificate_credentials_st(ctypes.Structure):
546
certificate_credentials_t = ctypes.POINTER(
547
certificate_credentials_st)
548
certificate_type_t = ctypes.c_int
550
class datum_t(ctypes.Structure):
551
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
552
('size', ctypes.c_uint)]
554
class openpgp_crt_int(ctypes.Structure):
556
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
557
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
558
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
559
credentials_type_t = ctypes.c_int
560
transport_ptr_t = ctypes.c_void_p
561
close_request_t = ctypes.c_int
564
class Error(Exception):
565
# We need to use the class name "GnuTLS" here, since this
566
# exception might be raised from within GnuTLS.__init__,
567
# which is called before the assignment to the "gnutls"
568
# global variable has happened.
569
def __init__(self, message=None, code=None, args=()):
570
# Default usage is by a message string, but if a return
571
# code is passed, convert it to a string with
574
if message is None and code is not None:
575
message = GnuTLS.strerror(code)
576
return super(GnuTLS.Error, self).__init__(
579
class CertificateSecurityError(Error):
583
class Credentials(object):
585
self._c_object = gnutls.certificate_credentials_t()
586
gnutls.certificate_allocate_credentials(
587
ctypes.byref(self._c_object))
588
self.type = gnutls.CRD_CERTIFICATE
591
gnutls.certificate_free_credentials(self._c_object)
593
class ClientSession(object):
594
def __init__(self, socket, credentials=None):
595
self._c_object = gnutls.session_t()
596
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
597
gnutls.set_default_priority(self._c_object)
598
gnutls.transport_set_ptr(self._c_object, socket.fileno())
599
gnutls.handshake_set_private_extensions(self._c_object,
602
if credentials is None:
603
credentials = gnutls.Credentials()
604
gnutls.credentials_set(self._c_object, credentials.type,
605
ctypes.cast(credentials._c_object,
607
self.credentials = credentials
610
gnutls.deinit(self._c_object)
613
return gnutls.handshake(self._c_object)
615
def send(self, data):
619
data_len -= gnutls.record_send(self._c_object,
624
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
626
# Error handling functions
627
def _error_code(result):
628
"""A function to raise exceptions on errors, suitable
629
for the 'restype' attribute on ctypes functions"""
632
if result == gnutls.E_NO_CERTIFICATE_FOUND:
633
raise gnutls.CertificateSecurityError(code=result)
634
raise gnutls.Error(code=result)
636
def _retry_on_error(result, func, arguments):
637
"""A function to retry on some errors, suitable
638
for the 'errcheck' attribute on ctypes functions"""
640
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
641
return _error_code(result)
642
result = func(*arguments)
645
# Unless otherwise indicated, the function declarations below are
646
# all from the gnutls/gnutls.h C header file.
649
priority_set_direct = _library.gnutls_priority_set_direct
650
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
651
ctypes.POINTER(ctypes.c_char_p)]
652
priority_set_direct.restype = _error_code
654
init = _library.gnutls_init
655
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
656
init.restype = _error_code
658
set_default_priority = _library.gnutls_set_default_priority
659
set_default_priority.argtypes = [session_t]
660
set_default_priority.restype = _error_code
662
record_send = _library.gnutls_record_send
663
record_send.argtypes = [session_t, ctypes.c_void_p,
665
record_send.restype = ctypes.c_ssize_t
666
record_send.errcheck = _retry_on_error
668
certificate_allocate_credentials = (
669
_library.gnutls_certificate_allocate_credentials)
670
certificate_allocate_credentials.argtypes = [
671
ctypes.POINTER(certificate_credentials_t)]
672
certificate_allocate_credentials.restype = _error_code
674
certificate_free_credentials = (
675
_library.gnutls_certificate_free_credentials)
676
certificate_free_credentials.argtypes = [
677
certificate_credentials_t]
678
certificate_free_credentials.restype = None
680
handshake_set_private_extensions = (
681
_library.gnutls_handshake_set_private_extensions)
682
handshake_set_private_extensions.argtypes = [session_t,
684
handshake_set_private_extensions.restype = None
686
credentials_set = _library.gnutls_credentials_set
687
credentials_set.argtypes = [session_t, credentials_type_t,
689
credentials_set.restype = _error_code
691
strerror = _library.gnutls_strerror
692
strerror.argtypes = [ctypes.c_int]
693
strerror.restype = ctypes.c_char_p
695
certificate_type_get = _library.gnutls_certificate_type_get
696
certificate_type_get.argtypes = [session_t]
697
certificate_type_get.restype = _error_code
699
certificate_get_peers = _library.gnutls_certificate_get_peers
700
certificate_get_peers.argtypes = [session_t,
701
ctypes.POINTER(ctypes.c_uint)]
702
certificate_get_peers.restype = ctypes.POINTER(datum_t)
704
global_set_log_level = _library.gnutls_global_set_log_level
705
global_set_log_level.argtypes = [ctypes.c_int]
706
global_set_log_level.restype = None
708
global_set_log_function = _library.gnutls_global_set_log_function
709
global_set_log_function.argtypes = [log_func]
710
global_set_log_function.restype = None
712
deinit = _library.gnutls_deinit
713
deinit.argtypes = [session_t]
714
deinit.restype = None
716
handshake = _library.gnutls_handshake
717
handshake.argtypes = [session_t]
718
handshake.restype = _error_code
719
handshake.errcheck = _retry_on_error
721
transport_set_ptr = _library.gnutls_transport_set_ptr
722
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
723
transport_set_ptr.restype = None
725
bye = _library.gnutls_bye
726
bye.argtypes = [session_t, close_request_t]
727
bye.restype = _error_code
728
bye.errcheck = _retry_on_error
730
check_version = _library.gnutls_check_version
731
check_version.argtypes = [ctypes.c_char_p]
732
check_version.restype = ctypes.c_char_p
734
# All the function declarations below are from gnutls/openpgp.h
736
openpgp_crt_init = _library.gnutls_openpgp_crt_init
737
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
738
openpgp_crt_init.restype = _error_code
740
openpgp_crt_import = _library.gnutls_openpgp_crt_import
741
openpgp_crt_import.argtypes = [openpgp_crt_t,
742
ctypes.POINTER(datum_t),
744
openpgp_crt_import.restype = _error_code
746
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
747
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
748
ctypes.POINTER(ctypes.c_uint)]
749
openpgp_crt_verify_self.restype = _error_code
751
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
752
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
753
openpgp_crt_deinit.restype = None
755
openpgp_crt_get_fingerprint = (
756
_library.gnutls_openpgp_crt_get_fingerprint)
757
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
761
openpgp_crt_get_fingerprint.restype = _error_code
763
# Remove non-public functions
764
del _error_code, _retry_on_error
765
# Create the global "gnutls" object, simulating a module
769
def call_pipe(connection, # : multiprocessing.Connection
770
func, *args, **kwargs):
771
"""This function is meant to be called by multiprocessing.Process
773
This function runs func(*args, **kwargs), and writes the resulting
774
return value on the provided multiprocessing.Connection.
776
connection.send(func(*args, **kwargs))
387
780
class Client(object):
388
781
"""A representation of a client host served by this server.
391
784
approved: bool(); 'None' if not yet approved/disapproved
392
785
approval_delay: datetime.timedelta(); Time to wait for approval
412
805
interval: datetime.timedelta(); How often to start a new checker
413
806
last_approval_request: datetime.datetime(); (UTC) or None
414
807
last_checked_ok: datetime.datetime(); (UTC) or None
416
808
last_checker_status: integer between 0 and 255 reflecting exit
417
809
status of last checker. -1 reflects crashed
810
checker, -2 means no checker completed yet.
811
last_checker_signal: The signal which killed the last checker, if
812
last_checker_status is -1
419
813
last_enabled: datetime.datetime(); (UTC) or None
420
814
name: string; from the config file, used in log messages and
421
815
D-Bus identifiers
422
816
secret: bytestring; sent verbatim (over TLS) to client
423
817
timeout: datetime.timedelta(); How long from last_checked_ok
424
818
until this client is disabled
425
extended_timeout: extra long timeout when password has been sent
819
extended_timeout: extra long timeout when secret has been sent
426
820
runtime_expansions: Allowed attributes for runtime expansion.
427
821
expires: datetime.datetime(); time (UTC) when a client will be
428
822
disabled, or None
823
server_settings: The server_settings dict from main()
431
826
runtime_expansions = ("approval_delay", "approval_duration",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
827
"created", "enabled", "expires",
828
"fingerprint", "host", "interval",
829
"last_approval_request", "last_checked_ok",
434
830
"last_enabled", "name", "timeout")
436
def timeout_milliseconds(self):
437
"Return the 'timeout' attribute in milliseconds"
438
return timedelta_to_milliseconds(self.timeout)
440
def extended_timeout_milliseconds(self):
441
"Return the 'extended_timeout' attribute in milliseconds"
442
return timedelta_to_milliseconds(self.extended_timeout)
444
def interval_milliseconds(self):
445
"Return the 'interval' attribute in milliseconds"
446
return timedelta_to_milliseconds(self.interval)
448
def approval_delay_milliseconds(self):
449
return timedelta_to_milliseconds(self.approval_delay)
451
def __init__(self, name = None, config=None):
452
"""Note: the 'checker' key in 'config' sets the
453
'checker_command' attribute and *not* the 'checker'
833
"extended_timeout": "PT15M",
835
"checker": "fping -q -- %%(host)s",
837
"approval_delay": "PT0S",
838
"approval_duration": "PT1S",
839
"approved_by_default": "True",
844
def config_parser(config):
845
"""Construct a new dict of client settings of this form:
846
{ client_name: {setting_name: value, ...}, ...}
847
with exceptions for any special settings as defined above.
848
NOTE: Must be a pure function. Must return the same result
849
value given the same arguments.
852
for client_name in config.sections():
853
section = dict(config.items(client_name))
854
client = settings[client_name] = {}
856
client["host"] = section["host"]
857
# Reformat values from string types to Python types
858
client["approved_by_default"] = config.getboolean(
859
client_name, "approved_by_default")
860
client["enabled"] = config.getboolean(client_name,
863
# Uppercase and remove spaces from fingerprint for later
864
# comparison purposes with return value from the
865
# fingerprint() function
866
client["fingerprint"] = (section["fingerprint"].upper()
868
if "secret" in section:
869
client["secret"] = codecs.decode(section["secret"]
872
elif "secfile" in section:
873
with open(os.path.expanduser(os.path.expandvars
874
(section["secfile"])),
876
client["secret"] = secfile.read()
878
raise TypeError("No secret or secfile for section {}"
880
client["timeout"] = string_to_delta(section["timeout"])
881
client["extended_timeout"] = string_to_delta(
882
section["extended_timeout"])
883
client["interval"] = string_to_delta(section["interval"])
884
client["approval_delay"] = string_to_delta(
885
section["approval_delay"])
886
client["approval_duration"] = string_to_delta(
887
section["approval_duration"])
888
client["checker_command"] = section["checker"]
889
client["last_approval_request"] = None
890
client["last_checked_ok"] = None
891
client["last_checker_status"] = -2
895
def __init__(self, settings, name=None, server_settings=None):
897
if server_settings is None:
899
self.server_settings = server_settings
900
# adding all client settings
901
for setting, value in settings.items():
902
setattr(self, setting, value)
905
if not hasattr(self, "last_enabled"):
906
self.last_enabled = datetime.datetime.utcnow()
907
if not hasattr(self, "expires"):
908
self.expires = (datetime.datetime.utcnow()
911
self.last_enabled = None
458
914
logger.debug("Creating client %r", self.name)
459
# Uppercase and remove spaces from fingerprint for later
460
# comparison purposes with return value from the fingerprint()
462
self.fingerprint = (config["fingerprint"].upper()
464
915
logger.debug(" Fingerprint: %s", self.fingerprint)
465
if "secret" in config:
466
self.secret = config["secret"].decode("base64")
467
elif "secfile" in config:
468
with open(os.path.expanduser(os.path.expandvars
469
(config["secfile"])),
471
self.secret = secfile.read()
473
raise TypeError("No secret or secfile for client %s"
475
self.host = config.get("host", "")
476
self.created = datetime.datetime.utcnow()
477
self.enabled = config.get("enabled", True)
478
self.last_approval_request = None
480
self.last_enabled = datetime.datetime.utcnow()
482
self.last_enabled = None
483
self.last_checked_ok = None
484
self.last_checker_status = None
485
self.timeout = string_to_delta(config["timeout"])
486
self.extended_timeout = string_to_delta(config
487
["extended_timeout"])
488
self.interval = string_to_delta(config["interval"])
916
self.created = settings.get("created",
917
datetime.datetime.utcnow())
919
# attributes specific for this server instance
489
920
self.checker = None
490
921
self.checker_initiator_tag = None
491
922
self.disable_initiator_tag = None
493
self.expires = datetime.datetime.utcnow() + self.timeout
496
923
self.checker_callback_tag = None
497
self.checker_command = config["checker"]
498
924
self.current_checker_command = None
499
925
self.approved = None
500
self.approved_by_default = config.get("approved_by_default",
502
926
self.approvals_pending = 0
503
self.approval_delay = string_to_delta(
504
config["approval_delay"])
505
self.approval_duration = string_to_delta(
506
config["approval_duration"])
507
self.changedstate = (multiprocessing_manager
508
.Condition(multiprocessing_manager
510
self.client_structure = [attr for attr in
511
self.__dict__.iterkeys()
927
self.changedstate = multiprocessing_manager.Condition(
928
multiprocessing_manager.Lock())
929
self.client_structure = [attr
930
for attr in self.__dict__.keys()
512
931
if not attr.startswith("_")]
513
932
self.client_structure.append("client_structure")
515
for name, t in inspect.getmembers(type(self),
934
for name, t in inspect.getmembers(
935
type(self), lambda obj: isinstance(obj, property)):
519
936
if not name.startswith("_"):
520
937
self.client_structure.append(name)
522
939
# Send notice to process children that client state has changed
523
940
def send_changedstate(self):
524
941
with self.changedstate:
525
942
self.changedstate.notify_all()
527
944
def enable(self):
528
945
"""Start this client's checker and timeout hooks"""
529
946
if getattr(self, "enabled", False):
530
947
# Already enabled
532
self.send_changedstate()
533
949
self.expires = datetime.datetime.utcnow() + self.timeout
534
950
self.enabled = True
535
951
self.last_enabled = datetime.datetime.utcnow()
536
952
self.init_checker()
953
self.send_changedstate()
538
955
def disable(self, quiet=True):
539
956
"""Disable this client."""
540
957
if not getattr(self, "enabled", False):
543
self.send_changedstate()
545
960
logger.info("Disabling client %s", self.name)
546
if getattr(self, "disable_initiator_tag", False):
547
gobject.source_remove(self.disable_initiator_tag)
961
if getattr(self, "disable_initiator_tag", None) is not None:
962
GLib.source_remove(self.disable_initiator_tag)
548
963
self.disable_initiator_tag = None
549
964
self.expires = None
550
if getattr(self, "checker_initiator_tag", False):
551
gobject.source_remove(self.checker_initiator_tag)
965
if getattr(self, "checker_initiator_tag", None) is not None:
966
GLib.source_remove(self.checker_initiator_tag)
552
967
self.checker_initiator_tag = None
553
968
self.stop_checker()
554
969
self.enabled = False
555
# Do not run this again if called by a gobject.timeout_add
971
self.send_changedstate()
972
# Do not run this again if called by a GLib.timeout_add
558
975
def __del__(self):
561
978
def init_checker(self):
562
979
# Schedule a new checker to be started an 'interval' from now,
563
980
# and every interval from then on.
564
self.checker_initiator_tag = (gobject.timeout_add
565
(self.interval_milliseconds(),
981
if self.checker_initiator_tag is not None:
982
GLib.source_remove(self.checker_initiator_tag)
983
self.checker_initiator_tag = GLib.timeout_add(
984
int(self.interval.total_seconds() * 1000),
567
986
# Schedule a disable() when 'timeout' has passed
568
self.disable_initiator_tag = (gobject.timeout_add
569
(self.timeout_milliseconds(),
987
if self.disable_initiator_tag is not None:
988
GLib.source_remove(self.disable_initiator_tag)
989
self.disable_initiator_tag = GLib.timeout_add(
990
int(self.timeout.total_seconds() * 1000), self.disable)
571
991
# Also start a new checker *right now*.
572
992
self.start_checker()
574
def checker_callback(self, pid, condition, command):
994
def checker_callback(self, source, condition, connection,
575
996
"""The checker has completed, so take appropriate actions."""
576
997
self.checker_callback_tag = None
577
998
self.checker = None
578
if os.WIFEXITED(condition):
579
self.last_checker_status = os.WEXITSTATUS(condition)
999
# Read return code from connection (see call_pipe)
1000
returncode = connection.recv()
1004
self.last_checker_status = returncode
1005
self.last_checker_signal = None
580
1006
if self.last_checker_status == 0:
581
1007
logger.info("Checker for %(name)s succeeded",
583
1009
self.checked_ok()
585
logger.info("Checker for %(name)s failed",
1011
logger.info("Checker for %(name)s failed", vars(self))
588
1013
self.last_checker_status = -1
1014
self.last_checker_signal = -returncode
589
1015
logger.warning("Checker for %(name)s crashed?",
592
def checked_ok(self, timeout=None):
593
"""Bump up the timeout for this client.
595
This should only be called when the client has been seen,
1019
def checked_ok(self):
1020
"""Assert that the client has been seen, alive and well."""
1021
self.last_checked_ok = datetime.datetime.utcnow()
1022
self.last_checker_status = 0
1023
self.last_checker_signal = None
1026
def bump_timeout(self, timeout=None):
1027
"""Bump up the timeout for this client."""
598
1028
if timeout is None:
599
1029
timeout = self.timeout
600
self.last_checked_ok = datetime.datetime.utcnow()
601
1030
if self.disable_initiator_tag is not None:
602
gobject.source_remove(self.disable_initiator_tag)
1031
GLib.source_remove(self.disable_initiator_tag)
1032
self.disable_initiator_tag = None
603
1033
if getattr(self, "enabled", False):
604
self.disable_initiator_tag = (gobject.timeout_add
605
(timedelta_to_milliseconds
606
(timeout), self.disable))
1034
self.disable_initiator_tag = GLib.timeout_add(
1035
int(timeout.total_seconds() * 1000), self.disable)
607
1036
self.expires = datetime.datetime.utcnow() + timeout
609
1038
def need_approval(self):
610
1039
self.last_approval_request = datetime.datetime.utcnow()
612
1041
def start_checker(self):
613
1042
"""Start a new checker subprocess if one is not running.
615
1044
If a checker already exists, leave it running and do
617
1046
# The reason for not killing a running checker is that if we
618
# did that, then if a checker (for some reason) started
619
# running slowly and taking more than 'interval' time, the
620
# client would inevitably timeout, since no checker would get
621
# a chance to run to completion. If we instead leave running
1047
# did that, and if a checker (for some reason) started running
1048
# slowly and taking more than 'interval' time, then the client
1049
# would inevitably timeout, since no checker would get a
1050
# chance to run to completion. If we instead leave running
622
1051
# checkers alone, the checker would have to take more time
623
1052
# than 'timeout' for the client to be disabled, which is as it
626
# If a checker exists, make sure it is not a zombie
628
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
629
except (AttributeError, OSError) as error:
630
if (isinstance(error, OSError)
631
and error.errno != errno.ECHILD):
635
logger.warning("Checker was a zombie")
636
gobject.source_remove(self.checker_callback_tag)
637
self.checker_callback(pid, status,
638
self.current_checker_command)
1055
if self.checker is not None and not self.checker.is_alive():
1056
logger.warning("Checker was not alive; joining")
639
1059
# Start a new checker if needed
640
1060
if self.checker is None:
1061
# Escape attributes for the shell
1063
attr: re.escape(str(getattr(self, attr)))
1064
for attr in self.runtime_expansions}
642
# In case checker_command has exactly one % operator
643
command = self.checker_command % self.host
645
# Escape attributes for the shell
646
escaped_attrs = dict(
648
re.escape(unicode(str(getattr(self, attr, "")),
652
self.runtime_expansions)
655
command = self.checker_command % escaped_attrs
656
except TypeError as error:
657
logger.error('Could not format string "%s":'
658
' %s', self.checker_command, error)
659
return True # Try again later
1066
command = self.checker_command % escaped_attrs
1067
except TypeError as error:
1068
logger.error('Could not format string "%s"',
1069
self.checker_command,
1071
return True # Try again later
660
1072
self.current_checker_command = command
662
logger.info("Starting checker %r for %s",
664
# We don't need to redirect stdout and stderr, since
665
# in normal mode, that is already done by daemon(),
666
# and in debug mode we don't want to. (Stdin is
667
# always replaced by /dev/null.)
668
self.checker = subprocess.Popen(command,
671
self.checker_callback_tag = (gobject.child_watch_add
673
self.checker_callback,
675
# The checker may have completed before the gobject
676
# watch was added. Check for this.
677
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
679
gobject.source_remove(self.checker_callback_tag)
680
self.checker_callback(pid, status, command)
681
except OSError as error:
682
logger.error("Failed to start subprocess: %s",
684
# Re-run this periodically if run by gobject.timeout_add
1073
logger.info("Starting checker %r for %s", command,
1075
# We don't need to redirect stdout and stderr, since
1076
# in normal mode, that is already done by daemon(),
1077
# and in debug mode we don't want to. (Stdin is
1078
# always replaced by /dev/null.)
1079
# The exception is when not debugging but nevertheless
1080
# running in the foreground; use the previously
1082
popen_args = {"close_fds": True,
1085
if (not self.server_settings["debug"]
1086
and self.server_settings["foreground"]):
1087
popen_args.update({"stdout": wnull,
1089
pipe = multiprocessing.Pipe(duplex=False)
1090
self.checker = multiprocessing.Process(
1092
args=(pipe[1], subprocess.call, command),
1094
self.checker.start()
1095
self.checker_callback_tag = GLib.io_add_watch(
1096
pipe[0].fileno(), GLib.IO_IN,
1097
self.checker_callback, pipe[0], command)
1098
# Re-run this periodically if run by GLib.timeout_add
687
1101
def stop_checker(self):
688
1102
"""Force the checker process, if any, to stop."""
689
1103
if self.checker_callback_tag:
690
gobject.source_remove(self.checker_callback_tag)
1104
GLib.source_remove(self.checker_callback_tag)
691
1105
self.checker_callback_tag = None
692
1106
if getattr(self, "checker", None) is None:
694
1108
logger.debug("Stopping checker for %(name)s", vars(self))
696
os.kill(self.checker.pid, signal.SIGTERM)
698
#if self.checker.poll() is None:
699
# os.kill(self.checker.pid, signal.SIGKILL)
700
except OSError as error:
701
if error.errno != errno.ESRCH: # No such process
1109
self.checker.terminate()
703
1110
self.checker = None
706
def dbus_service_property(dbus_interface, signature="v",
707
access="readwrite", byte_arrays=False):
1113
def dbus_service_property(dbus_interface,
708
1117
"""Decorators for marking methods of a DBusObjectWithProperties to
709
1118
become properties on the D-Bus.
711
1120
The decorated method will be called with no arguments by "Get"
712
1121
and with one argument by "Set".
714
1123
The parameters, where they are supported, are the same as
715
1124
dbus.service.method, except there is only "signature", since the
716
1125
type from Get() and the type sent to Set() is the same.
755
class DBusObjectWithProperties(dbus.service.Object):
1208
class DBusObjectWithAnnotations(dbus.service.Object):
1209
"""A D-Bus object with annotations.
1211
Classes inheriting from this can use the dbus_annotations
1212
decorator to add annotations to methods or signals.
1216
def _is_dbus_thing(thing):
1217
"""Returns a function testing if an attribute is a D-Bus thing
1219
If called like _is_dbus_thing("method") it returns a function
1220
suitable for use as predicate to inspect.getmembers().
1222
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1225
def _get_all_dbus_things(self, thing):
1226
"""Returns a generator of (name, attribute) pairs
1228
return ((getattr(athing.__get__(self), "_dbus_name", name),
1229
athing.__get__(self))
1230
for cls in self.__class__.__mro__
1232
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1234
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1236
path_keyword='object_path',
1237
connection_keyword='connection')
1238
def Introspect(self, object_path, connection):
1239
"""Overloading of standard D-Bus method.
1241
Inserts annotation tags on methods and signals.
1243
xmlstring = dbus.service.Object.Introspect(self, object_path,
1246
document = xml.dom.minidom.parseString(xmlstring)
1248
for if_tag in document.getElementsByTagName("interface"):
1249
# Add annotation tags
1250
for typ in ("method", "signal"):
1251
for tag in if_tag.getElementsByTagName(typ):
1253
for name, prop in (self.
1254
_get_all_dbus_things(typ)):
1255
if (name == tag.getAttribute("name")
1256
and prop._dbus_interface
1257
== if_tag.getAttribute("name")):
1258
annots.update(getattr(
1259
prop, "_dbus_annotations", {}))
1260
for name, value in annots.items():
1261
ann_tag = document.createElement(
1263
ann_tag.setAttribute("name", name)
1264
ann_tag.setAttribute("value", value)
1265
tag.appendChild(ann_tag)
1266
# Add interface annotation tags
1267
for annotation, value in dict(
1268
itertools.chain.from_iterable(
1269
annotations().items()
1270
for name, annotations
1271
in self._get_all_dbus_things("interface")
1272
if name == if_tag.getAttribute("name")
1274
ann_tag = document.createElement("annotation")
1275
ann_tag.setAttribute("name", annotation)
1276
ann_tag.setAttribute("value", value)
1277
if_tag.appendChild(ann_tag)
1278
# Fix argument name for the Introspect method itself
1279
if (if_tag.getAttribute("name")
1280
== dbus.INTROSPECTABLE_IFACE):
1281
for cn in if_tag.getElementsByTagName("method"):
1282
if cn.getAttribute("name") == "Introspect":
1283
for arg in cn.getElementsByTagName("arg"):
1284
if (arg.getAttribute("direction")
1286
arg.setAttribute("name",
1288
xmlstring = document.toxml("utf-8")
1290
except (AttributeError, xml.dom.DOMException,
1291
xml.parsers.expat.ExpatError) as error:
1292
logger.error("Failed to override Introspection method",
1297
class DBusObjectWithProperties(DBusObjectWithAnnotations):
756
1298
"""A D-Bus object with properties.
758
1300
Classes inheriting from this can use the dbus_service_property
759
1301
decorator to expose methods as D-Bus properties. It exposes the
760
1302
standard Get(), Set(), and GetAll() methods on the D-Bus.
764
def _is_dbus_property(obj):
765
return getattr(obj, "_dbus_is_property", False)
767
def _get_all_dbus_properties(self):
768
"""Returns a generator of (name, attribute) pairs
770
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
771
for cls in self.__class__.__mro__
773
inspect.getmembers(cls, self._is_dbus_property))
775
1305
def _get_dbus_property(self, interface_name, property_name):
776
1306
"""Returns a bound method if one exists which is a D-Bus
777
1307
property with the specified name and interface.
779
for cls in self.__class__.__mro__:
780
for name, value in (inspect.getmembers
781
(cls, self._is_dbus_property)):
1309
for cls in self.__class__.__mro__:
1310
for name, value in inspect.getmembers(
1311
cls, self._is_dbus_thing("property")):
782
1312
if (value._dbus_name == property_name
783
1313
and value._dbus_interface == interface_name):
784
1314
return value.__get__(self)
786
1316
# No such property
787
raise DBusPropertyNotFound(self.dbus_object_path + ":"
788
+ interface_name + "."
791
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1317
raise DBusPropertyNotFound("{}:{}.{}".format(
1318
self.dbus_object_path, interface_name, property_name))
1321
def _get_all_interface_names(cls):
1322
"""Get a sequence of all interfaces supported by an object"""
1323
return (name for name in set(getattr(getattr(x, attr),
1324
"_dbus_interface", None)
1325
for x in (inspect.getmro(cls))
1327
if name is not None)
1329
@dbus.service.method(dbus.PROPERTIES_IFACE,
792
1331
out_signature="v")
793
1332
def Get(self, interface_name, property_name):
794
1333
"""Standard D-Bus property Get() method, see D-Bus standard.
886
1458
except (AttributeError, xml.dom.DOMException,
887
1459
xml.parsers.expat.ExpatError) as error:
888
1460
logger.error("Failed to override Introspection method",
893
def datetime_to_dbus (dt, variant_level=0):
1465
dbus.OBJECT_MANAGER_IFACE
1466
except AttributeError:
1467
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1470
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1471
"""A D-Bus object with an ObjectManager.
1473
Classes inheriting from this exposes the standard
1474
GetManagedObjects call and the InterfacesAdded and
1475
InterfacesRemoved signals on the standard
1476
"org.freedesktop.DBus.ObjectManager" interface.
1478
Note: No signals are sent automatically; they must be sent
1481
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1482
out_signature="a{oa{sa{sv}}}")
1483
def GetManagedObjects(self):
1484
"""This function must be overridden"""
1485
raise NotImplementedError()
1487
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1488
signature="oa{sa{sv}}")
1489
def InterfacesAdded(self, object_path, interfaces_and_properties):
1492
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1493
def InterfacesRemoved(self, object_path, interfaces):
1496
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1498
path_keyword='object_path',
1499
connection_keyword='connection')
1500
def Introspect(self, object_path, connection):
1501
"""Overloading of standard D-Bus method.
1503
Override return argument name of GetManagedObjects to be
1504
"objpath_interfaces_and_properties"
1506
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1510
document = xml.dom.minidom.parseString(xmlstring)
1512
for if_tag in document.getElementsByTagName("interface"):
1513
# Fix argument name for the GetManagedObjects method
1514
if (if_tag.getAttribute("name")
1515
== dbus.OBJECT_MANAGER_IFACE):
1516
for cn in if_tag.getElementsByTagName("method"):
1517
if (cn.getAttribute("name")
1518
== "GetManagedObjects"):
1519
for arg in cn.getElementsByTagName("arg"):
1520
if (arg.getAttribute("direction")
1524
"objpath_interfaces"
1526
xmlstring = document.toxml("utf-8")
1528
except (AttributeError, xml.dom.DOMException,
1529
xml.parsers.expat.ExpatError) as error:
1530
logger.error("Failed to override Introspection method",
1535
def datetime_to_dbus(dt, variant_level=0):
894
1536
"""Convert a UTC datetime.datetime() to a D-Bus type."""
896
return dbus.String("", variant_level = variant_level)
897
return dbus.String(dt.isoformat(),
898
variant_level=variant_level)
901
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
903
"""Applied to an empty subclass of a D-Bus object, this metaclass
904
will add additional D-Bus attributes matching a certain pattern.
1538
return dbus.String("", variant_level=variant_level)
1539
return dbus.String(dt.isoformat(), variant_level=variant_level)
1542
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1543
"""A class decorator; applied to a subclass of
1544
dbus.service.Object, it will add alternate D-Bus attributes with
1545
interface names according to the "alt_interface_names" mapping.
1548
@alternate_dbus_interfaces({"org.example.Interface":
1549
"net.example.AlternateInterface"})
1550
class SampleDBusObject(dbus.service.Object):
1551
@dbus.service.method("org.example.Interface")
1552
def SampleDBusMethod():
1555
The above "SampleDBusMethod" on "SampleDBusObject" will be
1556
reachable via two interfaces: "org.example.Interface" and
1557
"net.example.AlternateInterface", the latter of which will have
1558
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1559
"true", unless "deprecate" is passed with a False value.
1561
This works for methods and signals, and also for D-Bus properties
1562
(from DBusObjectWithProperties) and interfaces (from the
1563
dbus_interface_annotations decorator).
906
def __new__(mcs, name, bases, attr):
907
# Go through all the base classes which could have D-Bus
908
# methods, signals, or properties in them
909
for base in (b for b in bases
910
if issubclass(b, dbus.service.Object)):
911
# Go though all attributes of the base class
912
for attrname, attribute in inspect.getmembers(base):
1567
for orig_interface_name, alt_interface_name in (
1568
alt_interface_names.items()):
1570
interface_names = set()
1571
# Go though all attributes of the class
1572
for attrname, attribute in inspect.getmembers(cls):
913
1573
# Ignore non-D-Bus attributes, and D-Bus attributes
914
1574
# with the wrong interface name
915
1575
if (not hasattr(attribute, "_dbus_interface")
916
or not attribute._dbus_interface
917
.startswith("se.recompile.Mandos")):
1576
or not attribute._dbus_interface.startswith(
1577
orig_interface_name)):
919
1579
# Create an alternate D-Bus interface name based on
920
1580
# the current name
921
alt_interface = (attribute._dbus_interface
922
.replace("se.recompile.Mandos",
923
"se.bsnet.fukt.Mandos"))
1581
alt_interface = attribute._dbus_interface.replace(
1582
orig_interface_name, alt_interface_name)
1583
interface_names.add(alt_interface)
924
1584
# Is this a D-Bus signal?
925
1585
if getattr(attribute, "_dbus_is_signal", False):
926
# Extract the original non-method function by
928
nonmethod_func = (dict(
1586
# Extract the original non-method undecorated
1587
# function by black magic
1588
if sys.version_info.major == 2:
1589
nonmethod_func = (dict(
929
1590
zip(attribute.func_code.co_freevars,
930
attribute.__closure__))["func"]
1591
attribute.__closure__))
1592
["func"].cell_contents)
1594
nonmethod_func = (dict(
1595
zip(attribute.__code__.co_freevars,
1596
attribute.__closure__))
1597
["func"].cell_contents)
932
1598
# Create a new, but exactly alike, function
933
1599
# object, and decorate it to be a new D-Bus signal
934
1600
# with the alternate D-Bus interface name
935
new_function = (dbus.service.signal
937
attribute._dbus_signature)
939
nonmethod_func.func_code,
940
nonmethod_func.func_globals,
941
nonmethod_func.func_name,
942
nonmethod_func.func_defaults,
943
nonmethod_func.func_closure)))
1601
new_function = copy_function(nonmethod_func)
1602
new_function = (dbus.service.signal(
1604
attribute._dbus_signature)(new_function))
1605
# Copy annotations, if any
1607
new_function._dbus_annotations = dict(
1608
attribute._dbus_annotations)
1609
except AttributeError:
944
1612
# Define a creator of a function to call both the
945
# old and new functions, so both the old and new
946
# signals gets sent when the function is called
1613
# original and alternate functions, so both the
1614
# original and alternate signals gets sent when
1615
# the function is called
947
1616
def fixscope(func1, func2):
948
1617
"""This function is a scope container to pass
949
1618
func1 and func2 to the "call_both" function
950
1619
outside of its arguments"""
1621
@functools.wraps(func2)
951
1622
def call_both(*args, **kwargs):
952
1623
"""This function will emit two D-Bus
953
1624
signals by calling func1 and func2"""
954
1625
func1(*args, **kwargs)
955
1626
func2(*args, **kwargs)
1627
# Make wrapper function look like a D-Bus
1629
for name, attr in inspect.getmembers(func2):
1630
if name.startswith("_dbus_"):
1631
setattr(call_both, name, attr)
956
1633
return call_both
957
1634
# Create the "call_both" function and add it to
959
attr[attrname] = fixscope(attribute,
1636
attr[attrname] = fixscope(attribute, new_function)
961
1637
# Is this a D-Bus method?
962
1638
elif getattr(attribute, "_dbus_is_method", False):
963
1639
# Create a new, but exactly alike, function
964
1640
# object. Decorate it to be a new D-Bus method
965
1641
# with the alternate D-Bus interface name. Add it
967
attr[attrname] = (dbus.service.method
969
attribute._dbus_in_signature,
970
attribute._dbus_out_signature)
972
(attribute.func_code,
973
attribute.func_globals,
975
attribute.func_defaults,
976
attribute.func_closure)))
1644
dbus.service.method(
1646
attribute._dbus_in_signature,
1647
attribute._dbus_out_signature)
1648
(copy_function(attribute)))
1649
# Copy annotations, if any
1651
attr[attrname]._dbus_annotations = dict(
1652
attribute._dbus_annotations)
1653
except AttributeError:
977
1655
# Is this a D-Bus property?
978
1656
elif getattr(attribute, "_dbus_is_property", False):
979
1657
# Create a new, but exactly alike, function
980
1658
# object, and decorate it to be a new D-Bus
981
1659
# property with the alternate D-Bus interface
982
1660
# name. Add it to the class.
983
attr[attrname] = (dbus_service_property
985
attribute._dbus_signature,
986
attribute._dbus_access,
988
._dbus_get_args_options
991
(attribute.func_code,
992
attribute.func_globals,
994
attribute.func_defaults,
995
attribute.func_closure)))
996
return type.__new__(mcs, name, bases, attr)
1661
attr[attrname] = (dbus_service_property(
1662
alt_interface, attribute._dbus_signature,
1663
attribute._dbus_access,
1664
attribute._dbus_get_args_options
1666
(copy_function(attribute)))
1667
# Copy annotations, if any
1669
attr[attrname]._dbus_annotations = dict(
1670
attribute._dbus_annotations)
1671
except AttributeError:
1673
# Is this a D-Bus interface?
1674
elif getattr(attribute, "_dbus_is_interface", False):
1675
# Create a new, but exactly alike, function
1676
# object. Decorate it to be a new D-Bus interface
1677
# with the alternate D-Bus interface name. Add it
1680
dbus_interface_annotations(alt_interface)
1681
(copy_function(attribute)))
1683
# Deprecate all alternate interfaces
1684
iname = "_AlternateDBusNames_interface_annotation{}"
1685
for interface_name in interface_names:
1687
@dbus_interface_annotations(interface_name)
1689
return {"org.freedesktop.DBus.Deprecated":
1691
# Find an unused name
1692
for aname in (iname.format(i)
1693
for i in itertools.count()):
1694
if aname not in attr:
1698
# Replace the class with a new subclass of it with
1699
# methods, signals, etc. as created above.
1700
if sys.version_info.major == 2:
1701
cls = type(b"{}Alternate".format(cls.__name__),
1704
cls = type("{}Alternate".format(cls.__name__),
1711
@alternate_dbus_interfaces({"se.recompile.Mandos":
1712
"se.bsnet.fukt.Mandos"})
999
1713
class ClientDBus(Client, DBusObjectWithProperties):
1000
1714
"""A Client class using D-Bus
1003
1717
dbus_object_path: dbus.ObjectPath
1004
1718
bus: dbus.SystemBus()
1007
1721
runtime_expansions = (Client.runtime_expansions
1008
+ ("dbus_object_path",))
1722
+ ("dbus_object_path", ))
1724
_interface = "se.recompile.Mandos.Client"
1010
1726
# dbus.service.Object doesn't use super(), so we can't either.
1012
def __init__(self, bus = None, *args, **kwargs):
1728
def __init__(self, bus=None, *args, **kwargs):
1014
1730
Client.__init__(self, *args, **kwargs)
1016
self._approvals_pending = 0
1017
1731
# Only now, when this client is initialized, can it show up on
1019
client_object_name = unicode(self.name).translate(
1733
client_object_name = str(self.name).translate(
1020
1734
{ord("."): ord("_"),
1021
1735
ord("-"): ord("_")})
1022
self.dbus_object_path = (dbus.ObjectPath
1023
("/clients/" + client_object_name))
1736
self.dbus_object_path = dbus.ObjectPath(
1737
"/clients/" + client_object_name)
1024
1738
DBusObjectWithProperties.__init__(self, self.bus,
1025
1739
self.dbus_object_path)
1027
def notifychangeproperty(transform_func,
1028
dbus_name, type_func=lambda x: x,
1741
def notifychangeproperty(transform_func, dbus_name,
1742
type_func=lambda x: x,
1744
invalidate_only=False,
1745
_interface=_interface):
1030
1746
""" Modify a variable so that it's a property which announces
1031
1747
its changes to DBus.
1033
1749
transform_fun: Function that takes a value and a variant_level
1034
1750
and transforms it to a D-Bus type.
1035
1751
dbus_name: D-Bus name of the variable
1037
1753
to the D-Bus. Default: no transform
1038
1754
variant_level: D-Bus variant level. Default: 1
1040
attrname = "_{0}".format(dbus_name)
1756
attrname = "_{}".format(dbus_name)
1041
1758
def setter(self, value):
1042
1759
if hasattr(self, "dbus_object_path"):
1043
1760
if (not hasattr(self, attrname) or
1044
1761
type_func(getattr(self, attrname, None))
1045
1762
!= type_func(value)):
1046
dbus_value = transform_func(type_func(value),
1049
self.PropertyChanged(dbus.String(dbus_name),
1764
self.PropertiesChanged(
1765
_interface, dbus.Dictionary(),
1766
dbus.Array((dbus_name, )))
1768
dbus_value = transform_func(
1770
variant_level=variant_level)
1771
self.PropertyChanged(dbus.String(dbus_name),
1773
self.PropertiesChanged(
1775
dbus.Dictionary({dbus.String(dbus_name):
1051
1778
setattr(self, attrname, value)
1053
1780
return property(lambda self: getattr(self, attrname), setter)
1056
1782
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1057
1783
approvals_pending = notifychangeproperty(dbus.Boolean,
1058
1784
"ApprovalPending",
1060
1786
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1061
1787
last_enabled = notifychangeproperty(datetime_to_dbus,
1063
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1064
type_func = lambda checker:
1065
checker is not None)
1789
checker = notifychangeproperty(
1790
dbus.Boolean, "CheckerRunning",
1791
type_func=lambda checker: checker is not None)
1066
1792
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1067
1793
"LastCheckedOK")
1794
last_checker_status = notifychangeproperty(dbus.Int16,
1795
"LastCheckerStatus")
1068
1796
last_approval_request = notifychangeproperty(
1069
1797
datetime_to_dbus, "LastApprovalRequest")
1070
1798
approved_by_default = notifychangeproperty(dbus.Boolean,
1071
1799
"ApprovedByDefault")
1072
approval_delay = notifychangeproperty(dbus.UInt16,
1075
timedelta_to_milliseconds)
1800
approval_delay = notifychangeproperty(
1801
dbus.UInt64, "ApprovalDelay",
1802
type_func=lambda td: td.total_seconds() * 1000)
1076
1803
approval_duration = notifychangeproperty(
1077
dbus.UInt16, "ApprovalDuration",
1078
type_func = timedelta_to_milliseconds)
1804
dbus.UInt64, "ApprovalDuration",
1805
type_func=lambda td: td.total_seconds() * 1000)
1079
1806
host = notifychangeproperty(dbus.String, "Host")
1080
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1082
timedelta_to_milliseconds)
1807
timeout = notifychangeproperty(
1808
dbus.UInt64, "Timeout",
1809
type_func=lambda td: td.total_seconds() * 1000)
1083
1810
extended_timeout = notifychangeproperty(
1084
dbus.UInt16, "ExtendedTimeout",
1085
type_func = timedelta_to_milliseconds)
1086
interval = notifychangeproperty(dbus.UInt16,
1089
timedelta_to_milliseconds)
1811
dbus.UInt64, "ExtendedTimeout",
1812
type_func=lambda td: td.total_seconds() * 1000)
1813
interval = notifychangeproperty(
1814
dbus.UInt64, "Interval",
1815
type_func=lambda td: td.total_seconds() * 1000)
1090
1816
checker_command = notifychangeproperty(dbus.String, "Checker")
1817
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1818
invalidate_only=True)
1092
1820
del notifychangeproperty
1094
1822
def __del__(self, *args, **kwargs):
1096
1824
self.remove_from_connection()
1176
1903
server to mandos-client
1180
1907
# Rejected - signal
1181
1908
@dbus.service.signal(_interface, signature="s")
1182
1909
def Rejected(self, reason):
1186
1913
# NeedApproval - signal
1187
1914
@dbus.service.signal(_interface, signature="tb")
1188
1915
def NeedApproval(self, timeout, default):
1190
1917
return self.need_approval()
1192
# NeRwequest - signal
1193
@dbus.service.signal(_interface, signature="s")
1194
def NewRequest(self, ip):
1196
Is sent after a client request a password.
1202
1921
# Approve - method
1203
1922
@dbus.service.method(_interface, in_signature="b")
1204
1923
def Approve(self, value):
1205
1924
self.approve(value)
1207
1926
# CheckedOK - method
1208
1927
@dbus.service.method(_interface)
1209
1928
def CheckedOK(self):
1210
1929
self.checked_ok()
1212
1931
# Enable - method
1932
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1213
1933
@dbus.service.method(_interface)
1214
1934
def Enable(self):
1218
1938
# StartChecker - method
1939
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1219
1940
@dbus.service.method(_interface)
1220
1941
def StartChecker(self):
1222
1943
self.start_checker()
1224
1945
# Disable - method
1946
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1225
1947
@dbus.service.method(_interface)
1226
1948
def Disable(self):
1230
1952
# StopChecker - method
1953
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1231
1954
@dbus.service.method(_interface)
1232
1955
def StopChecker(self):
1233
1956
self.stop_checker()
1237
1960
# ApprovalPending - property
1238
1961
@dbus_service_property(_interface, signature="b", access="read")
1239
1962
def ApprovalPending_dbus_property(self):
1240
1963
return dbus.Boolean(bool(self.approvals_pending))
1242
1965
# ApprovedByDefault - property
1243
@dbus_service_property(_interface, signature="b",
1966
@dbus_service_property(_interface,
1244
1968
access="readwrite")
1245
1969
def ApprovedByDefault_dbus_property(self, value=None):
1246
1970
if value is None: # get
1247
1971
return dbus.Boolean(self.approved_by_default)
1248
1972
self.approved_by_default = bool(value)
1250
1974
# ApprovalDelay - property
1251
@dbus_service_property(_interface, signature="t",
1975
@dbus_service_property(_interface,
1252
1977
access="readwrite")
1253
1978
def ApprovalDelay_dbus_property(self, value=None):
1254
1979
if value is None: # get
1255
return dbus.UInt64(self.approval_delay_milliseconds())
1980
return dbus.UInt64(self.approval_delay.total_seconds()
1256
1982
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1258
1984
# ApprovalDuration - property
1259
@dbus_service_property(_interface, signature="t",
1985
@dbus_service_property(_interface,
1260
1987
access="readwrite")
1261
1988
def ApprovalDuration_dbus_property(self, value=None):
1262
1989
if value is None: # get
1263
return dbus.UInt64(timedelta_to_milliseconds(
1264
self.approval_duration))
1990
return dbus.UInt64(self.approval_duration.total_seconds()
1265
1992
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1267
1994
# Name - property
1996
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1268
1997
@dbus_service_property(_interface, signature="s", access="read")
1269
1998
def Name_dbus_property(self):
1270
1999
return dbus.String(self.name)
1272
2001
# Fingerprint - property
2003
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1273
2004
@dbus_service_property(_interface, signature="s", access="read")
1274
2005
def Fingerprint_dbus_property(self):
1275
2006
return dbus.String(self.fingerprint)
1277
2008
# Host - property
1278
@dbus_service_property(_interface, signature="s",
2009
@dbus_service_property(_interface,
1279
2011
access="readwrite")
1280
2012
def Host_dbus_property(self, value=None):
1281
2013
if value is None: # get
1282
2014
return dbus.String(self.host)
1283
self.host = unicode(value)
2015
self.host = str(value)
1285
2017
# Created - property
2019
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1286
2020
@dbus_service_property(_interface, signature="s", access="read")
1287
2021
def Created_dbus_property(self):
1288
2022
return datetime_to_dbus(self.created)
1290
2024
# LastEnabled - property
1291
2025
@dbus_service_property(_interface, signature="s", access="read")
1292
2026
def LastEnabled_dbus_property(self):
1293
2027
return datetime_to_dbus(self.last_enabled)
1295
2029
# Enabled - property
1296
@dbus_service_property(_interface, signature="b",
2030
@dbus_service_property(_interface,
1297
2032
access="readwrite")
1298
2033
def Enabled_dbus_property(self, value=None):
1299
2034
if value is None: # get
1306
2041
# LastCheckedOK - property
1307
@dbus_service_property(_interface, signature="s",
2042
@dbus_service_property(_interface,
1308
2044
access="readwrite")
1309
2045
def LastCheckedOK_dbus_property(self, value=None):
1310
2046
if value is not None:
1311
2047
self.checked_ok()
1313
2049
return datetime_to_dbus(self.last_checked_ok)
2051
# LastCheckerStatus - property
2052
@dbus_service_property(_interface, signature="n", access="read")
2053
def LastCheckerStatus_dbus_property(self):
2054
return dbus.Int16(self.last_checker_status)
1315
2056
# Expires - property
1316
2057
@dbus_service_property(_interface, signature="s", access="read")
1317
2058
def Expires_dbus_property(self):
1318
2059
return datetime_to_dbus(self.expires)
1320
2061
# LastApprovalRequest - property
1321
2062
@dbus_service_property(_interface, signature="s", access="read")
1322
2063
def LastApprovalRequest_dbus_property(self):
1323
2064
return datetime_to_dbus(self.last_approval_request)
1325
2066
# Timeout - property
1326
@dbus_service_property(_interface, signature="t",
2067
@dbus_service_property(_interface,
1327
2069
access="readwrite")
1328
2070
def Timeout_dbus_property(self, value=None):
1329
2071
if value is None: # get
1330
return dbus.UInt64(self.timeout_milliseconds())
2072
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2073
old_timeout = self.timeout
1331
2074
self.timeout = datetime.timedelta(0, 0, 0, value)
1332
if getattr(self, "disable_initiator_tag", None) is None:
1334
# Reschedule timeout
1335
gobject.source_remove(self.disable_initiator_tag)
1336
self.disable_initiator_tag = None
1338
time_to_die = timedelta_to_milliseconds((self
1343
if time_to_die <= 0:
1344
# The timeout has passed
1347
self.expires = (datetime.datetime.utcnow()
1348
+ datetime.timedelta(milliseconds =
1350
self.disable_initiator_tag = (gobject.timeout_add
1351
(time_to_die, self.disable))
2075
# Reschedule disabling
2077
now = datetime.datetime.utcnow()
2078
self.expires += self.timeout - old_timeout
2079
if self.expires <= now:
2080
# The timeout has passed
2083
if (getattr(self, "disable_initiator_tag", None)
2086
GLib.source_remove(self.disable_initiator_tag)
2087
self.disable_initiator_tag = GLib.timeout_add(
2088
int((self.expires - now).total_seconds() * 1000),
1353
2091
# ExtendedTimeout - property
1354
@dbus_service_property(_interface, signature="t",
2092
@dbus_service_property(_interface,
1355
2094
access="readwrite")
1356
2095
def ExtendedTimeout_dbus_property(self, value=None):
1357
2096
if value is None: # get
1358
return dbus.UInt64(self.extended_timeout_milliseconds())
2097
return dbus.UInt64(self.extended_timeout.total_seconds()
1359
2099
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1361
2101
# Interval - property
1362
@dbus_service_property(_interface, signature="t",
2102
@dbus_service_property(_interface,
1363
2104
access="readwrite")
1364
2105
def Interval_dbus_property(self, value=None):
1365
2106
if value is None: # get
1366
return dbus.UInt64(self.interval_milliseconds())
2107
return dbus.UInt64(self.interval.total_seconds() * 1000)
1367
2108
self.interval = datetime.timedelta(0, 0, 0, value)
1368
2109
if getattr(self, "checker_initiator_tag", None) is None:
1370
2111
if self.enabled:
1371
2112
# Reschedule checker run
1372
gobject.source_remove(self.checker_initiator_tag)
1373
self.checker_initiator_tag = (gobject.timeout_add
1374
(value, self.start_checker))
1375
self.start_checker() # Start one now, too
2113
GLib.source_remove(self.checker_initiator_tag)
2114
self.checker_initiator_tag = GLib.timeout_add(
2115
value, self.start_checker)
2116
self.start_checker() # Start one now, too
1377
2118
# Checker - property
1378
@dbus_service_property(_interface, signature="s",
2119
@dbus_service_property(_interface,
1379
2121
access="readwrite")
1380
2122
def Checker_dbus_property(self, value=None):
1381
2123
if value is None: # get
1382
2124
return dbus.String(self.checker_command)
1383
self.checker_command = unicode(value)
2125
self.checker_command = str(value)
1385
2127
# CheckerRunning - property
1386
@dbus_service_property(_interface, signature="b",
2128
@dbus_service_property(_interface,
1387
2130
access="readwrite")
1388
2131
def CheckerRunning_dbus_property(self, value=None):
1389
2132
if value is None: # get
1422
2173
if data[0] == 'data':
1424
2175
if data[0] == 'function':
1425
2177
def func(*args, **kwargs):
1426
2178
self._pipe.send(('funcall', name, args, kwargs))
1427
2179
return self._pipe.recv()[1]
1430
2183
def __setattr__(self, name, value):
1431
2184
if name == '_pipe':
1432
2185
return super(ProxyClient, self).__setattr__(name, value)
1433
2186
self._pipe.send(('setattr', name, value))
1436
class ClientDBusTransitional(ClientDBus):
1437
__metaclass__ = AlternateDBusNamesMetaclass
1440
2189
class ClientHandler(socketserver.BaseRequestHandler, object):
1441
2190
"""A class to handle client connections.
1443
2192
Instantiated once for each connection to handle it.
1444
2193
Note: This will run in its own forked process."""
1446
2195
def handle(self):
1447
2196
with contextlib.closing(self.server.child_pipe) as child_pipe:
1448
2197
logger.info("TCP connection from: %s",
1449
unicode(self.client_address))
2198
str(self.client_address))
1450
2199
logger.debug("Pipe FD: %d",
1451
2200
self.server.child_pipe.fileno())
1453
session = (gnutls.connection
1454
.ClientSession(self.request,
1456
.X509Credentials()))
1458
# Note: gnutls.connection.X509Credentials is really a
1459
# generic GnuTLS certificate credentials object so long as
1460
# no X.509 keys are added to it. Therefore, we can use it
1461
# here despite using OpenPGP certificates.
1463
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1464
# "+AES-256-CBC", "+SHA1",
1465
# "+COMP-NULL", "+CTYPE-OPENPGP",
2202
session = gnutls.ClientSession(self.request)
2204
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2205
# "+AES-256-CBC", "+SHA1",
2206
# "+COMP-NULL", "+CTYPE-OPENPGP",
1467
2208
# Use a fallback default, since this MUST be set.
1468
2209
priority = self.server.gnutls_priority
1469
2210
if priority is None:
1470
2211
priority = "NORMAL"
1471
(gnutls.library.functions
1472
.gnutls_priority_set_direct(session._c_object,
2212
gnutls.priority_set_direct(session._c_object,
2213
priority.encode("utf-8"),
1475
2216
# Start communication using the Mandos protocol
1476
2217
# Get protocol number
1477
2218
line = self.request.makefile().readline()
1478
2219
logger.debug("Protocol version: %r", line)
1480
2221
if int(line.strip().split()[0]) > 1:
2222
raise RuntimeError(line)
1482
2223
except (ValueError, IndexError, RuntimeError) as error:
1483
2224
logger.error("Unknown protocol version: %s", error)
1486
2227
# Start GnuTLS connection
1488
2229
session.handshake()
1489
except gnutls.errors.GNUTLSError as error:
2230
except gnutls.Error as error:
1490
2231
logger.warning("Handshake failed: %s", error)
1491
2232
# Do not run session.bye() here: the session is not
1492
2233
# established. Just abandon the request.
1494
2235
logger.debug("Handshake succeeded")
1496
2237
approval_required = False
1499
fpr = self.fingerprint(self.peer_certificate
1502
gnutls.errors.GNUTLSError) as error:
2240
fpr = self.fingerprint(
2241
self.peer_certificate(session))
2242
except (TypeError, gnutls.Error) as error:
1503
2243
logger.warning("Bad certificate: %s", error)
1505
2245
logger.debug("Fingerprint: %s", fpr)
1508
2248
client = ProxyClient(child_pipe, fpr,
1509
2249
self.client_address)
1510
2250
except KeyError:
1513
if self.server.use_dbus:
1515
client.NewRequest(str(self.client_address))
1517
2253
if client.approval_delay:
1518
2254
delay = client.approval_delay
1519
2255
client.approvals_pending += 1
1520
2256
approval_required = True
1523
2259
if not client.enabled:
1524
2260
logger.info("Client %s is disabled",
1526
2262
if self.server.use_dbus:
1527
2263
# Emit D-Bus signal
1528
2264
client.Rejected("Disabled")
1531
2267
if client.approved or not client.approval_delay:
1532
#We are approved or approval is disabled
2268
# We are approved or approval is disabled
1534
2270
elif client.approved is None:
1535
2271
logger.info("Client %s needs approval",
1570
2304
delay -= time2 - time
1573
while sent_size < len(client.secret):
1575
sent = session.send(client.secret[sent_size:])
1576
except gnutls.errors.GNUTLSError as error:
1577
logger.warning("gnutls send failed")
1579
logger.debug("Sent: %d, remaining: %d",
1580
sent, len(client.secret)
1581
- (sent_size + sent))
2307
session.send(client.secret)
2308
except gnutls.Error as error:
2309
logger.warning("gnutls send failed",
1584
2313
logger.info("Sending secret to %s", client.name)
1585
2314
# bump the timeout using extended_timeout
1586
client.checked_ok(client.extended_timeout)
2315
client.bump_timeout(client.extended_timeout)
1587
2316
if self.server.use_dbus:
1588
2317
# Emit D-Bus signal
1589
2318
client.GotSecret()
1592
2321
if approval_required:
1593
2322
client.approvals_pending -= 1
1596
except gnutls.errors.GNUTLSError as error:
1597
logger.warning("GnuTLS bye failed")
2325
except gnutls.Error as error:
2326
logger.warning("GnuTLS bye failed",
1600
2330
def peer_certificate(session):
1601
2331
"Return the peer's OpenPGP certificate as a bytestring"
1602
2332
# If not an OpenPGP certificate...
1603
if (gnutls.library.functions
1604
.gnutls_certificate_type_get(session._c_object)
1605
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1606
# ...do the normal thing
1607
return session.peer_certificate
2333
if (gnutls.certificate_type_get(session._c_object)
2334
!= gnutls.CRT_OPENPGP):
2335
# ...return invalid data
1608
2337
list_size = ctypes.c_uint(1)
1609
cert_list = (gnutls.library.functions
1610
.gnutls_certificate_get_peers
2338
cert_list = (gnutls.certificate_get_peers
1611
2339
(session._c_object, ctypes.byref(list_size)))
1612
2340
if not bool(cert_list) and list_size.value != 0:
1613
raise gnutls.errors.GNUTLSError("error getting peer"
2341
raise gnutls.Error("error getting peer certificate")
1615
2342
if list_size.value == 0:
1617
2344
cert = cert_list[0]
1618
2345
return ctypes.string_at(cert.data, cert.size)
1621
2348
def fingerprint(openpgp):
1622
2349
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1623
2350
# New GnuTLS "datum" with the OpenPGP public key
1624
datum = (gnutls.library.types
1625
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1628
ctypes.c_uint(len(openpgp))))
2351
datum = gnutls.datum_t(
2352
ctypes.cast(ctypes.c_char_p(openpgp),
2353
ctypes.POINTER(ctypes.c_ubyte)),
2354
ctypes.c_uint(len(openpgp)))
1629
2355
# New empty GnuTLS certificate
1630
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1631
(gnutls.library.functions
1632
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2356
crt = gnutls.openpgp_crt_t()
2357
gnutls.openpgp_crt_init(ctypes.byref(crt))
1633
2358
# Import the OpenPGP public key into the certificate
1634
(gnutls.library.functions
1635
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1636
gnutls.library.constants
1637
.GNUTLS_OPENPGP_FMT_RAW))
2359
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2360
gnutls.OPENPGP_FMT_RAW)
1638
2361
# Verify the self signature in the key
1639
2362
crtverify = ctypes.c_uint()
1640
(gnutls.library.functions
1641
.gnutls_openpgp_crt_verify_self(crt, 0,
1642
ctypes.byref(crtverify)))
2363
gnutls.openpgp_crt_verify_self(crt, 0,
2364
ctypes.byref(crtverify))
1643
2365
if crtverify.value != 0:
1644
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1645
raise (gnutls.errors.CertificateSecurityError
2366
gnutls.openpgp_crt_deinit(crt)
2367
raise gnutls.CertificateSecurityError("Verify failed")
1647
2368
# New buffer for the fingerprint
1648
2369
buf = ctypes.create_string_buffer(20)
1649
2370
buf_len = ctypes.c_size_t()
1650
2371
# Get the fingerprint from the certificate into the buffer
1651
(gnutls.library.functions
1652
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1653
ctypes.byref(buf_len)))
2372
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2373
ctypes.byref(buf_len))
1654
2374
# Deinit the certificate
1655
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2375
gnutls.openpgp_crt_deinit(crt)
1656
2376
# Convert the buffer to a Python bytestring
1657
2377
fpr = ctypes.string_at(buf, buf_len.value)
1658
2378
# Convert the bytestring to hexadecimal notation
1663
2383
class MultiprocessingMixIn(object):
1664
2384
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1665
2386
def sub_process_main(self, request, address):
1667
2388
self.finish_request(request, address)
1669
2390
self.handle_error(request, address)
1670
2391
self.close_request(request)
1672
2393
def process_request(self, request, address):
1673
2394
"""Start a new process to process the request."""
1674
proc = multiprocessing.Process(target = self.sub_process_main,
2395
proc = multiprocessing.Process(target=self.sub_process_main,
2396
args=(request, address))
1681
2401
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1682
2402
""" adds a pipe to the MixIn """
1683
2404
def process_request(self, request, client_address):
1684
2405
"""Overrides and wraps the original process_request().
1686
2407
This function creates a new pipe in self.pipe
1688
2409
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1690
2411
proc = MultiprocessingMixIn.process_request(self, request,
1691
2412
client_address)
1692
2413
self.child_pipe.close()
1693
2414
self.add_pipe(parent_pipe, proc)
1695
2416
def add_pipe(self, parent_pipe, proc):
1696
2417
"""Dummy function; override as necessary"""
1697
raise NotImplementedError
2418
raise NotImplementedError()
1700
2421
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1701
2422
socketserver.TCPServer, object):
1702
2423
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1705
2426
enabled: Boolean; whether this server is activated yet
1706
2427
interface: None or a network interface name (string)
1707
2428
use_ipv6: Boolean; to use IPv6 or not
1709
2431
def __init__(self, server_address, RequestHandlerClass,
1710
interface=None, use_ipv6=True):
2435
"""If socketfd is set, use that file descriptor instead of
2436
creating a new one with socket.socket().
1711
2438
self.interface = interface
1713
2440
self.address_family = socket.AF_INET6
2441
if socketfd is not None:
2442
# Save the file descriptor
2443
self.socketfd = socketfd
2444
# Save the original socket.socket() function
2445
self.socket_socket = socket.socket
2447
# To implement --socket, we monkey patch socket.socket.
2449
# (When socketserver.TCPServer is a new-style class, we
2450
# could make self.socket into a property instead of monkey
2451
# patching socket.socket.)
2453
# Create a one-time-only replacement for socket.socket()
2454
@functools.wraps(socket.socket)
2455
def socket_wrapper(*args, **kwargs):
2456
# Restore original function so subsequent calls are
2458
socket.socket = self.socket_socket
2459
del self.socket_socket
2460
# This time only, return a new socket object from the
2461
# saved file descriptor.
2462
return socket.fromfd(self.socketfd, *args, **kwargs)
2463
# Replace socket.socket() function with wrapper
2464
socket.socket = socket_wrapper
2465
# The socketserver.TCPServer.__init__ will call
2466
# socket.socket(), which might be our replacement,
2467
# socket_wrapper(), if socketfd was set.
1714
2468
socketserver.TCPServer.__init__(self, server_address,
1715
2469
RequestHandlerClass)
1716
2471
def server_bind(self):
1717
2472
"""This overrides the normal server_bind() function
1718
2473
to bind to an interface if one was specified, and also NOT to
1719
2474
bind to an address or port if they were not specified."""
2475
global SO_BINDTODEVICE
1720
2476
if self.interface is not None:
1721
2477
if SO_BINDTODEVICE is None:
1722
logger.error("SO_BINDTODEVICE does not exist;"
1723
" cannot bind to interface %s",
1727
self.socket.setsockopt(socket.SOL_SOCKET,
1731
except socket.error as error:
1732
if error[0] == errno.EPERM:
1733
logger.error("No permission to"
1734
" bind to interface %s",
1736
elif error[0] == errno.ENOPROTOOPT:
1737
logger.error("SO_BINDTODEVICE not available;"
1738
" cannot bind to interface %s",
2478
# Fall back to a hard-coded value which seems to be
2480
logger.warning("SO_BINDTODEVICE not found, trying 25")
2481
SO_BINDTODEVICE = 25
2483
self.socket.setsockopt(
2484
socket.SOL_SOCKET, SO_BINDTODEVICE,
2485
(self.interface + "\0").encode("utf-8"))
2486
except socket.error as error:
2487
if error.errno == errno.EPERM:
2488
logger.error("No permission to bind to"
2489
" interface %s", self.interface)
2490
elif error.errno == errno.ENOPROTOOPT:
2491
logger.error("SO_BINDTODEVICE not available;"
2492
" cannot bind to interface %s",
2494
elif error.errno == errno.ENODEV:
2495
logger.error("Interface %s does not exist,"
2496
" cannot bind", self.interface)
1742
2499
# Only bind(2) the socket if we really need to.
1743
2500
if self.server_address[0] or self.server_address[1]:
1744
2501
if not self.server_address[0]:
1745
2502
if self.address_family == socket.AF_INET6:
1746
any_address = "::" # in6addr_any
2503
any_address = "::" # in6addr_any
1748
any_address = socket.INADDR_ANY
2505
any_address = "0.0.0.0" # INADDR_ANY
1749
2506
self.server_address = (any_address,
1750
2507
self.server_address[1])
1751
2508
elif not self.server_address[1]:
1752
self.server_address = (self.server_address[0],
2509
self.server_address = (self.server_address[0], 0)
1754
2510
# if self.interface:
1755
2511
# self.server_address = (self.server_address[0],
1859
2609
funcname = request[1]
1860
2610
args = request[2]
1861
2611
kwargs = request[3]
1863
2613
parent_pipe.send(('data', getattr(client_object,
1864
2614
funcname)(*args,
1867
2617
if command == 'getattr':
1868
2618
attrname = request[1]
1869
if callable(client_object.__getattribute__(attrname)):
1870
parent_pipe.send(('function',))
2619
if isinstance(client_object.__getattribute__(attrname),
2620
collections.Callable):
2621
parent_pipe.send(('function', ))
1872
parent_pipe.send(('data', client_object
1873
.__getattribute__(attrname)))
2624
'data', client_object.__getattribute__(attrname)))
1875
2626
if command == 'setattr':
1876
2627
attrname = request[1]
1877
2628
value = request[2]
1878
2629
setattr(client_object, attrname, value)
2634
def rfc3339_duration_to_delta(duration):
2635
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2637
>>> rfc3339_duration_to_delta("P7D")
2638
datetime.timedelta(7)
2639
>>> rfc3339_duration_to_delta("PT60S")
2640
datetime.timedelta(0, 60)
2641
>>> rfc3339_duration_to_delta("PT60M")
2642
datetime.timedelta(0, 3600)
2643
>>> rfc3339_duration_to_delta("PT24H")
2644
datetime.timedelta(1)
2645
>>> rfc3339_duration_to_delta("P1W")
2646
datetime.timedelta(7)
2647
>>> rfc3339_duration_to_delta("PT5M30S")
2648
datetime.timedelta(0, 330)
2649
>>> rfc3339_duration_to_delta("P1DT3M20S")
2650
datetime.timedelta(1, 200)
2653
# Parsing an RFC 3339 duration with regular expressions is not
2654
# possible - there would have to be multiple places for the same
2655
# values, like seconds. The current code, while more esoteric, is
2656
# cleaner without depending on a parsing library. If Python had a
2657
# built-in library for parsing we would use it, but we'd like to
2658
# avoid excessive use of external libraries.
2660
# New type for defining tokens, syntax, and semantics all-in-one
2661
Token = collections.namedtuple("Token", (
2662
"regexp", # To match token; if "value" is not None, must have
2663
# a "group" containing digits
2664
"value", # datetime.timedelta or None
2665
"followers")) # Tokens valid after this token
2666
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2667
# the "duration" ABNF definition in RFC 3339, Appendix A.
2668
token_end = Token(re.compile(r"$"), None, frozenset())
2669
token_second = Token(re.compile(r"(\d+)S"),
2670
datetime.timedelta(seconds=1),
2671
frozenset((token_end, )))
2672
token_minute = Token(re.compile(r"(\d+)M"),
2673
datetime.timedelta(minutes=1),
2674
frozenset((token_second, token_end)))
2675
token_hour = Token(re.compile(r"(\d+)H"),
2676
datetime.timedelta(hours=1),
2677
frozenset((token_minute, token_end)))
2678
token_time = Token(re.compile(r"T"),
2680
frozenset((token_hour, token_minute,
2682
token_day = Token(re.compile(r"(\d+)D"),
2683
datetime.timedelta(days=1),
2684
frozenset((token_time, token_end)))
2685
token_month = Token(re.compile(r"(\d+)M"),
2686
datetime.timedelta(weeks=4),
2687
frozenset((token_day, token_end)))
2688
token_year = Token(re.compile(r"(\d+)Y"),
2689
datetime.timedelta(weeks=52),
2690
frozenset((token_month, token_end)))
2691
token_week = Token(re.compile(r"(\d+)W"),
2692
datetime.timedelta(weeks=1),
2693
frozenset((token_end, )))
2694
token_duration = Token(re.compile(r"P"), None,
2695
frozenset((token_year, token_month,
2696
token_day, token_time,
2698
# Define starting values:
2700
value = datetime.timedelta()
2702
# Following valid tokens
2703
followers = frozenset((token_duration, ))
2704
# String left to parse
2706
# Loop until end token is found
2707
while found_token is not token_end:
2708
# Search for any currently valid tokens
2709
for token in followers:
2710
match = token.regexp.match(s)
2711
if match is not None:
2713
if token.value is not None:
2714
# Value found, parse digits
2715
factor = int(match.group(1), 10)
2716
# Add to value so far
2717
value += factor * token.value
2718
# Strip token from string
2719
s = token.regexp.sub("", s, 1)
2722
# Set valid next tokens
2723
followers = found_token.followers
2726
# No currently valid tokens were found
2727
raise ValueError("Invalid RFC 3339 duration: {!r}"
1883
2733
def string_to_delta(interval):
1884
2734
"""Parse a string and return a datetime.timedelta
1886
2736
>>> string_to_delta('7d')
1887
2737
datetime.timedelta(7)
1888
2738
>>> string_to_delta('60s')
1977
2833
parser.add_argument("--no-dbus", action="store_false",
1978
2834
dest="use_dbus", help="Do not provide D-Bus"
1979
" system bus interface")
2835
" system bus interface", default=None)
1980
2836
parser.add_argument("--no-ipv6", action="store_false",
1981
dest="use_ipv6", help="Do not use IPv6")
2837
dest="use_ipv6", help="Do not use IPv6",
1982
2839
parser.add_argument("--no-restore", action="store_false",
1983
2840
dest="restore", help="Do not restore stored"
2841
" state", default=None)
2842
parser.add_argument("--socket", type=int,
2843
help="Specify a file descriptor to a network"
2844
" socket to use instead of creating one")
1985
2845
parser.add_argument("--statedir", metavar="DIR",
1986
2846
help="Directory to save/restore state in")
2847
parser.add_argument("--foreground", action="store_true",
2848
help="Run in foreground", default=None)
2849
parser.add_argument("--no-zeroconf", action="store_false",
2850
dest="zeroconf", help="Do not use Zeroconf",
1988
2853
options = parser.parse_args()
1990
2855
if options.check:
2857
fail_count, test_count = doctest.testmod()
2858
sys.exit(os.EX_OK if fail_count == 0 else 1)
1995
2860
# Default values for config file for server-global settings
1996
server_defaults = { "interface": "",
2001
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2002
"servicename": "Mandos",
2007
"statedir": "/var/lib/mandos"
2861
server_defaults = {"interface": "",
2866
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2867
":+SIGN-DSA-SHA256",
2868
"servicename": "Mandos",
2874
"statedir": "/var/lib/mandos",
2875
"foreground": "False",
2010
2879
# Parse config file for server-global settings
2011
2880
server_config = configparser.SafeConfigParser(server_defaults)
2012
2881
del server_defaults
2013
server_config.read(os.path.join(options.configdir,
2882
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2015
2883
# Convert the SafeConfigParser object to a dict
2016
2884
server_settings = server_config.defaults()
2017
2885
# Use the appropriate methods on the non-string config options
2018
for option in ("debug", "use_dbus", "use_ipv6"):
2886
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2019
2887
server_settings[option] = server_config.getboolean("DEFAULT",
2021
2889
if server_settings["port"]:
2022
2890
server_settings["port"] = server_config.getint("DEFAULT",
2892
if server_settings["socket"]:
2893
server_settings["socket"] = server_config.getint("DEFAULT",
2895
# Later, stdin will, and stdout and stderr might, be dup'ed
2896
# over with an opened os.devnull. But we don't want this to
2897
# happen with a supplied network socket.
2898
if 0 <= server_settings["socket"] <= 2:
2899
server_settings["socket"] = os.dup(server_settings
2024
2901
del server_config
2026
2903
# Override the settings from the config file with command line
2027
2904
# options, if set.
2028
2905
for option in ("interface", "address", "port", "debug",
2029
"priority", "servicename", "configdir",
2030
"use_dbus", "use_ipv6", "debuglevel", "restore",
2906
"priority", "servicename", "configdir", "use_dbus",
2907
"use_ipv6", "debuglevel", "restore", "statedir",
2908
"socket", "foreground", "zeroconf"):
2032
2909
value = getattr(options, option)
2033
2910
if value is not None:
2034
2911
server_settings[option] = value
2036
2913
# Force all strings to be unicode
2037
2914
for option in server_settings.keys():
2038
if type(server_settings[option]) is str:
2039
server_settings[option] = unicode(server_settings[option])
2915
if isinstance(server_settings[option], bytes):
2916
server_settings[option] = (server_settings[option]
2918
# Force all boolean options to be boolean
2919
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2920
"foreground", "zeroconf"):
2921
server_settings[option] = bool(server_settings[option])
2922
# Debug implies foreground
2923
if server_settings["debug"]:
2924
server_settings["foreground"] = True
2040
2925
# Now we have our good server settings in "server_settings"
2042
2927
##################################################################
2929
if (not server_settings["zeroconf"]
2930
and not (server_settings["port"]
2931
or server_settings["socket"] != "")):
2932
parser.error("Needs port or socket to work without Zeroconf")
2044
2934
# For convenience
2045
2935
debug = server_settings["debug"]
2046
2936
debuglevel = server_settings["debuglevel"]
2048
2938
use_ipv6 = server_settings["use_ipv6"]
2049
2939
stored_state_path = os.path.join(server_settings["statedir"],
2050
2940
stored_state_file)
2941
foreground = server_settings["foreground"]
2942
zeroconf = server_settings["zeroconf"]
2053
initlogger(logging.DEBUG)
2945
initlogger(debug, logging.DEBUG)
2055
2947
if not debuglevel:
2058
2950
level = getattr(logging, debuglevel.upper())
2951
initlogger(debug, level)
2061
2953
if server_settings["servicename"] != "Mandos":
2062
syslogger.setFormatter(logging.Formatter
2063
('Mandos (%s) [%%(process)d]:'
2064
' %%(levelname)s: %%(message)s'
2065
% server_settings["servicename"]))
2954
syslogger.setFormatter(
2955
logging.Formatter('Mandos ({}) [%(process)d]:'
2956
' %(levelname)s: %(message)s'.format(
2957
server_settings["servicename"])))
2067
2959
# Parse config file with clients
2068
client_defaults = { "timeout": "5m",
2069
"extended_timeout": "15m",
2071
"checker": "fping -q -- %%(host)s",
2073
"approval_delay": "0s",
2074
"approval_duration": "1s",
2076
client_config = configparser.SafeConfigParser(client_defaults)
2960
client_config = configparser.SafeConfigParser(Client
2077
2962
client_config.read(os.path.join(server_settings["configdir"],
2078
2963
"clients.conf"))
2080
2965
global mandos_dbus_service
2081
2966
mandos_dbus_service = None
2083
tcp_server = MandosServer((server_settings["address"],
2084
server_settings["port"]),
2086
interface=(server_settings["interface"]
2090
server_settings["priority"],
2093
pidfilename = "/var/run/mandos.pid"
2095
pidfile = open(pidfilename, "w")
2097
logger.error("Could not open file %r", pidfilename)
2100
uid = pwd.getpwnam("_mandos").pw_uid
2101
gid = pwd.getpwnam("_mandos").pw_gid
2104
uid = pwd.getpwnam("mandos").pw_uid
2105
gid = pwd.getpwnam("mandos").pw_gid
2969
if server_settings["socket"] != "":
2970
socketfd = server_settings["socket"]
2971
tcp_server = MandosServer(
2972
(server_settings["address"], server_settings["port"]),
2974
interface=(server_settings["interface"] or None),
2976
gnutls_priority=server_settings["priority"],
2980
pidfilename = "/run/mandos.pid"
2981
if not os.path.isdir("/run/."):
2982
pidfilename = "/var/run/mandos.pid"
2985
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2986
except IOError as e:
2987
logger.error("Could not open file %r", pidfilename,
2990
for name, group in (("_mandos", "_mandos"),
2991
("mandos", "mandos"),
2992
("nobody", "nogroup")):
2994
uid = pwd.getpwnam(name).pw_uid
2995
gid = pwd.getpwnam(group).pw_gid
2106
2997
except KeyError:
2108
uid = pwd.getpwnam("nobody").pw_uid
2109
gid = pwd.getpwnam("nobody").pw_gid
3006
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2116
3008
except OSError as error:
2117
if error[0] != errno.EPERM:
3009
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3010
.format(uid, gid, os.strerror(error.errno)))
3011
if error.errno != errno.EPERM:
2121
3015
# Enable all possible GnuTLS debugging
2123
3017
# "Use a log level over 10 to enable all debugging options."
2124
3018
# - GnuTLS manual
2125
gnutls.library.functions.gnutls_global_set_log_level(11)
2127
@gnutls.library.types.gnutls_log_func
3019
gnutls.global_set_log_level(11)
2128
3022
def debug_gnutls(level, string):
2129
3023
logger.debug("GnuTLS: %s", string[:-1])
2131
(gnutls.library.functions
2132
.gnutls_global_set_log_function(debug_gnutls))
3025
gnutls.global_set_log_function(debug_gnutls)
2134
3027
# Redirect stdin so all checkers get /dev/null
2135
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3028
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2136
3029
os.dup2(null, sys.stdin.fileno())
2140
# No console logging
2141
logger.removeHandler(console)
2143
3033
# Need to fork before connecting to D-Bus
2145
3035
# Close all input and output, do double fork, etc.
3038
# multiprocessing will use threads, so before we use GLib we need
3039
# to inform GLib that threads will be used.
2148
3042
global main_loop
2149
3043
# From the Avahi example code
2150
DBusGMainLoop(set_as_default=True )
2151
main_loop = gobject.MainLoop()
3044
DBusGMainLoop(set_as_default=True)
3045
main_loop = GLib.MainLoop()
2152
3046
bus = dbus.SystemBus()
2153
3047
# End of Avahi example code
2156
3050
bus_name = dbus.service.BusName("se.recompile.Mandos",
2157
bus, do_not_queue=True)
2158
old_bus_name = (dbus.service.BusName
2159
("se.bsnet.fukt.Mandos", bus,
2161
except dbus.exceptions.NameExistsException as e:
2162
logger.error(unicode(e) + ", disabling D-Bus")
3053
old_bus_name = dbus.service.BusName(
3054
"se.bsnet.fukt.Mandos", bus,
3056
except dbus.exceptions.DBusException as e:
3057
logger.error("Disabling D-Bus:", exc_info=e)
2163
3058
use_dbus = False
2164
3059
server_settings["use_dbus"] = False
2165
3060
tcp_server.use_dbus = False
2166
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2167
service = AvahiServiceToSyslog(name =
2168
server_settings["servicename"],
2169
servicetype = "_mandos._tcp",
2170
protocol = protocol, bus = bus)
2171
if server_settings["interface"]:
2172
service.interface = (if_nametoindex
2173
(str(server_settings["interface"])))
3062
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3063
service = AvahiServiceToSyslog(
3064
name=server_settings["servicename"],
3065
servicetype="_mandos._tcp",
3068
if server_settings["interface"]:
3069
service.interface = if_nametoindex(
3070
server_settings["interface"].encode("utf-8"))
2175
3072
global multiprocessing_manager
2176
3073
multiprocessing_manager = multiprocessing.Manager()
2178
3075
client_class = Client
2180
client_class = functools.partial(ClientDBusTransitional,
2183
special_settings = {
2184
# Some settings need to be accessd by special methods;
2185
# booleans need .getboolean(), etc. Here is a list of them:
2186
"approved_by_default":
2188
client_config.getboolean(section, "approved_by_default"),
2191
client_config.getboolean(section, "enabled"),
2193
# Construct a new dict of client settings of this form:
2194
# { client_name: {setting_name: value, ...}, ...}
2195
# with exceptions for any special settings as defined above
2196
client_settings = dict((clientname,
2199
if setting not in special_settings
2200
else special_settings[setting]
2202
for setting, value in
2203
client_config.items(clientname)))
2204
for clientname in client_config.sections())
3077
client_class = functools.partial(ClientDBus, bus=bus)
3079
client_settings = Client.config_parser(client_config)
2206
3080
old_client_settings = {}
3083
# This is used to redirect stdout and stderr for checker processes
3085
wnull = open(os.devnull, "w") # A writable /dev/null
3086
# Only used if server is running in foreground but not in debug
3088
if debug or not foreground:
2209
3091
# Get client data and settings from last running state.
2210
3092
if server_settings["restore"]:
2212
3094
with open(stored_state_path, "rb") as stored_state:
2213
clients_data, old_client_settings = (pickle.load
3095
if sys.version_info.major == 2:
3096
clients_data, old_client_settings = pickle.load(
3099
bytes_clients_data, bytes_old_client_settings = (
3100
pickle.load(stored_state, encoding="bytes"))
3101
# Fix bytes to strings
3104
clients_data = {(key.decode("utf-8")
3105
if isinstance(key, bytes)
3108
bytes_clients_data.items()}
3109
del bytes_clients_data
3110
for key in clients_data:
3111
value = {(k.decode("utf-8")
3112
if isinstance(k, bytes) else k): v
3114
clients_data[key].items()}
3115
clients_data[key] = value
3117
value["client_structure"] = [
3119
if isinstance(s, bytes)
3121
value["client_structure"]]
3123
for k in ("name", "host"):
3124
if isinstance(value[k], bytes):
3125
value[k] = value[k].decode("utf-8")
3126
# old_client_settings
3128
old_client_settings = {
3129
(key.decode("utf-8")
3130
if isinstance(key, bytes)
3133
bytes_old_client_settings.items()}
3134
del bytes_old_client_settings
3136
for value in old_client_settings.values():
3137
if isinstance(value["host"], bytes):
3138
value["host"] = (value["host"]
2215
3140
os.remove(stored_state_path)
2216
3141
except IOError as e:
2217
logger.warning("Could not load persistent state: {0}"
2219
if e.errno != errno.ENOENT:
3142
if e.errno == errno.ENOENT:
3143
logger.warning("Could not load persistent state:"
3144
" {}".format(os.strerror(e.errno)))
3146
logger.critical("Could not load persistent state:",
3149
except EOFError as e:
3150
logger.warning("Could not load persistent state: "
2222
3154
with PGPEngine() as pgp:
2223
for client in clients_data:
2224
client_name = client["name"]
3155
for client_name, client in clients_data.items():
3156
# Skip removed clients
3157
if client_name not in client_settings:
2226
3160
# Decide which value to use after restoring saved state.
2227
3161
# We have three different values: Old config file,
2228
3162
# new config file, and saved state.
2233
3167
# For each value in new config, check if it
2234
3168
# differs from the old config value (Except for
2235
3169
# the "secret" attribute)
2236
if (name != "secret" and
2237
value != old_client_settings[client_name]
2239
setattr(client, name, value)
3170
if (name != "secret"
3172
old_client_settings[client_name][name])):
3173
client[name] = value
2240
3174
except KeyError:
2243
3177
# Clients who has passed its expire date can still be
2244
# enabled if its last checker was sucessful. Clients
2245
# whose checker failed before we stored its state is
2246
# assumed to have failed all checkers during downtime.
3178
# enabled if its last checker was successful. A Client
3179
# whose checker succeeded before we stored its state is
3180
# assumed to have successfully run all checkers during
2247
3182
if client["enabled"]:
2248
if client["expires"] <= (datetime.datetime
2250
# Client has expired
2251
if client["last_checker_status"] != 0:
3183
if datetime.datetime.utcnow() >= client["expires"]:
3184
if not client["last_checked_ok"]:
3186
"disabling client {} - Client never "
3187
"performed a successful checker".format(
3189
client["enabled"] = False
3190
elif client["last_checker_status"] != 0:
3192
"disabling client {} - Client last"
3193
" checker failed with error code"
3196
client["last_checker_status"]))
2252
3197
client["enabled"] = False
2254
client["expires"] = (datetime.datetime
2256
+ client["timeout"])
2258
client["changedstate"] = (multiprocessing_manager
2260
(multiprocessing_manager
2263
new_client = (ClientDBusTransitional.__new__
2264
(ClientDBusTransitional))
2265
tcp_server.clients[client_name] = new_client
2266
new_client.bus = bus
2267
for name, value in client.iteritems():
2268
setattr(new_client, name, value)
2269
client_object_name = unicode(client_name).translate(
2270
{ord("."): ord("_"),
2271
ord("-"): ord("_")})
2272
new_client.dbus_object_path = (dbus.ObjectPath
2274
+ client_object_name))
2275
DBusObjectWithProperties.__init__(new_client,
2280
tcp_server.clients[client_name] = (Client.__new__
2282
for name, value in client.iteritems():
2283
setattr(tcp_server.clients[client_name],
3199
client["expires"] = (
3200
datetime.datetime.utcnow()
3201
+ client["timeout"])
3202
logger.debug("Last checker succeeded,"
3203
" keeping {} enabled".format(
2287
tcp_server.clients[client_name].secret = (
2288
pgp.decrypt(tcp_server.clients[client_name]
2290
client_settings[client_name]
3206
client["secret"] = pgp.decrypt(
3207
client["encrypted_secret"],
3208
client_settings[client_name]["secret"])
2292
3209
except PGPError:
2293
3210
# If decryption fails, we use secret from new settings
2294
logger.debug("Failed to decrypt {0} old secret"
2295
.format(client_name))
2296
tcp_server.clients[client_name].secret = (
2297
client_settings[client_name]["secret"])
2299
# Create/remove clients based on new changes made to config
2300
for clientname in set(old_client_settings) - set(client_settings):
2301
del tcp_server.clients[clientname]
2302
for clientname in set(client_settings) - set(old_client_settings):
2303
tcp_server.clients[clientname] = (client_class(name
3211
logger.debug("Failed to decrypt {} old secret".format(
3213
client["secret"] = (client_settings[client_name]
3216
# Add/remove clients based on new changes made to config
3217
for client_name in (set(old_client_settings)
3218
- set(client_settings)):
3219
del clients_data[client_name]
3220
for client_name in (set(client_settings)
3221
- set(old_client_settings)):
3222
clients_data[client_name] = client_settings[client_name]
3224
# Create all client objects
3225
for client_name, client in clients_data.items():
3226
tcp_server.clients[client_name] = client_class(
3229
server_settings=server_settings)
2309
3231
if not tcp_server.clients:
2310
3232
logger.warning("No clients defined")
2316
pidfile.write(str(pid) + "\n".encode("utf-8"))
2319
logger.error("Could not write to file %r with PID %d",
2322
# "pidfile" was never created
3235
if pidfile is not None:
3239
print(pid, file=pidfile)
3241
logger.error("Could not write to file %r with PID %d",
2324
3244
del pidfilename
2326
signal.signal(signal.SIGINT, signal.SIG_IGN)
2328
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2329
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3246
for termsig in (signal.SIGHUP, signal.SIGTERM):
3247
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3248
lambda: main_loop.quit() and False)
2332
class MandosDBusService(dbus.service.Object):
3252
@alternate_dbus_interfaces(
3253
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3254
class MandosDBusService(DBusObjectWithObjectManager):
2333
3255
"""A D-Bus proxy object"""
2334
3257
def __init__(self):
2335
3258
dbus.service.Object.__init__(self, bus, "/")
2336
3260
_interface = "se.recompile.Mandos"
2338
3262
@dbus.service.signal(_interface, signature="o")
2339
3263
def ClientAdded(self, objpath):
2343
3267
@dbus.service.signal(_interface, signature="ss")
2344
3268
def ClientNotFound(self, fingerprint, address):
3272
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2348
3274
@dbus.service.signal(_interface, signature="os")
2349
3275
def ClientRemoved(self, objpath, name):
3279
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2353
3281
@dbus.service.method(_interface, out_signature="ao")
2354
3282
def GetAllClients(self):
2356
return dbus.Array(c.dbus_object_path
2358
tcp_server.clients.itervalues())
3284
return dbus.Array(c.dbus_object_path for c in
3285
tcp_server.clients.values())
3287
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2360
3289
@dbus.service.method(_interface,
2361
3290
out_signature="a{oa{sv}}")
2362
3291
def GetAllClientsWithProperties(self):
2364
3293
return dbus.Dictionary(
2365
((c.dbus_object_path, c.GetAll(""))
2366
for c in tcp_server.clients.itervalues()),
3294
{c.dbus_object_path: c.GetAll(
3295
"se.recompile.Mandos.Client")
3296
for c in tcp_server.clients.values()},
2367
3297
signature="oa{sv}")
2369
3299
@dbus.service.method(_interface, in_signature="o")
2370
3300
def RemoveClient(self, object_path):
2372
for c in tcp_server.clients.itervalues():
3302
for c in tcp_server.clients.values():
2373
3303
if c.dbus_object_path == object_path:
2374
3304
del tcp_server.clients[c.name]
2375
3305
c.remove_from_connection()
2376
# Don't signal anything except ClientRemoved
3306
# Don't signal the disabling
2377
3307
c.disable(quiet=True)
2379
self.ClientRemoved(object_path, c.name)
3308
# Emit D-Bus signal for removal
3309
self.client_removed_signal(c)
2381
3311
raise KeyError(object_path)
2385
class MandosDBusServiceTransitional(MandosDBusService):
2386
__metaclass__ = AlternateDBusNamesMetaclass
2387
mandos_dbus_service = MandosDBusServiceTransitional()
3315
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3316
out_signature="a{oa{sa{sv}}}")
3317
def GetManagedObjects(self):
3319
return dbus.Dictionary(
3320
{client.dbus_object_path:
3322
{interface: client.GetAll(interface)
3324
client._get_all_interface_names()})
3325
for client in tcp_server.clients.values()})
3327
def client_added_signal(self, client):
3328
"""Send the new standard signal and the old signal"""
3330
# New standard signal
3331
self.InterfacesAdded(
3332
client.dbus_object_path,
3334
{interface: client.GetAll(interface)
3336
client._get_all_interface_names()}))
3338
self.ClientAdded(client.dbus_object_path)
3340
def client_removed_signal(self, client):
3341
"""Send the new standard signal and the old signal"""
3343
# New standard signal
3344
self.InterfacesRemoved(
3345
client.dbus_object_path,
3346
client._get_all_interface_names())
3348
self.ClientRemoved(client.dbus_object_path,
3351
mandos_dbus_service = MandosDBusService()
3353
# Save modules to variables to exempt the modules from being
3354
# unloaded before the function registered with atexit() is run.
3355
mp = multiprocessing
2390
3359
"Cleanup function; run on exit"
2393
multiprocessing.active_children()
3363
mp.active_children()
2394
3365
if not (tcp_server.clients or client_settings):
2397
3368
# Store client before exiting. Secrets are encrypted with key
2398
3369
# based on what config file has. If config file is
2399
3370
# removed/edited, old secret will thus be unrecovable.
2401
3372
with PGPEngine() as pgp:
2402
for client in tcp_server.clients.itervalues():
3373
for client in tcp_server.clients.values():
2403
3374
key = client_settings[client.name]["secret"]
2404
3375
client.encrypted_secret = pgp.encrypt(client.secret,
2406
3377
client_dict = {}
2408
# A list of attributes that will not be stored when
2410
exclude = set(("bus", "changedstate", "secret"))
2411
for name, typ in (inspect.getmembers
2412
(dbus.service.Object)):
3379
# A list of attributes that can not be pickled
3381
exclude = {"bus", "changedstate", "secret",
3382
"checker", "server_settings"}
3383
for name, typ in inspect.getmembers(dbus.service
2413
3385
exclude.add(name)
2415
3387
client_dict["encrypted_secret"] = (client
2416
3388
.encrypted_secret)
2417
3389
for attr in client.client_structure:
2418
3390
if attr not in exclude:
2419
3391
client_dict[attr] = getattr(client, attr)
2421
clients.append(client_dict)
3393
clients[client.name] = client_dict
2422
3394
del client_settings[client.name]["secret"]
2425
with os.fdopen(os.open(stored_state_path,
2426
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2427
0600), "wb") as stored_state:
2428
pickle.dump((clients, client_settings), stored_state)
3397
with tempfile.NamedTemporaryFile(
3401
dir=os.path.dirname(stored_state_path),
3402
delete=False) as stored_state:
3403
pickle.dump((clients, client_settings), stored_state,
3405
tempname = stored_state.name
3406
os.rename(tempname, stored_state_path)
2429
3407
except (IOError, OSError) as e:
2430
logger.warning("Could not save persistent state: {0}"
2432
if e.errno not in (errno.ENOENT, errno.EACCES):
3413
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3414
logger.warning("Could not save persistent state: {}"
3415
.format(os.strerror(e.errno)))
3417
logger.warning("Could not save persistent state:",
2435
3421
# Delete all clients, and settings from config
2436
3422
while tcp_server.clients:
2437
3423
name, client = tcp_server.clients.popitem()
2439
3425
client.remove_from_connection()
2440
# Don't signal anything except ClientRemoved
3426
# Don't signal the disabling
2441
3427
client.disable(quiet=True)
3428
# Emit D-Bus signal for removal
2444
mandos_dbus_service.ClientRemoved(client
3430
mandos_dbus_service.client_removed_signal(client)
2447
3431
client_settings.clear()
2449
3433
atexit.register(cleanup)
2451
for client in tcp_server.clients.itervalues():
3435
for client in tcp_server.clients.values():
2454
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3437
# Emit D-Bus signal for adding
3438
mandos_dbus_service.client_added_signal(client)
2455
3439
# Need to initiate checking of clients
2456
3440
if client.enabled:
2457
3441
client.init_checker()
2459
3443
tcp_server.enable()
2460
3444
tcp_server.server_activate()
2462
3446
# Find out what port we got
2463
service.port = tcp_server.socket.getsockname()[1]
3448
service.port = tcp_server.socket.getsockname()[1]
2465
3450
logger.info("Now listening on address %r, port %d,"
2466
" flowinfo %d, scope_id %d"
2467
% tcp_server.socket.getsockname())
3451
" flowinfo %d, scope_id %d",
3452
*tcp_server.socket.getsockname())
2469
logger.info("Now listening on address %r, port %d"
2470
% tcp_server.socket.getsockname())
2472
#service.interface = tcp_server.socket.getsockname()[3]
3454
logger.info("Now listening on address %r, port %d",
3455
*tcp_server.socket.getsockname())
3457
# service.interface = tcp_server.socket.getsockname()[3]
2475
# From the Avahi example code
2478
except dbus.exceptions.DBusException as error:
2479
logger.critical("DBusException: %s", error)
2482
# End of Avahi example code
2484
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2485
lambda *args, **kwargs:
2486
(tcp_server.handle_request
2487
(*args[2:], **kwargs) or True))
3461
# From the Avahi example code
3464
except dbus.exceptions.DBusException as error:
3465
logger.critical("D-Bus Exception", exc_info=error)
3468
# End of Avahi example code
3470
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3471
lambda *args, **kwargs:
3472
(tcp_server.handle_request
3473
(*args[2:], **kwargs) or True))
2489
3475
logger.debug("Starting main loop")
2490
3476
main_loop.run()
2491
3477
except AvahiError as error:
2492
logger.critical("AvahiError: %s", error)
3478
logger.critical("Avahi Error", exc_info=error)
2495
3481
except KeyboardInterrupt: