Secure Sockets Layer (SSL) Classes#

Classes for secure communication over network sockets.

The classes below provide support for secure network communication using the Secure Sockets Layer (SSL) protocol, using a native TLS backend, the OpenSSL Toolkit , or any appropriate TLS plugin to perform encryption and protocol handling.

From Qt version 5.15 onward, the officially supported version for OpenSSL is 1.1.1 or later.

PySide6.QtNetwork.QDtlsClientVerifier

This class implements server-side DTLS cookie generation and verification.

QDtlsClientVerifier.GeneratorParameters

This class defines parameters for DTLS cookie generator.

QDtls.QDtlsError

Describes errors that can be found by QDtls and QDtlsClientVerifier.

PySide6.QtNetwork.QDtls

This class provides encryption for UDP sockets.

QDtls.HandshakeState

Describes the current state of DTLS handshake.

PySide6.QtNetwork.QOcspResponse

This class represents Online Certificate Status Protocol response.

QOcspResponse.QOcspCertificateStatus

Describes the Online Certificate Status

QOcspResponse.QOcspRevocationReason

Describes the reason for revocation

qssl.html

The QSsl namespace declares enums common to all SSL classes in Qt Network.

QSslSocket.AlertLevel

Describes the level of an alert message

QSslSocket.AlertType

Enumerates possible codes that an alert message can have

QSslSocket.ImplementedClass

Enumerates classes that a TLS backend implements

QSslSocket.SupportedFeature

Enumerates possible features that a TLS backend supports

PySide6.QtNetwork.QSslCertificate

The QSslCertificate class provides a convenient API for an X509 certificate.

PySide6.QtNetwork.QSslCertificateExtension

The QSslCertificateExtension class provides an API for accessing the extensions of an X509 certificate.

PySide6.QtNetwork.QSslCipher

The QSslCipher class represents an SSL cryptographic cipher.

PySide6.QtNetwork.QSslConfiguration

The QSslConfiguration class holds the configuration and state of an SSL connection.

PySide6.QtNetwork.QSslDiffieHellmanParameters

The QSslDiffieHellmanParameters class provides an interface for Diffie-Hellman parameters for servers.

PySide6.QtNetwork.QSslEllipticCurve

Represents an elliptic curve for use by elliptic-curve cipher algorithms.

PySide6.QtNetwork.QSslError

The QSslError class provides an SSL error.

PySide6.QtNetwork.QSslKey

The QSslKey class provides an interface for private and public keys.

PySide6.QtNetwork.QSslPreSharedKeyAuthenticator

The QSslPreSharedKeyAuthenticator class provides authentication data for pre shared keys (PSK) ciphersuites.

PySide6.QtNetwork.QSslSocket

The QSslSocket class provides an SSL encrypted socket for both clients and servers.

For Android applications see Adding OpeSSL Support for Android.

Enabling and Disabling SSL Support when Building Qt from Source#

When building Qt from source, Qt builds plugins for native TLS libraries that are supported for the operating system you are building for. For Windows this means Schannel , while for macOS this is Secure Transport .

On all platforms, the configuration system checks for the presence of the openssl/opensslv.h header provided by source or developer packages of OpenSSL. If found, it will enable and build the OpenSSL backend for Qt.

By default, an OpenSSL-enabled Qt library dynamically loads any installed OpenSSL library at run-time. However, it is possible to link against the library at compile-time by configuring Qt with the -openssl-linked option.

When building a version of Qt linked against OpenSSL, Qt’s build system will use CMake’s FindOpenSSL command to find OpenSSL in several standard locations. You can set the CMake variable OPENSSL_ROOT_DIR to force a specific location.

For example:

configure -openssl-linked -- -D OPENSSL_ROOT_DIR=<openssl_dir>

To disable SSL support in a Qt build, configure Qt with the -no-openssl option.

Considerations While Packaging Your Application#

When you package your application, you may run a tool like windeployqt. This copies all the plugins for the libraries you use to the plugins/ folder. However, for TLS you only need one backend, and you may delete the other plugins before packaging your application. For example, if you’re on Windows and don’t require any of the extra features the OpenSSL backend provides, you can choose to forego shipping the qopensslbackend plugin as well as the OpenSSL library, and simply ship the qschannelbackend plugin.

However, shipping multiple backends is not a problem. Qt will attempt to load the backends in order (with OpenSSL attempted first) until one is successfully loaded. The other backends are then unused.

Datagram Transport Layer Security#

Datagram Transport Layer Security (DTLS) is a protocol that enables security for datagram-based applications, providing them with protection against eavesdropping, tampering, or message forgery. The DTLS protocol is based on the stream-oriented Transport Layer Security (TLS) protocol. QtNetwork enables the use of DTLS with User Datagram Protocol (UDP), as defined by RFC 6347.

Import and Export Restrictions#

Qt binary installers include the OpenSSL libraries used by QtNetwork . However, those are not automatically deployed with applications that are built with Qt. Import and export restrictions apply for some types of software, and for some parts of the world. Developers wishing to use SSL communication in their deployed applications should either ensure that their users have the appropriate libraries installed, or they should consult a suitably qualified legal professional to ensure that applications using code from the OpenSSL project are correctly certified for import and export in relevant regions of the world.