Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QSchannelBackend Class Reference

#include <qtlsbackend_schannel_p.h>

Inheritance diagram for QSchannelBackend:
Collaboration diagram for QSchannelBackend:

Static Public Member Functions

static void ensureInitializedImplementation ()
Static Public Member Functions inherited from QTlsBackend
static QList< QStringavailableBackendNames ()
static QString defaultBackendName ()
static QTlsBackendfindBackend (const QString &backendName)
static QTlsBackendactiveOrAnyBackend ()
static QList< QSsl::SslProtocolsupportedProtocols (const QString &backendName)
static QList< QSsl::SupportedFeaturesupportedFeatures (const QString &backendName)
static QList< QSsl::ImplementedClassimplementedClasses (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)

Private Member Functions

long tlsLibraryVersionNumber () const override
QString tlsLibraryVersionString () const override
long tlsLibraryBuildVersionNumber () const override
QString tlsLibraryBuildVersionString () const override
void ensureInitialized () const override
QString backendName () const override
QList< QSsl::SslProtocolsupportedProtocols () const override
QList< QSsl::SupportedFeaturesupportedFeatures () const override
QList< QSsl::ImplementedClassimplementedClasses () const override
QTlsPrivate::TlsKeycreateKey () const override
QTlsPrivate::X509CertificatecreateCertificate () const override
QTlsPrivate::TlsCryptograph * createTlsCryptograph () const override
QList< QSslCertificatesystemCaCertificates () const override
QTlsPrivate::X509PemReaderPtr X509PemReader () const override
QTlsPrivate::X509DerReaderPtr X509DerReader () const override
QTlsPrivate::X509Pkcs12ReaderPtr X509Pkcs12Reader () const override

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.
Public Member Functions inherited from QTlsBackend
 QTlsBackend ()
 ~QTlsBackend () override
virtual bool isValid () const
virtual QTlsPrivate::DtlsCryptograph * createDtlsCryptograph (class QDtls *qObject, int mode) const
virtual QTlsPrivate::DtlsCookieVerifier * createDtlsCookieVerifier () const
virtual QTlsPrivate::X509ChainVerifyPtr X509Verifier () 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< QStringbindableObjectName ()
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).
QThreadthread () 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>
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>
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
QBindingStoragebindingStorage ()
const QBindingStoragebindingStorage () const
QObjectparent () 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 Attributes inherited from QTlsBackend
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 []
Protected Member Functions inherited from QObject
QObjectsender () 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< QObjectDatad_ptr
Properties inherited from QObject
QString objectName
 the name of this object

Detailed Description

Definition at line 28 of file qtlsbackend_schannel_p.h.

Member Function Documentation

◆ backendName()

QString QSchannelBackend::backendName ( ) const
overrideprivatevirtual

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()

Implements QTlsBackend.

Definition at line 525 of file qtls_schannel.cpp.

◆ createCertificate()

QTlsPrivate::X509Certificate * QSchannelBackend::createCertificate ( ) const
overrideprivatevirtual

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 from QTlsBackend.

Definition at line 582 of file qtls_schannel.cpp.

References QTlsPrivate::X509CertificateSchannel::Q_DISABLE_COPY_MOVE().

Here is the call graph for this function:

◆ createKey()

QTlsPrivate::TlsKey * QSchannelBackend::createKey ( ) const
overrideprivatevirtual

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 from QTlsBackend.

Definition at line 577 of file qtls_schannel.cpp.

◆ createTlsCryptograph()

QTlsPrivate::TlsCryptograph * QSchannelBackend::createTlsCryptograph ( ) const
overrideprivatevirtual

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 from QTlsBackend.

Definition at line 592 of file qtls_schannel.cpp.

References QTlsPrivate::TlsCryptographSchannel::TlsCryptographSchannel().

Here is the call graph for this function:

◆ ensureInitialized()

void QSchannelBackend::ensureInitialized ( ) const
overrideprivatevirtual

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

Reimplemented from QTlsBackend.

Definition at line 500 of file qtls_schannel.cpp.

◆ ensureInitializedImplementation()

void QSchannelBackend::ensureInitializedImplementation ( )
static

Definition at line 505 of file qtls_schannel.cpp.

◆ implementedClasses()

QList< QSsl::ImplementedClass > QSchannelBackend::implementedClasses ( ) const
overrideprivatevirtual

Implements QTlsBackend.

Definition at line 566 of file qtls_schannel.cpp.

◆ supportedFeatures()

QList< QSsl::SupportedFeature > QSchannelBackend::supportedFeatures ( ) const
overrideprivatevirtual

Implements QTlsBackend.

Definition at line 554 of file qtls_schannel.cpp.

◆ supportedProtocols()

QList< QSsl::SslProtocol > QSchannelBackend::supportedProtocols ( ) const
overrideprivatevirtual

Implements QTlsBackend.

Definition at line 530 of file qtls_schannel.cpp.

◆ systemCaCertificates()

QList< QSslCertificate > QSchannelBackend::systemCaCertificates ( ) const
overrideprivatevirtual

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 from QTlsBackend.

Definition at line 587 of file qtls_schannel.cpp.

◆ tlsLibraryBuildVersionNumber()

long QSchannelBackend::tlsLibraryBuildVersionNumber ( ) const
overrideprivatevirtual

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 from QTlsBackend.

Definition at line 489 of file qtls_schannel.cpp.

◆ tlsLibraryBuildVersionString()

QString QSchannelBackend::tlsLibraryBuildVersionString ( ) const
overrideprivatevirtual

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 from QTlsBackend.

Definition at line 494 of file qtls_schannel.cpp.

◆ tlsLibraryVersionNumber()

long QSchannelBackend::tlsLibraryVersionNumber ( ) const
overrideprivatevirtual

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 from QTlsBackend.

Definition at line 473 of file qtls_schannel.cpp.

◆ tlsLibraryVersionString()

QString QSchannelBackend::tlsLibraryVersionString ( ) const
overrideprivatevirtual

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 from QTlsBackend.

Definition at line 479 of file qtls_schannel.cpp.

◆ X509DerReader()

QTlsPrivate::X509DerReaderPtr QSchannelBackend::X509DerReader ( ) const
overrideprivatevirtual

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

See also
QSslCertificate

Reimplemented from QTlsBackend.

Definition at line 622 of file qtls_schannel.cpp.

◆ X509PemReader()

QTlsPrivate::X509PemReaderPtr QSchannelBackend::X509PemReader ( ) const
overrideprivatevirtual

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

See also
QSslCertificate

Reimplemented from QTlsBackend.

Definition at line 617 of file qtls_schannel.cpp.

◆ X509Pkcs12Reader()

QTlsPrivate::X509Pkcs12ReaderPtr QSchannelBackend::X509Pkcs12Reader ( ) const
overrideprivatevirtual

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

See also
QSslCertificate

Reimplemented from QTlsBackend.

Definition at line 627 of file qtls_schannel.cpp.


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