QTlsBackend is a factory class, providing implementations for the QSsl classes. More...

#include <qtlsbackend_p.h>

Inheritance diagram for QTlsBackend:

Collaboration diagram for QTlsBackend:

Public Member Functions
	QTlsBackend ()
	~QTlsBackend () override
virtual bool	isValid () const
virtual long	tlsLibraryVersionNumber () const
virtual QString	tlsLibraryVersionString () const
virtual long	tlsLibraryBuildVersionNumber () const
virtual QString	tlsLibraryBuildVersionString () const
virtual void	ensureInitialized () const
virtual QString	backendName () const =0
virtual QList< QSsl::SslProtocol >	supportedProtocols () const =0
virtual QList< QSsl::SupportedFeature >	supportedFeatures () const =0
virtual QList< QSsl::ImplementedClass >	implementedClasses () const =0
virtual QTlsPrivate::TlsKey *	createKey () const
virtual QTlsPrivate::X509Certificate *	createCertificate () const
virtual QList< QSslCertificate >	systemCaCertificates () const
virtual QTlsPrivate::TlsCryptograph *	createTlsCryptograph () const
virtual QTlsPrivate::DtlsCryptograph *	createDtlsCryptograph (class QDtls *qObject, int mode) const
virtual QTlsPrivate::DtlsCookieVerifier *	createDtlsCookieVerifier () const
virtual QTlsPrivate::X509ChainVerifyPtr	X509Verifier () const
virtual QTlsPrivate::X509PemReaderPtr	X509PemReader () const
virtual QTlsPrivate::X509DerReaderPtr	X509DerReader () const
virtual QTlsPrivate::X509Pkcs12ReaderPtr	X509Pkcs12Reader () const
virtual QList< int >	ellipticCurvesIds () const
virtual int	curveIdFromShortName (const QString &name) const
virtual int	curveIdFromLongName (const QString &name) const
virtual QString	shortNameForId (int cid) const
virtual QString	longNameForId (int cid) const
virtual bool	isTlsNamedCurve (int cid) const
virtual int	dhParametersFromDer (const QByteArray &derData, QByteArray *data) const
virtual int	dhParametersFromPem (const QByteArray &pemData, QByteArray *data) const
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.
bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.
bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.
bool	isQmlObjectType () const
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject receiver, const char member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Static Public Member Functions
static QList< QString >	availableBackendNames ()
static QString	defaultBackendName ()
static QTlsBackend *	findBackend (const QString &backendName)
static QTlsBackend *	activeOrAnyBackend ()
static QList< QSsl::SslProtocol >	supportedProtocols (const QString &backendName)
static QList< QSsl::SupportedFeature >	supportedFeatures (const QString &backendName)
static QList< QSsl::ImplementedClass >	implementedClasses (const QString &backendName)
template<class DynamicType, class TLSObject>
static DynamicType *	backend (const TLSObject &o)
static void	resetBackend (QSslKey &key, QTlsPrivate::TlsKey *keyBackend)
static void	setupClientPskAuth (QSslPreSharedKeyAuthenticator auth, const char hint, int hintLength, unsigned maxIdentityLen, unsigned maxPskLen)
static void	setupServerPskAuth (QSslPreSharedKeyAuthenticator auth, const char identity, const QByteArray &identityHint, unsigned maxPskLen)
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe
static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.
template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)
template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Static Public Attributes
static constexpr const int	nameIndexSchannel = 0
static constexpr const int	nameIndexSecureTransport = 1
static constexpr const int	nameIndexOpenSSL = 2
static constexpr const int	nameIndexCertOnly = 3
static const QString	builtinBackendNames []

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Properties inherited from QObject
QString	objectName
	the name of this object
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

QTlsBackend is a factory class, providing implementations for the QSsl classes.

(Network-private)

The purpose of QTlsBackend is to enable and simplify the addition of new TLS backends to be used by QSslSocket and related classes. Starting from Qt 6.1, these backends have plugin-based design (and thus can co-exist simultaneously, unlike pre 6.1 times), although any given run of a program can only use one of them.

Inheriting from QTlsBackend and creating an object of such a class adds a new backend into the list of available TLS backends.

A new backend must provide a list of classes, features and protocols it supports, and override the corresponding virtual functions that create backend-specific implementations for these QSsl-classes.

The base abstract class - QTlsBackend - provides, where possible, default implementations of its virtual member functions. These default implementations can be overridden by a derived backend class, if needed.

QTlsBackend also provides some auxiliary functions that a derived backend class can use to interact with the internals of network-private classes.

See also: QSslSocket::availableBackends(), supportedFeatures(), supportedProtocols(), implementedClasses()

Definition at line 268 of file qtlsbackend_p.h.

Constructor & Destructor Documentation

◆ QTlsBackend()

QTlsBackend::QTlsBackend ( )

The default constructor, adds a new backend to the list of available backends.

See also: ~QTlsBackend(), availableBackendNames(), QSslSocket::availableBackends()

Definition at line 168 of file qtlsbackend.cpp.

◆ ~QTlsBackend()

QTlsBackend::~QTlsBackend ( )

override

Removes this backend from the list of available backends.

See also: QTlsBackend(), availableBackendNames(), QSslSocket::availableBackends()

Definition at line 186 of file qtlsbackend.cpp.

Member Function Documentation

◆ activeOrAnyBackend()

QTlsBackend * QTlsBackend::activeOrAnyBackend ( )

static

Returns the backend that QSslSocket is using. If Qt was built without TLS support, this function returns a minimal backend that only supports QSslCertificate.

See also: defaultBackend()

Definition at line 633 of file qtlsbackend.cpp.

◆ availableBackendNames()

QList< QString > QTlsBackend::availableBackendNames ( )

static

Returns a list of names of available backends.

Note: This list contains only properly initialized backends.

See also: QTlsBackend(), isValid()

Definition at line 567 of file qtlsbackend.cpp.

◆ backend()

template<class DynamicType, class TLSObject>

DynamicType * QTlsBackend::backend ( const TLSObject & o )

inlinestatic

Definition at line 337 of file qtlsbackend_p.h.

◆ backendName()

virtual QString QTlsBackend::backendName ( ) const

pure virtual

Returns the name of this backend. The name will be reported by QSslSocket::availableBackends(). Example of backend names: "openssl", "schannel", "securetransport".

See also: QSslSocket::availableBackends(), isValid()

Implemented in QSchannelBackend, QSecureTransportBackend, QTlsBackendCertOnly, and QTlsBackendOpenSSL.

◆ createCertificate()

QTlsPrivate::X509Certificate * QTlsBackend::createCertificate ( ) const

virtual

If QSsl::ImplementedClass::Certificate is present in this backend's implementedClasses(), the backend must reimplement this method to return a dynamically-allocated instance of an implementation-specific type, inheriting from the class QTlsPrivate::X509Certificate. The default implementation of this function returns \nullptr.

See also: QSslCertificate, QTlsPrivate::X509Certificate, implementedClasses()

Reimplemented in QSchannelBackend, QSecureTransportBackend, QTlsBackendCertOnly, and QTlsBackendOpenSSL.

Definition at line 299 of file qtlsbackend.cpp.

◆ createDtlsCookieVerifier()

QTlsPrivate::DtlsCookieVerifier * QTlsBackend::createDtlsCookieVerifier ( ) const

virtual

If QSsl::ImplementedClass::DtlsCookie is present in this backend's implementedClasses(), the backend must reimplement this method to return a dynamically-allocated instance of an implementation-specific type, inheriting from the class QTlsPrivate::DtlsCookieVerifier. The default implementation returns \nullptr.

See also: QDtlsClientVerifier, QTlsPrivate::DtlsCookieVerifier, implementedClasses()

Reimplemented in QTlsBackendOpenSSL.

Definition at line 360 of file qtlsbackend.cpp.

◆ createDtlsCryptograph()

QTlsPrivate::DtlsCryptograph * QTlsBackend::createDtlsCryptograph	(	class QDtls *	qObject,
		int	mode ) const

virtual

If QSsl::ImplementedClass::Dtls is present in this backend's implementedClasses(), the backend must reimplement this method to return a dynamically-allocated instance of an implementation-specific type, inheriting from the class QTlsPrivate::DtlsCryptograph. The default implementation of this function returns \nullptr.

See also: QDtls, QTlsPrivate::DtlsCryptograph, implementedClasses()

Reimplemented in QTlsBackendOpenSSL.

Definition at line 343 of file qtlsbackend.cpp.

◆ createKey()

QTlsPrivate::TlsKey * QTlsBackend::createKey ( ) const

virtual

If QSsl::ImplementedClass::Key is present in this backend's implementedClasses(), the backend must reimplement this method to return a dynamically-allocated instance of an implementation-specific type, inheriting from the class QTlsPrivate::TlsKey. The default implementation of this function returns \nullptr.

See also: QSslKey, implementedClasses(), QTlsPrivate::TlsKey

Reimplemented in QSchannelBackend, QSecureTransportBackend, and QTlsBackendOpenSSL.

Definition at line 284 of file qtlsbackend.cpp.

◆ createTlsCryptograph()

QTlsPrivate::TlsCryptograph * QTlsBackend::createTlsCryptograph ( ) const

virtual

If QSsl::ImplementedClass::Socket is present in this backend's implementedClasses(), the backend must reimplement this method to return a dynamically-allocated instance of an implementation-specific type, inheriting from the class QTlsPrivate::TlsCryptograph. The default implementation of this function returns \nullptr.

See also: QSslSocket, QTlsPrivate::TlsCryptograph, implementedClasses()

Reimplemented in QSchannelBackend, QSecureTransportBackend, and QTlsBackendOpenSSL.

Definition at line 328 of file qtlsbackend.cpp.

◆ curveIdFromLongName()

int QTlsBackend::curveIdFromLongName ( const QString & name ) const

virtual

If this backend provides information about available elliptic curves, this function should return a unique integer identifier for a curve named name, which is a conventional long name for the curve. The default implementation returns 0.

Note: The meaning of a curve identifier is implementation-specific.

See also: QSslElliptiCurve::longName()

Reimplemented in QTlsBackendOpenSSL.

Definition at line 467 of file qtlsbackend.cpp.

◆ curveIdFromShortName()

int QTlsBackend::curveIdFromShortName ( const QString & name ) const

virtual

If this backend provides information about available elliptic curves, this function should return a unique integer identifier for a curve named name, which is a conventional short name for the curve. The default implementation returns 0.

Note: The meaning of a curve identifier is implementation-specific.

See also: QSslEllipticCurve::shortName()

Reimplemented in QTlsBackendOpenSSL.

Definition at line 449 of file qtlsbackend.cpp.

◆ defaultBackendName()

QString QTlsBackend::defaultBackendName ( )

static

Returns the name of the backend that QSslSocket() would use by default. If no backend was found, the function returns an empty string.

Definition at line 580 of file qtlsbackend.cpp.

◆ dhParametersFromDer()

int QTlsBackend::dhParametersFromDer	(	const QByteArray &	derData,
		QByteArray *	data ) const

virtual

If this backend supports the class QSslDiffieHellmanParameters, this function is needed for construction of a QSslDiffieHellmanParameters from DER encoded data. This function is expected to return a value that matches an enumerator in QSslDiffieHellmanParameters::Error enumeration. The default implementation of this function returns 0 (equals to QSslDiffieHellmanParameters::NoError).

See also: QSslDiffieHellmanParameters, implementedClasses()

Reimplemented in QTlsBackendOpenSSL.

Definition at line 533 of file qtlsbackend.cpp.

◆ dhParametersFromPem()

int QTlsBackend::dhParametersFromPem	(	const QByteArray &	pemData,
		QByteArray *	data ) const

virtual

If this backend supports the class QSslDiffieHellmanParameters, this function is is needed for construction of a QSslDiffieHellmanParameters from PEM encoded data. This function is expected to return a value that matches an enumerator in QSslDiffieHellmanParameters::Error enumeration. The default implementation of this function returns 0 (equals to QSslDiffieHellmanParameters::NoError).

See also: QSslDiffieHellmanParameters, implementedClasses()

Reimplemented in QTlsBackendOpenSSL.

Definition at line 551 of file qtlsbackend.cpp.

◆ ellipticCurvesIds()

QList< int > QTlsBackend::ellipticCurvesIds ( ) const

virtual

If QSsl::ImplementedClass::EllipticCurve is present in this backend's implementedClasses(), and the backend provides information about supported curves, it must reimplement this method to return a list of unique identifiers of the supported elliptic curves. The default implementation returns an empty list.

Note: The meaning of a curve identifier is implementation-specific.

See also: implemenedClasses(), QSslEllipticCurve

Reimplemented in QTlsBackendOpenSSL.

Definition at line 432 of file qtlsbackend.cpp.

◆ ensureInitialized()

void QTlsBackend::ensureInitialized ( ) const

virtual

QSslSocket and related classes call this function to ensure that backend's internal resources - e.g. CA certificates, or ciphersuites - were properly initialized.

Reimplemented in QSchannelBackend, QSecureTransportBackend, and QTlsBackendOpenSSL.

Definition at line 268 of file qtlsbackend.cpp.

◆ findBackend()

QTlsBackend * QTlsBackend::findBackend ( const QString & backendName )

static

Returns a backend named backendName, if it exists. Otherwise, it returns \nullptr.

See also: backendName(), QSslSocket::availableBackends()

Definition at line 614 of file qtlsbackend.cpp.

◆ implementedClasses() [1/2]

virtual QList< QSsl::ImplementedClass > QTlsBackend::implementedClasses ( ) const

pure virtual

Implemented in QSchannelBackend, QSecureTransportBackend, QTlsBackendCertOnly, and QTlsBackendOpenSSL.

◆ implementedClasses() [2/2]

QList< QSsl::ImplementedClass > QTlsBackend::implementedClasses ( const QString & backendName )

static

Returns a list of classes that a backend named backendName supports. E.g. a backend may implement QSslSocket (QSsl::ImplementedClass::Socket), and QDtls (QSsl::ImplementedClass::Dtls).

See also: QSsl::ImplementedClass

Definition at line 692 of file qtlsbackend.cpp.

◆ isTlsNamedCurve()

bool QTlsBackend::isTlsNamedCurve ( int cid ) const

virtual

Returns true if the elliptic curve identified by cid is one of the named curves, that can be used in the key exchange when using an elliptic curve cipher with TLS; false otherwise. The default implementation returns false.

Note: The meaning of curve identifier is implementation-specific.

Reimplemented in QTlsBackendOpenSSL.

Definition at line 516 of file qtlsbackend.cpp.

◆ isValid()

bool QTlsBackend::isValid ( ) const

virtual

Returns true if this backend was initialised successfully. The default implementation always returns true.

Note: This function must be overridden if a particular backend has a non-trivial initialization that can fail. If reimplemented, returning false will exclude this backend from the list of backends, reported as available by QSslSocket.

See also: QSslSocket::availableBackends()

Reimplemented in QTlsBackendOpenSSL.

Definition at line 204 of file qtlsbackend.cpp.

◆ longNameForId()

QString QTlsBackend::longNameForId ( int cid ) const

virtual

If this backend provides information about available elliptic curves, this function should return a conventional long name for a curve identified by cid. The default implementation returns an empty string.

Note: The meaning of a curve identifier is implementation-specific.

See also: ellipticCurvesIds(), QSslEllipticCurve::shortName()

Reimplemented in QTlsBackendOpenSSL.

Definition at line 501 of file qtlsbackend.cpp.

◆ resetBackend()

void QTlsBackend::resetBackend	(	QSslKey &	key,
		QTlsPrivate::TlsKey *	keyBackend )

static

Auxiliary function. Initializes key to use keyBackend.

Definition at line 707 of file qtlsbackend.cpp.

◆ setupClientPskAuth()

void QTlsBackend::setupClientPskAuth	(	QSslPreSharedKeyAuthenticator *	auth,
		const char *	hint,
		int	hintLength,
		unsigned	maxIdentityLen,
		unsigned	maxPskLen )

static

Auxiliary function. Initializes client-side auth using the hint, hintLength, maxIdentityLength and maxPskLen.

Definition at line 722 of file qtlsbackend.cpp.

◆ setupServerPskAuth()

void QTlsBackend::setupServerPskAuth	(	QSslPreSharedKeyAuthenticator *	auth,
		const char *	identity,
		const QByteArray &	identityHint,
		unsigned	maxPskLen )

static

Auxiliary function. Initializes server-side auth using the identity, identityHint and maxPskLen.

Definition at line 746 of file qtlsbackend.cpp.

◆ shortNameForId()

QString QTlsBackend::shortNameForId ( int cid ) const

virtual

If this backend provides information about available elliptic curves, this function should return a conventional short name for a curve identified by cid. The default implementation returns an empty string.

Note: The meaning of a curve identifier is implementation-specific.

See also: ellipticCurvesIds(), QSslEllipticCurve::shortName()

Reimplemented in QTlsBackendOpenSSL.

Definition at line 484 of file qtlsbackend.cpp.

◆ supportedFeatures() [1/2]

virtual QList< QSsl::SupportedFeature > QTlsBackend::supportedFeatures ( ) const

pure virtual

Implemented in QSchannelBackend, QSecureTransportBackend, QTlsBackendCertOnly, and QTlsBackendOpenSSL.

◆ supportedFeatures() [2/2]

QList< QSsl::SupportedFeature > QTlsBackend::supportedFeatures ( const QString & backendName )

static

Returns a list of features that a backend named backendName supports. E.g. a backend may support PSK (pre-shared keys, defined as QSsl::SupportedFeature::Psk) or ALPN (application layer protocol negotiation, identified by QSsl::SupportedFeature::ClientSideAlpn or QSsl::SupportedFeature::ServerSideAlpn).

See also: QSsl::SupportedFeature

Definition at line 673 of file qtlsbackend.cpp.

◆ supportedProtocols() [1/2]

virtual QList< QSsl::SslProtocol > QTlsBackend::supportedProtocols ( ) const

pure virtual

Implemented in QSchannelBackend, QSecureTransportBackend, QTlsBackendCertOnly, and QTlsBackendOpenSSL.

◆ supportedProtocols() [2/2]

QList< QSsl::SslProtocol > QTlsBackend::supportedProtocols ( const QString & backendName )

static

Returns a list of TLS and DTLS protocol versions, that a backend named backendName supports.

Note: This list is supposed to also include range-based versions, which allows negotiation of protocols during the handshake, so that these versions can be used when configuring QSslSocket (e.g. QSsl::TlsV1_2OrLater).

See also: QSsl::SslProtocol

Definition at line 653 of file qtlsbackend.cpp.

◆ systemCaCertificates()

QList< QSslCertificate > QTlsBackend::systemCaCertificates ( ) const

virtual

This function returns a list of system CA certificates - e.g. certificates, loaded from a system store, if available. This function allows implementation of the class QSslConfiguration. The default implementation of this function returns an empty list.

See also: QSslCertificate, QSslConfiguration

Reimplemented in QSchannelBackend, QSecureTransportBackend, and QTlsBackendOpenSSL.

Definition at line 313 of file qtlsbackend.cpp.

◆ tlsLibraryBuildVersionNumber()

long QTlsBackend::tlsLibraryBuildVersionNumber ( ) const

virtual

Returns an implementation-specific integer value, representing the TLS library's version that this backend was built against (i.e. compile-time library version). The default implementation returns 0.

See also: tlsLibraryVersionNumber()

Reimplemented in QSchannelBackend, and QTlsBackendOpenSSL.

Definition at line 245 of file qtlsbackend.cpp.

◆ tlsLibraryBuildVersionString()

QString QTlsBackend::tlsLibraryBuildVersionString ( ) const

virtual

Returns an implementation-specific string, representing the TLS library's version that this backend was built against (i.e. compile-time version). The default implementation returns an empty string.

See also: tlsLibraryVersionString()

Reimplemented in QSchannelBackend, QSecureTransportBackend, and QTlsBackendOpenSSL.

Definition at line 258 of file qtlsbackend.cpp.

◆ tlsLibraryVersionNumber()

long QTlsBackend::tlsLibraryVersionNumber ( ) const

virtual

Returns an implementations-specific integer value, representing the TLS library's version, that is currently used by this backend (i.e. runtime library version). The default implementation returns 0.

See also: tlsLibraryBuildVersionNumber()

Reimplemented in QSchannelBackend, and QTlsBackendOpenSSL.

Definition at line 217 of file qtlsbackend.cpp.

◆ tlsLibraryVersionString()

QString QTlsBackend::tlsLibraryVersionString ( ) const

virtual

Returns an implementation-specific string, representing the TLS library's version, that is currently used by this backend (i.e. runtime library version). The default implementation returns an empty string.

See also: tlsLibraryBuildVersionString()

Reimplemented in QSchannelBackend, QSecureTransportBackend, and QTlsBackendOpenSSL.

Definition at line 231 of file qtlsbackend.cpp.

◆ X509DerReader()

QTlsPrivate::X509DerReaderPtr QTlsBackend::X509DerReader ( ) const

virtual

Returns a pointer to function, that can read certificates in DER format. The default implementation returns \nullptr.

See also: QSslCertificate

Reimplemented in QSchannelBackend, QSecureTransportBackend, QTlsBackendCertOnly, and QTlsBackendOpenSSL.

Definition at line 402 of file qtlsbackend.cpp.

◆ X509PemReader()

QTlsPrivate::X509PemReaderPtr QTlsBackend::X509PemReader ( ) const

virtual

Returns a pointer to function, that reads certificates in PEM format. The default implementation returns \nullptr.

See also: QSslCertificate

Reimplemented in QSchannelBackend, QSecureTransportBackend, QTlsBackendCertOnly, and QTlsBackendOpenSSL.

Definition at line 389 of file qtlsbackend.cpp.

◆ X509Pkcs12Reader()

QTlsPrivate::X509Pkcs12ReaderPtr QTlsBackend::X509Pkcs12Reader ( ) const

virtual

Returns a pointer to function, that can read certificates in PKCS 12 format. The default implementation returns \nullptr.

See also: QSslCertificate

Reimplemented in QSchannelBackend, and QTlsBackendOpenSSL.

Definition at line 415 of file qtlsbackend.cpp.

◆ X509Verifier()

QTlsPrivate::X509ChainVerifyPtr QTlsBackend::X509Verifier ( ) const

virtual

If QSsl::SupportedFeature::CertificateVerification is present in this backend's supportedFeatures(), the backend must reimplement this method to return a pointer to a function, that checks a certificate (or a chain of certificates) against available CA certificates. The default implementation returns \nullptr.

See also: supportedFeatures(), QSslCertificate

Reimplemented in QTlsBackendOpenSSL.

Definition at line 376 of file qtlsbackend.cpp.

Member Data Documentation

◆ builtinBackendNames

const QString QTlsBackend::builtinBackendNames

static

Initial value:

= {
    QStringLiteral("schannel"),
    QStringLiteral("securetransport"),
    QStringLiteral("openssl"),
    QStringLiteral("cert-only")
}

Definition at line 155 of file qtlsbackend_p.h.

◆ nameIndexCertOnly

const int QTlsBackend::nameIndexCertOnly = 3

staticconstexpr

Definition at line 332 of file qtlsbackend_p.h.

◆ nameIndexOpenSSL

const int QTlsBackend::nameIndexOpenSSL = 2

staticconstexpr

Definition at line 331 of file qtlsbackend_p.h.

◆ nameIndexSchannel

const int QTlsBackend::nameIndexSchannel = 0

staticconstexpr

Definition at line 329 of file qtlsbackend_p.h.

◆ nameIndexSecureTransport

const int QTlsBackend::nameIndexSecureTransport = 1

staticconstexpr

Definition at line 330 of file qtlsbackend_p.h.

The documentation for this class was generated from the following files:

qtbase/src/network/ssl/qtlsbackend_p.h (02ebb11a823d021b0c958907acb88bb19a49ea7c)
qtbase/src/network/ssl/qtlsbackend.cpp (1493a6e8841dcfb8354f841585ac08ed35e9363b)

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QTlsBackend()

◆ ~QTlsBackend()

Member Function Documentation

◆ activeOrAnyBackend()

◆ availableBackendNames()

◆ backend()

◆ backendName()

◆ createCertificate()

◆ createDtlsCookieVerifier()

◆ createDtlsCryptograph()

◆ createKey()

◆ createTlsCryptograph()

◆ curveIdFromLongName()

◆ curveIdFromShortName()

◆ defaultBackendName()

◆ dhParametersFromDer()

◆ dhParametersFromPem()

◆ ellipticCurvesIds()

◆ ensureInitialized()

◆ findBackend()

◆ implementedClasses() [1/2]

◆ implementedClasses() [2/2]

◆ isTlsNamedCurve()

◆ isValid()

◆ longNameForId()

◆ resetBackend()

◆ setupClientPskAuth()

◆ setupServerPskAuth()

◆ shortNameForId()

◆ supportedFeatures() [1/2]

◆ supportedFeatures() [2/2]

◆ supportedProtocols() [1/2]

◆ supportedProtocols() [2/2]

◆ systemCaCertificates()

◆ tlsLibraryBuildVersionNumber()

◆ tlsLibraryBuildVersionString()

◆ tlsLibraryVersionNumber()

◆ tlsLibraryVersionString()

◆ X509DerReader()

◆ X509PemReader()

◆ X509Pkcs12Reader()

◆ X509Verifier()

Member Data Documentation

◆ builtinBackendNames

◆ nameIndexCertOnly

◆ nameIndexOpenSSL

◆ nameIndexSchannel

◆ nameIndexSecureTransport