435
479
.format(self.name)))
482
# Pretend that we have a GnuTLS module
483
class GnuTLS(object):
484
"""This isn't so much a class as it is a module-like namespace.
485
It is instantiated once, and simulates having a GnuTLS module."""
487
_library = ctypes.cdll.LoadLibrary(
488
ctypes.util.find_library("gnutls"))
489
_need_version = b"3.3.0"
491
# Need to use class name "GnuTLS" here, since this method is
492
# called before the assignment to the "gnutls" global variable
494
if GnuTLS.check_version(self._need_version) is None:
495
raise GnuTLS.Error("Needs GnuTLS {} or later"
496
.format(self._need_version))
498
# Unless otherwise indicated, the constants and types below are
499
# all from the gnutls/gnutls.h C header file.
509
E_NO_CERTIFICATE_FOUND = -49
510
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
513
class session_int(ctypes.Structure):
515
session_t = ctypes.POINTER(session_int)
516
class certificate_credentials_st(ctypes.Structure):
518
certificate_credentials_t = ctypes.POINTER(
519
certificate_credentials_st)
520
certificate_type_t = ctypes.c_int
521
class datum_t(ctypes.Structure):
522
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
523
('size', ctypes.c_uint)]
524
class openpgp_crt_int(ctypes.Structure):
526
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
527
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
528
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
529
credentials_type_t = ctypes.c_int
530
transport_ptr_t = ctypes.c_void_p
531
close_request_t = ctypes.c_int
534
class Error(Exception):
535
# We need to use the class name "GnuTLS" here, since this
536
# exception might be raised from within GnuTLS.__init__,
537
# which is called before the assignment to the "gnutls"
538
# global variable has happened.
539
def __init__(self, message = None, code = None, args=()):
540
# Default usage is by a message string, but if a return
541
# code is passed, convert it to a string with
544
if message is None and code is not None:
545
message = GnuTLS.strerror(code)
546
return super(GnuTLS.Error, self).__init__(
549
class CertificateSecurityError(Error):
553
class Credentials(object):
555
self._c_object = gnutls.certificate_credentials_t()
556
gnutls.certificate_allocate_credentials(
557
ctypes.byref(self._c_object))
558
self.type = gnutls.CRD_CERTIFICATE
561
gnutls.certificate_free_credentials(self._c_object)
563
class ClientSession(object):
564
def __init__(self, socket, credentials = None):
565
self._c_object = gnutls.session_t()
566
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
567
gnutls.set_default_priority(self._c_object)
568
gnutls.transport_set_ptr(self._c_object, socket.fileno())
569
gnutls.handshake_set_private_extensions(self._c_object,
572
if credentials is None:
573
credentials = gnutls.Credentials()
574
gnutls.credentials_set(self._c_object, credentials.type,
575
ctypes.cast(credentials._c_object,
577
self.credentials = credentials
580
gnutls.deinit(self._c_object)
583
return gnutls.handshake(self._c_object)
585
def send(self, data):
589
data_len -= gnutls.record_send(self._c_object,
594
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
596
# Error handling functions
597
def _error_code(result):
598
"""A function to raise exceptions on errors, suitable
599
for the 'restype' attribute on ctypes functions"""
602
if result == gnutls.E_NO_CERTIFICATE_FOUND:
603
raise gnutls.CertificateSecurityError(code = result)
604
raise gnutls.Error(code = result)
606
def _retry_on_error(result, func, arguments):
607
"""A function to retry on some errors, suitable
608
for the 'errcheck' attribute on ctypes functions"""
610
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
611
return _error_code(result)
612
result = func(*arguments)
615
# Unless otherwise indicated, the function declarations below are
616
# all from the gnutls/gnutls.h C header file.
619
priority_set_direct = _library.gnutls_priority_set_direct
620
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
621
ctypes.POINTER(ctypes.c_char_p)]
622
priority_set_direct.restype = _error_code
624
init = _library.gnutls_init
625
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
626
init.restype = _error_code
628
set_default_priority = _library.gnutls_set_default_priority
629
set_default_priority.argtypes = [session_t]
630
set_default_priority.restype = _error_code
632
record_send = _library.gnutls_record_send
633
record_send.argtypes = [session_t, ctypes.c_void_p,
635
record_send.restype = ctypes.c_ssize_t
636
record_send.errcheck = _retry_on_error
638
certificate_allocate_credentials = (
639
_library.gnutls_certificate_allocate_credentials)
640
certificate_allocate_credentials.argtypes = [
641
ctypes.POINTER(certificate_credentials_t)]
642
certificate_allocate_credentials.restype = _error_code
644
certificate_free_credentials = (
645
_library.gnutls_certificate_free_credentials)
646
certificate_free_credentials.argtypes = [certificate_credentials_t]
647
certificate_free_credentials.restype = None
649
handshake_set_private_extensions = (
650
_library.gnutls_handshake_set_private_extensions)
651
handshake_set_private_extensions.argtypes = [session_t,
653
handshake_set_private_extensions.restype = None
655
credentials_set = _library.gnutls_credentials_set
656
credentials_set.argtypes = [session_t, credentials_type_t,
658
credentials_set.restype = _error_code
660
strerror = _library.gnutls_strerror
661
strerror.argtypes = [ctypes.c_int]
662
strerror.restype = ctypes.c_char_p
664
certificate_type_get = _library.gnutls_certificate_type_get
665
certificate_type_get.argtypes = [session_t]
666
certificate_type_get.restype = _error_code
668
certificate_get_peers = _library.gnutls_certificate_get_peers
669
certificate_get_peers.argtypes = [session_t,
670
ctypes.POINTER(ctypes.c_uint)]
671
certificate_get_peers.restype = ctypes.POINTER(datum_t)
673
global_set_log_level = _library.gnutls_global_set_log_level
674
global_set_log_level.argtypes = [ctypes.c_int]
675
global_set_log_level.restype = None
677
global_set_log_function = _library.gnutls_global_set_log_function
678
global_set_log_function.argtypes = [log_func]
679
global_set_log_function.restype = None
681
deinit = _library.gnutls_deinit
682
deinit.argtypes = [session_t]
683
deinit.restype = None
685
handshake = _library.gnutls_handshake
686
handshake.argtypes = [session_t]
687
handshake.restype = _error_code
688
handshake.errcheck = _retry_on_error
690
transport_set_ptr = _library.gnutls_transport_set_ptr
691
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
692
transport_set_ptr.restype = None
694
bye = _library.gnutls_bye
695
bye.argtypes = [session_t, close_request_t]
696
bye.restype = _error_code
697
bye.errcheck = _retry_on_error
699
check_version = _library.gnutls_check_version
700
check_version.argtypes = [ctypes.c_char_p]
701
check_version.restype = ctypes.c_char_p
703
# All the function declarations below are from gnutls/openpgp.h
705
openpgp_crt_init = _library.gnutls_openpgp_crt_init
706
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
707
openpgp_crt_init.restype = _error_code
709
openpgp_crt_import = _library.gnutls_openpgp_crt_import
710
openpgp_crt_import.argtypes = [openpgp_crt_t,
711
ctypes.POINTER(datum_t),
713
openpgp_crt_import.restype = _error_code
715
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
716
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
717
ctypes.POINTER(ctypes.c_uint)]
718
openpgp_crt_verify_self.restype = _error_code
720
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
721
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
722
openpgp_crt_deinit.restype = None
724
openpgp_crt_get_fingerprint = (
725
_library.gnutls_openpgp_crt_get_fingerprint)
726
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
730
openpgp_crt_get_fingerprint.restype = _error_code
732
# Remove non-public functions
733
del _error_code, _retry_on_error
734
# Create the global "gnutls" object, simulating a module
438
737
def call_pipe(connection, # : multiprocessing.Connection
439
738
func, *args, **kwargs):
440
739
"""This function is meant to be called by multiprocessing.Process
896
1198
for name, athing in
897
1199
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1201
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1202
out_signature = "s",
1203
path_keyword = 'object_path',
1204
connection_keyword = 'connection')
1205
def Introspect(self, object_path, connection):
1206
"""Overloading of standard D-Bus method.
1208
Inserts annotation tags on methods and signals.
1210
xmlstring = dbus.service.Object.Introspect(self, object_path,
1213
document = xml.dom.minidom.parseString(xmlstring)
1215
for if_tag in document.getElementsByTagName("interface"):
1216
# Add annotation tags
1217
for typ in ("method", "signal"):
1218
for tag in if_tag.getElementsByTagName(typ):
1220
for name, prop in (self.
1221
_get_all_dbus_things(typ)):
1222
if (name == tag.getAttribute("name")
1223
and prop._dbus_interface
1224
== if_tag.getAttribute("name")):
1225
annots.update(getattr(
1226
prop, "_dbus_annotations", {}))
1227
for name, value in annots.items():
1228
ann_tag = document.createElement(
1230
ann_tag.setAttribute("name", name)
1231
ann_tag.setAttribute("value", value)
1232
tag.appendChild(ann_tag)
1233
# Add interface annotation tags
1234
for annotation, value in dict(
1235
itertools.chain.from_iterable(
1236
annotations().items()
1237
for name, annotations
1238
in self._get_all_dbus_things("interface")
1239
if name == if_tag.getAttribute("name")
1241
ann_tag = document.createElement("annotation")
1242
ann_tag.setAttribute("name", annotation)
1243
ann_tag.setAttribute("value", value)
1244
if_tag.appendChild(ann_tag)
1245
# Fix argument name for the Introspect method itself
1246
if (if_tag.getAttribute("name")
1247
== dbus.INTROSPECTABLE_IFACE):
1248
for cn in if_tag.getElementsByTagName("method"):
1249
if cn.getAttribute("name") == "Introspect":
1250
for arg in cn.getElementsByTagName("arg"):
1251
if (arg.getAttribute("direction")
1253
arg.setAttribute("name",
1255
xmlstring = document.toxml("utf-8")
1257
except (AttributeError, xml.dom.DOMException,
1258
xml.parsers.expat.ExpatError) as error:
1259
logger.error("Failed to override Introspection method",
1264
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1265
"""A D-Bus object with properties.
1267
Classes inheriting from this can use the dbus_service_property
1268
decorator to expose methods as D-Bus properties. It exposes the
1269
standard Get(), Set(), and GetAll() methods on the D-Bus.
899
1272
def _get_dbus_property(self, interface_name, property_name):
900
1273
"""Returns a bound method if one exists which is a D-Bus
901
1274
property with the specified name and interface.
1006
1389
if prop._dbus_interface
1007
1390
== if_tag.getAttribute("name")):
1008
1391
if_tag.appendChild(tag)
1009
# Add annotation tags
1010
for typ in ("method", "signal", "property"):
1011
for tag in if_tag.getElementsByTagName(typ):
1013
for name, prop in (self.
1014
_get_all_dbus_things(typ)):
1015
if (name == tag.getAttribute("name")
1016
and prop._dbus_interface
1017
== if_tag.getAttribute("name")):
1018
annots.update(getattr(
1019
prop, "_dbus_annotations", {}))
1020
for name, value in annots.items():
1021
ann_tag = document.createElement(
1023
ann_tag.setAttribute("name", name)
1024
ann_tag.setAttribute("value", value)
1025
tag.appendChild(ann_tag)
1026
# Add interface annotation tags
1027
for annotation, value in dict(
1028
itertools.chain.from_iterable(
1029
annotations().items()
1030
for name, annotations
1031
in self._get_all_dbus_things("interface")
1032
if name == if_tag.getAttribute("name")
1034
ann_tag = document.createElement("annotation")
1035
ann_tag.setAttribute("name", annotation)
1036
ann_tag.setAttribute("value", value)
1037
if_tag.appendChild(ann_tag)
1392
# Add annotation tags for properties
1393
for tag in if_tag.getElementsByTagName("property"):
1395
for name, prop in self._get_all_dbus_things(
1397
if (name == tag.getAttribute("name")
1398
and prop._dbus_interface
1399
== if_tag.getAttribute("name")):
1400
annots.update(getattr(
1401
prop, "_dbus_annotations", {}))
1402
for name, value in annots.items():
1403
ann_tag = document.createElement(
1405
ann_tag.setAttribute("name", name)
1406
ann_tag.setAttribute("value", value)
1407
tag.appendChild(ann_tag)
1038
1408
# Add the names to the return values for the
1039
1409
# "org.freedesktop.DBus.Properties" methods
1040
1410
if (if_tag.getAttribute("name")
1058
1428
exc_info=error)
1059
1429
return xmlstring
1432
dbus.OBJECT_MANAGER_IFACE
1433
except AttributeError:
1434
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1436
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1437
"""A D-Bus object with an ObjectManager.
1439
Classes inheriting from this exposes the standard
1440
GetManagedObjects call and the InterfacesAdded and
1441
InterfacesRemoved signals on the standard
1442
"org.freedesktop.DBus.ObjectManager" interface.
1444
Note: No signals are sent automatically; they must be sent
1447
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1448
out_signature = "a{oa{sa{sv}}}")
1449
def GetManagedObjects(self):
1450
"""This function must be overridden"""
1451
raise NotImplementedError()
1453
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1454
signature = "oa{sa{sv}}")
1455
def InterfacesAdded(self, object_path, interfaces_and_properties):
1458
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1459
def InterfacesRemoved(self, object_path, interfaces):
1462
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1463
out_signature = "s",
1464
path_keyword = 'object_path',
1465
connection_keyword = 'connection')
1466
def Introspect(self, object_path, connection):
1467
"""Overloading of standard D-Bus method.
1469
Override return argument name of GetManagedObjects to be
1470
"objpath_interfaces_and_properties"
1472
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1476
document = xml.dom.minidom.parseString(xmlstring)
1478
for if_tag in document.getElementsByTagName("interface"):
1479
# Fix argument name for the GetManagedObjects method
1480
if (if_tag.getAttribute("name")
1481
== dbus.OBJECT_MANAGER_IFACE):
1482
for cn in if_tag.getElementsByTagName("method"):
1483
if (cn.getAttribute("name")
1484
== "GetManagedObjects"):
1485
for arg in cn.getElementsByTagName("arg"):
1486
if (arg.getAttribute("direction")
1490
"objpath_interfaces"
1492
xmlstring = document.toxml("utf-8")
1494
except (AttributeError, xml.dom.DOMException,
1495
xml.parsers.expat.ExpatError) as error:
1496
logger.error("Failed to override Introspection method",
1062
1500
def datetime_to_dbus(dt, variant_level=0):
1063
1501
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1883
2310
def fingerprint(openpgp):
1884
2311
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1885
2312
# New GnuTLS "datum" with the OpenPGP public key
1886
datum = gnutls.library.types.gnutls_datum_t(
2313
datum = gnutls.datum_t(
1887
2314
ctypes.cast(ctypes.c_char_p(openpgp),
1888
2315
ctypes.POINTER(ctypes.c_ubyte)),
1889
2316
ctypes.c_uint(len(openpgp)))
1890
2317
# New empty GnuTLS certificate
1891
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1892
gnutls.library.functions.gnutls_openpgp_crt_init(
2318
crt = gnutls.openpgp_crt_t()
2319
gnutls.openpgp_crt_init(ctypes.byref(crt))
1894
2320
# Import the OpenPGP public key into the certificate
1895
gnutls.library.functions.gnutls_openpgp_crt_import(
1896
crt, ctypes.byref(datum),
1897
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
2321
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2322
gnutls.OPENPGP_FMT_RAW)
1898
2323
# Verify the self signature in the key
1899
2324
crtverify = ctypes.c_uint()
1900
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1901
crt, 0, ctypes.byref(crtverify))
2325
gnutls.openpgp_crt_verify_self(crt, 0,
2326
ctypes.byref(crtverify))
1902
2327
if crtverify.value != 0:
1903
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1904
raise gnutls.errors.CertificateSecurityError(
2328
gnutls.openpgp_crt_deinit(crt)
2329
raise gnutls.CertificateSecurityError("Verify failed")
1906
2330
# New buffer for the fingerprint
1907
2331
buf = ctypes.create_string_buffer(20)
1908
2332
buf_len = ctypes.c_size_t()
1909
2333
# Get the fingerprint from the certificate into the buffer
1910
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1911
crt, ctypes.byref(buf), ctypes.byref(buf_len))
2334
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2335
ctypes.byref(buf_len))
1912
2336
# Deinit the certificate
1913
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2337
gnutls.openpgp_crt_deinit(crt)
1914
2338
# Convert the buffer to a Python bytestring
1915
2339
fpr = ctypes.string_at(buf, buf_len.value)
1916
2340
# Convert the bytestring to hexadecimal notation
3229
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2761
3231
@dbus.service.signal(_interface, signature="os")
2762
3232
def ClientRemoved(self, objpath, name):
3236
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2766
3238
@dbus.service.method(_interface, out_signature="ao")
2767
3239
def GetAllClients(self):
2769
3241
return dbus.Array(c.dbus_object_path for c in
2770
tcp_server.clients.itervalues())
3242
tcp_server.clients.values())
3244
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2772
3246
@dbus.service.method(_interface,
2773
3247
out_signature="a{oa{sv}}")
2774
3248
def GetAllClientsWithProperties(self):
2776
3250
return dbus.Dictionary(
2777
{ c.dbus_object_path: c.GetAll("")
2778
for c in tcp_server.clients.itervalues() },
3251
{ c.dbus_object_path: c.GetAll(
3252
"se.recompile.Mandos.Client")
3253
for c in tcp_server.clients.values() },
2779
3254
signature="oa{sv}")
2781
3256
@dbus.service.method(_interface, in_signature="o")
2782
3257
def RemoveClient(self, object_path):
2784
for c in tcp_server.clients.itervalues():
3259
for c in tcp_server.clients.values():
2785
3260
if c.dbus_object_path == object_path:
2786
3261
del tcp_server.clients[c.name]
2787
3262
c.remove_from_connection()
2788
# Don't signal anything except ClientRemoved
3263
# Don't signal the disabling
2789
3264
c.disable(quiet=True)
2791
self.ClientRemoved(object_path, c.name)
3265
# Emit D-Bus signal for removal
3266
self.client_removed_signal(c)
2793
3268
raise KeyError(object_path)
3272
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3273
out_signature = "a{oa{sa{sv}}}")
3274
def GetManagedObjects(self):
3276
return dbus.Dictionary(
3277
{ client.dbus_object_path:
3279
{ interface: client.GetAll(interface)
3281
client._get_all_interface_names()})
3282
for client in tcp_server.clients.values()})
3284
def client_added_signal(self, client):
3285
"""Send the new standard signal and the old signal"""
3287
# New standard signal
3288
self.InterfacesAdded(
3289
client.dbus_object_path,
3291
{ interface: client.GetAll(interface)
3293
client._get_all_interface_names()}))
3295
self.ClientAdded(client.dbus_object_path)
3297
def client_removed_signal(self, client):
3298
"""Send the new standard signal and the old signal"""
3300
# New standard signal
3301
self.InterfacesRemoved(
3302
client.dbus_object_path,
3303
client._get_all_interface_names())
3305
self.ClientRemoved(client.dbus_object_path,
2797
3308
mandos_dbus_service = MandosDBusService()