451
451
def entry_group_state_changed(self, state, error):
452
452
"""Derived from the Avahi example code"""
453
logger.debug("Avahi entry group state change: %i", state)
453
log.debug("Avahi entry group state change: %i", state)
455
455
if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
logger.debug("Zeroconf service established.")
456
log.debug("Zeroconf service established.")
457
457
elif state == avahi.ENTRY_GROUP_COLLISION:
458
logger.info("Zeroconf service name collision.")
458
log.info("Zeroconf service name collision.")
460
460
elif state == avahi.ENTRY_GROUP_FAILURE:
461
logger.critical("Avahi: Error in group state changed %s",
461
log.critical("Avahi: Error in group state changed %s",
463
463
raise AvahiGroupError("State changed: {!s}".format(error))
465
465
def cleanup(self):
495
495
except dbus.exceptions.DBusException as error:
496
496
if (error.get_dbus_name()
497
497
== "org.freedesktop.Avahi.CollisionError"):
498
logger.info("Local Zeroconf service name"
498
log.info("Local Zeroconf service name collision.")
500
499
return self.rename(remove=False)
502
logger.critical("D-Bus Exception", exc_info=error)
501
log.critical("D-Bus Exception", exc_info=error)
506
505
if error is None:
507
logger.debug("Unknown state: %r", state)
506
log.debug("Unknown state: %r", state)
509
logger.debug("Unknown state: %r: %r", state, error)
508
log.debug("Unknown state: %r: %r", state, error)
511
510
def activate(self):
512
511
"""Derived from the Avahi example code"""
594
593
# gnutls.strerror()
596
595
if message is None and code is not None:
597
message = gnutls.strerror(code)
596
message = gnutls.strerror(code).decode(
597
"utf-8", errors="replace")
598
598
return super(gnutls.Error, self).__init__(
601
601
class CertificateSecurityError(Error):
605
def __init__(self, cls):
608
def from_param(self, obj):
609
if not isinstance(obj, self.cls):
610
raise TypeError("Not of type {}: {!r}"
611
.format(self.cls.__name__, obj))
612
return ctypes.byref(obj.from_param(obj))
614
class CastToVoidPointer:
615
def __init__(self, cls):
618
def from_param(self, obj):
619
if not isinstance(obj, self.cls):
620
raise TypeError("Not of type {}: {!r}"
621
.format(self.cls.__name__, obj))
622
return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
624
class With_from_param:
626
def from_param(cls, obj):
627
return obj._as_parameter_
630
class Credentials(With_from_param):
606
631
def __init__(self):
607
self._c_object = gnutls.certificate_credentials_t()
608
gnutls.certificate_allocate_credentials(
609
ctypes.byref(self._c_object))
632
self._as_parameter_ = gnutls.certificate_credentials_t()
633
gnutls.certificate_allocate_credentials(self)
610
634
self.type = gnutls.CRD_CERTIFICATE
612
636
def __del__(self):
613
gnutls.certificate_free_credentials(self._c_object)
637
gnutls.certificate_free_credentials(self)
639
class ClientSession(With_from_param):
616
640
def __init__(self, socket, credentials=None):
617
self._c_object = gnutls.session_t()
641
self._as_parameter_ = gnutls.session_t()
618
642
gnutls_flags = gnutls.CLIENT
619
643
if gnutls.check_version(b"3.5.6"):
620
644
gnutls_flags |= gnutls.NO_TICKETS
621
645
if gnutls.has_rawpk:
622
646
gnutls_flags |= gnutls.ENABLE_RAWPK
623
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
647
gnutls.init(self, gnutls_flags)
625
gnutls.set_default_priority(self._c_object)
626
gnutls.transport_set_ptr(self._c_object, socket.fileno())
627
gnutls.handshake_set_private_extensions(self._c_object,
649
gnutls.set_default_priority(self)
650
gnutls.transport_set_ptr(self, socket.fileno())
651
gnutls.handshake_set_private_extensions(self, True)
629
652
self.socket = socket
630
653
if credentials is None:
631
654
credentials = gnutls.Credentials()
632
gnutls.credentials_set(self._c_object, credentials.type,
633
ctypes.cast(credentials._c_object,
655
gnutls.credentials_set(self, credentials.type,
635
657
self.credentials = credentials
637
659
def __del__(self):
638
gnutls.deinit(self._c_object)
640
662
def handshake(self):
641
return gnutls.handshake(self._c_object)
663
return gnutls.handshake(self)
643
665
def send(self, data):
644
666
data = bytes(data)
645
667
data_len = len(data)
646
668
while data_len > 0:
647
data_len -= gnutls.record_send(self._c_object,
669
data_len -= gnutls.record_send(self, data[-data_len:],
652
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
673
return gnutls.bye(self, gnutls.SHUT_RDWR)
654
675
# Error handling functions
655
676
def _error_code(result):
656
677
"""A function to raise exceptions on errors, suitable
657
for the 'restype' attribute on ctypes functions"""
678
for the "restype" attribute on ctypes functions"""
679
if result >= gnutls.E_SUCCESS:
660
681
if result == gnutls.E_NO_CERTIFICATE_FOUND:
661
682
raise gnutls.CertificateSecurityError(code=result)
662
683
raise gnutls.Error(code=result)
664
def _retry_on_error(result, func, arguments):
685
def _retry_on_error(result, func, arguments,
686
_error_code=_error_code):
665
687
"""A function to retry on some errors, suitable
666
for the 'errcheck' attribute on ctypes functions"""
688
for the "errcheck" attribute on ctypes functions"""
689
while result < gnutls.E_SUCCESS:
668
690
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
669
691
return _error_code(result)
670
692
result = func(*arguments)
677
699
priority_set_direct = _library.gnutls_priority_set_direct
678
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
700
priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
679
701
ctypes.POINTER(ctypes.c_char_p)]
680
702
priority_set_direct.restype = _error_code
682
704
init = _library.gnutls_init
683
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
705
init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
684
706
init.restype = _error_code
686
708
set_default_priority = _library.gnutls_set_default_priority
687
set_default_priority.argtypes = [session_t]
709
set_default_priority.argtypes = [ClientSession]
688
710
set_default_priority.restype = _error_code
690
712
record_send = _library.gnutls_record_send
691
record_send.argtypes = [session_t, ctypes.c_void_p,
713
record_send.argtypes = [ClientSession, ctypes.c_void_p,
693
715
record_send.restype = ctypes.c_ssize_t
694
716
record_send.errcheck = _retry_on_error
696
718
certificate_allocate_credentials = (
697
719
_library.gnutls_certificate_allocate_credentials)
698
720
certificate_allocate_credentials.argtypes = [
699
ctypes.POINTER(certificate_credentials_t)]
721
PointerTo(Credentials)]
700
722
certificate_allocate_credentials.restype = _error_code
702
724
certificate_free_credentials = (
703
725
_library.gnutls_certificate_free_credentials)
704
certificate_free_credentials.argtypes = [
705
certificate_credentials_t]
726
certificate_free_credentials.argtypes = [Credentials]
706
727
certificate_free_credentials.restype = None
708
729
handshake_set_private_extensions = (
709
730
_library.gnutls_handshake_set_private_extensions)
710
handshake_set_private_extensions.argtypes = [session_t,
731
handshake_set_private_extensions.argtypes = [ClientSession,
712
733
handshake_set_private_extensions.restype = None
714
735
credentials_set = _library.gnutls_credentials_set
715
credentials_set.argtypes = [session_t, credentials_type_t,
736
credentials_set.argtypes = [ClientSession, credentials_type_t,
737
CastToVoidPointer(Credentials)]
717
738
credentials_set.restype = _error_code
719
740
strerror = _library.gnutls_strerror
738
759
global_set_log_function.restype = None
740
761
deinit = _library.gnutls_deinit
741
deinit.argtypes = [session_t]
762
deinit.argtypes = [ClientSession]
742
763
deinit.restype = None
744
765
handshake = _library.gnutls_handshake
745
handshake.argtypes = [session_t]
746
handshake.restype = _error_code
766
handshake.argtypes = [ClientSession]
767
handshake.restype = ctypes.c_int
747
768
handshake.errcheck = _retry_on_error
749
770
transport_set_ptr = _library.gnutls_transport_set_ptr
750
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
771
transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
751
772
transport_set_ptr.restype = None
753
774
bye = _library.gnutls_bye
754
bye.argtypes = [session_t, close_request_t]
755
bye.restype = _error_code
775
bye.argtypes = [ClientSession, close_request_t]
776
bye.restype = ctypes.c_int
756
777
bye.errcheck = _retry_on_error
758
779
check_version = _library.gnutls_check_version
1147
1166
command = self.checker_command % escaped_attrs
1148
1167
except TypeError as error:
1149
logger.error('Could not format string "%s"',
1150
self.checker_command,
1168
log.error('Could not format string "%s"',
1169
self.checker_command, exc_info=error)
1152
1170
return True # Try again later
1153
1171
self.current_checker_command = command
1154
logger.info("Starting checker %r for %s", command,
1172
log.info("Starting checker %r for %s", command, self.name)
1156
1173
# We don't need to redirect stdout and stderr, since
1157
1174
# in normal mode, that is already done by daemon(),
1158
1175
# and in debug mode we don't want to. (Stdin is
2250
2267
class ProxyClient:
2251
2268
def __init__(self, child_pipe, key_id, fpr, address):
2252
2269
self._pipe = child_pipe
2253
self._pipe.send(('init', key_id, fpr, address))
2270
self._pipe.send(("init", key_id, fpr, address))
2254
2271
if not self._pipe.recv():
2255
2272
raise KeyError(key_id or fpr)
2257
2274
def __getattribute__(self, name):
2259
2276
return super(ProxyClient, self).__getattribute__(name)
2260
self._pipe.send(('getattr', name))
2277
self._pipe.send(("getattr", name))
2261
2278
data = self._pipe.recv()
2262
if data[0] == 'data':
2279
if data[0] == "data":
2264
if data[0] == 'function':
2281
if data[0] == "function":
2266
2283
def func(*args, **kwargs):
2267
self._pipe.send(('funcall', name, args, kwargs))
2284
self._pipe.send(("funcall", name, args, kwargs))
2268
2285
return self._pipe.recv()[1]
2272
2289
def __setattr__(self, name, value):
2274
2291
return super(ProxyClient, self).__setattr__(name, value)
2275
self._pipe.send(('setattr', name, value))
2292
self._pipe.send(("setattr", name, value))
2278
2295
class ClientHandler(socketserver.BaseRequestHandler, object):
2284
2301
def handle(self):
2285
2302
with contextlib.closing(self.server.child_pipe) as child_pipe:
2286
logger.info("TCP connection from: %s",
2287
str(self.client_address))
2288
logger.debug("Pipe FD: %d",
2289
self.server.child_pipe.fileno())
2303
log.info("TCP connection from: %s",
2304
str(self.client_address))
2305
log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2291
2307
session = gnutls.ClientSession(self.request)
2293
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2309
# priority = ":".join(("NONE", "+VERS-TLS1.1",
2294
2310
# "+AES-256-CBC", "+SHA1",
2295
2311
# "+COMP-NULL", "+CTYPE-OPENPGP",
2298
2314
priority = self.server.gnutls_priority
2299
2315
if priority is None:
2300
2316
priority = "NORMAL"
2301
gnutls.priority_set_direct(session._c_object,
2302
priority.encode("utf-8"),
2317
gnutls.priority_set_direct(session,
2318
priority.encode("utf-8"), None)
2305
2320
# Start communication using the Mandos protocol
2306
2321
# Get protocol number
2307
2322
line = self.request.makefile().readline()
2308
logger.debug("Protocol version: %r", line)
2323
log.debug("Protocol version: %r", line)
2310
2325
if int(line.strip().split()[0]) > 1:
2311
2326
raise RuntimeError(line)
2312
2327
except (ValueError, IndexError, RuntimeError) as error:
2313
logger.error("Unknown protocol version: %s", error)
2328
log.error("Unknown protocol version: %s", error)
2316
2331
# Start GnuTLS connection
2318
2333
session.handshake()
2319
2334
except gnutls.Error as error:
2320
logger.warning("Handshake failed: %s", error)
2335
log.warning("Handshake failed: %s", error)
2321
2336
# Do not run session.bye() here: the session is not
2322
2337
# established. Just abandon the request.
2324
logger.debug("Handshake succeeded")
2339
log.debug("Handshake succeeded")
2326
2341
approval_required = False
2426
2441
except gnutls.Error as error:
2427
logger.warning("GnuTLS bye failed",
2442
log.warning("GnuTLS bye failed", exc_info=error)
2431
2445
def peer_certificate(session):
2432
2446
"Return the peer's certificate as a bytestring"
2434
cert_type = gnutls.certificate_type_get2(session._c_object,
2448
cert_type = gnutls.certificate_type_get2(
2449
session, gnutls.CTYPE_PEERS)
2436
2450
except AttributeError:
2437
cert_type = gnutls.certificate_type_get(session._c_object)
2451
cert_type = gnutls.certificate_type_get(session)
2438
2452
if gnutls.has_rawpk:
2439
2453
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2441
2455
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2442
2456
# If not a valid certificate type...
2443
2457
if cert_type not in valid_cert_types:
2444
logger.info("Cert type %r not in %r", cert_type,
2458
log.info("Cert type %r not in %r", cert_type,
2446
2460
# ...return invalid data
2448
2462
list_size = ctypes.c_uint(1)
2449
2463
cert_list = (gnutls.certificate_get_peers
2450
(session._c_object, ctypes.byref(list_size)))
2464
(session, ctypes.byref(list_size)))
2451
2465
if not bool(cert_list) and list_size.value != 0:
2452
2466
raise gnutls.Error("error getting peer certificate")
2453
2467
if list_size.value == 0:
2632
2646
(self.interface + "\0").encode("utf-8"))
2633
2647
except socket.error as error:
2634
2648
if error.errno == errno.EPERM:
2635
logger.error("No permission to bind to"
2636
" interface %s", self.interface)
2649
log.error("No permission to bind to interface %s",
2637
2651
elif error.errno == errno.ENOPROTOOPT:
2638
logger.error("SO_BINDTODEVICE not available;"
2639
" cannot bind to interface %s",
2652
log.error("SO_BINDTODEVICE not available; cannot"
2653
" bind to interface %s", self.interface)
2641
2654
elif error.errno == errno.ENODEV:
2642
logger.error("Interface %s does not exist,"
2643
" cannot bind", self.interface)
2655
log.error("Interface %s does not exist, cannot"
2656
" bind", self.interface)
2646
2659
# Only bind(2) the socket if we really need to.
2761
2774
# remove the old hook in favor of the new above hook on
2764
if command == 'funcall':
2777
if command == "funcall":
2765
2778
funcname = request[1]
2766
2779
args = request[2]
2767
2780
kwargs = request[3]
2769
parent_pipe.send(('data', getattr(client_object,
2782
parent_pipe.send(("data", getattr(client_object,
2770
2783
funcname)(*args,
2773
if command == 'getattr':
2786
if command == "getattr":
2774
2787
attrname = request[1]
2775
2788
if isinstance(client_object.__getattribute__(attrname),
2776
2789
collections.abc.Callable):
2777
parent_pipe.send(('function', ))
2790
parent_pipe.send(("function", ))
2779
2792
parent_pipe.send((
2780
'data', client_object.__getattribute__(attrname)))
2793
"data", client_object.__getattribute__(attrname)))
2782
if command == 'setattr':
2795
if command == "setattr":
2783
2796
attrname = request[1]
2784
2797
value = request[2]
2785
2798
setattr(client_object, attrname, value)
2891
2904
def string_to_delta(interval):
2892
2905
"""Parse a string and return a datetime.timedelta
2894
>>> string_to_delta('7d') == datetime.timedelta(7)
2896
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2898
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2900
>>> string_to_delta('24h') == datetime.timedelta(1)
2902
>>> string_to_delta('1w') == datetime.timedelta(7)
2904
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2907
>>> string_to_delta("7d") == datetime.timedelta(7)
2909
>>> string_to_delta("60s") == datetime.timedelta(0, 60)
2911
>>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2913
>>> string_to_delta("24h") == datetime.timedelta(1)
2915
>>> string_to_delta("1w") == datetime.timedelta(7)
2917
>>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
3346
3357
if client["enabled"]:
3347
3358
if datetime.datetime.utcnow() >= client["expires"]:
3348
3359
if not client["last_checked_ok"]:
3350
"disabling client {} - Client never "
3351
"performed a successful checker".format(
3360
log.warning("disabling client %s - Client"
3361
" never performed a successful"
3362
" checker", client_name)
3353
3363
client["enabled"] = False
3354
3364
elif client["last_checker_status"] != 0:
3356
"disabling client {} - Client last"
3357
" checker failed with error code"
3360
client["last_checker_status"]))
3365
log.warning("disabling client %s - Client"
3366
" last checker failed with error"
3367
" code %s", client_name,
3368
client["last_checker_status"])
3361
3369
client["enabled"] = False
3363
3371
client["expires"] = (
3364
3372
datetime.datetime.utcnow()
3365
3373
+ client["timeout"])
3366
logger.debug("Last checker succeeded,"
3367
" keeping {} enabled".format(
3374
log.debug("Last checker succeeded, keeping %s"
3375
" enabled", client_name)
3370
3377
client["secret"] = pgp.decrypt(
3371
3378
client["encrypted_secret"],
3372
3379
client_settings[client_name]["secret"])
3373
3380
except PGPError:
3374
3381
# If decryption fails, we use secret from new settings
3375
logger.debug("Failed to decrypt {} old secret".format(
3382
log.debug("Failed to decrypt %s old secret",
3377
3384
client["secret"] = (client_settings[client_name]
3612
3619
service.port = tcp_server.socket.getsockname()[1]
3614
logger.info("Now listening on address %r, port %d,"
3615
" flowinfo %d, scope_id %d",
3616
*tcp_server.socket.getsockname())
3621
log.info("Now listening on address %r, port %d, flowinfo %d,"
3622
" scope_id %d", *tcp_server.socket.getsockname())
3618
logger.info("Now listening on address %r, port %d",
3619
*tcp_server.socket.getsockname())
3624
log.info("Now listening on address %r, port %d",
3625
*tcp_server.socket.getsockname())
3621
3627
# service.interface = tcp_server.socket.getsockname()[3]
3637
3643
lambda *args, **kwargs: (tcp_server.handle_request
3638
3644
(*args[2:], **kwargs) or True))
3640
logger.debug("Starting main loop")
3646
log.debug("Starting main loop")
3641
3647
main_loop.run()
3642
3648
except AvahiError as error:
3643
logger.critical("Avahi Error", exc_info=error)
3649
log.critical("Avahi Error", exc_info=error)
3646
3652
except KeyboardInterrupt:
3648
3654
print("", file=sys.stderr)
3649
logger.debug("Server received KeyboardInterrupt")
3650
logger.debug("Server exiting")
3655
log.debug("Server received KeyboardInterrupt")
3656
log.debug("Server exiting")
3651
3657
# Must run before the D-Bus bus name gets deregistered
3655
def should_only_run_tests():
3661
def parse_test_args():
3662
# type: () -> argparse.Namespace
3656
3663
parser = argparse.ArgumentParser(add_help=False)
3657
parser.add_argument("--check", action='store_true')
3664
parser.add_argument("--check", action="store_true")
3665
parser.add_argument("--prefix", )
3658
3666
args, unknown_args = parser.parse_known_args()
3659
run_tests = args.check
3661
# Remove --check argument from sys.argv
3668
# Remove test options from sys.argv
3662
3669
sys.argv[1:] = unknown_args
3665
3672
# Add all tests from doctest strings
3666
3673
def load_tests(loader, tests, none):
3668
3675
tests.addTests(doctest.DocTestSuite())
3671
if __name__ == '__main__':
3678
if __name__ == "__main__":
3679
options = parse_test_args()
3673
if should_only_run_tests():
3674
# Call using ./mandos --check [--verbose]
3682
extra_test_prefix = options.prefix
3683
if extra_test_prefix is not None:
3684
if not (unittest.main(argv=[""], exit=False)
3685
.result.wasSuccessful()):
3687
class ExtraTestLoader(unittest.TestLoader):
3688
testMethodPrefix = extra_test_prefix
3689
# Call using ./scriptname --test [--verbose]
3690
unittest.main(argv=[""], testLoader=ExtraTestLoader())
3692
unittest.main(argv=[""])
3679
3696
logging.shutdown()
3700
# (lambda (&optional extra)
3701
# (if (not (funcall run-tests-in-test-buffer default-directory
3703
# (funcall show-test-buffer-in-test-window)
3704
# (funcall remove-test-window)
3705
# (if extra (message "Extra tests run successfully!"))))
3706
# run-tests-in-test-buffer:
3707
# (lambda (dir &optional extra)
3708
# (with-current-buffer (get-buffer-create "*Test*")
3709
# (setq buffer-read-only nil
3710
# default-directory dir)
3712
# (compilation-mode))
3713
# (let ((process-result
3714
# (let ((inhibit-read-only t))
3715
# (process-file-shell-command
3716
# (funcall get-command-line extra) nil "*Test*"))))
3717
# (and (numberp process-result)
3718
# (= process-result 0))))
3720
# (lambda (&optional extra)
3721
# (let ((quoted-script
3722
# (shell-quote-argument (funcall get-script-name))))
3724
# (concat "%s --check" (if extra " --prefix=atest" ""))
3728
# (if (fboundp 'file-local-name)
3729
# (file-local-name (buffer-file-name))
3730
# (or (file-remote-p (buffer-file-name) 'localname)
3731
# (buffer-file-name))))
3732
# remove-test-window:
3734
# (let ((test-window (get-buffer-window "*Test*")))
3735
# (if test-window (delete-window test-window))))
3736
# show-test-buffer-in-test-window:
3738
# (when (not (get-buffer-window-list "*Test*"))
3739
# (setq next-error-last-buffer (get-buffer "*Test*"))
3740
# (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3741
# (display-buffer-overriding-action
3742
# `((display-buffer-in-side-window) (side . ,side)
3743
# (window-height . fit-window-to-buffer)
3744
# (window-width . fit-window-to-buffer))))
3745
# (display-buffer "*Test*"))))
3748
# (let* ((run-extra-tests (lambda () (interactive)
3749
# (funcall run-tests t)))
3750
# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3751
# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c
3752
# (setq minor-mode-overriding-map-alist
3753
# (cons `(run-tests . ,outer-keymap)
3754
# minor-mode-overriding-map-alist)))
3755
# (add-hook 'after-save-hook run-tests 90 t))