QSslConfiguration Class

 QSslConfiguration config = sslSocket.sslConfiguration();
 config.setProtocol(QSsl::TlsV1_0);
 sslSocket.setSslConfiguration(config);

Member Function Documentation

QSslConfiguration::QSslConfiguration(const QSslConfiguration &other)

Copies the configuration and state of other. If other is null, this object will be null too.

QSslConfiguration::QSslConfiguration()

Constructs an empty SSL configuration. This configuration contains no valid settings and the state will be empty. isNull() will return true after this constructor is called.

Once any setter methods are called, isNull() will return false.

QSslConfiguration &QSslConfiguration::operator=(const QSslConfiguration &other)

Copies the configuration and state of other. If other is null, this object will be null too.

QSslConfiguration::~QSslConfiguration()

Releases any resources held by QSslConfiguration.

void QSslConfiguration::addCaCertificate(const QSslCertificate &certificate)

Adds certificate to this configuration's CA certificate database. The certificate database must be set prior to the SSL handshake. The CA certificate database is used by the socket during the handshake phase to validate the peer's certificate.

This function was introduced in Qt 5.15.

See also caCertificates(), setCaCertificates(), and addCaCertificates().

bool QSslConfiguration::addCaCertificates(const QString &path, QSsl::EncodingFormat format = QSsl::Pem, QSslCertificate::PatternSyntax syntax = QSslCertificate::PatternSyntax::FixedString)

Searches all files in the path for certificates encoded in the specified format and adds them to this socket's CA certificate database. path must be a file or a pattern matching one or more files, as specified by syntax. Returns true if one or more certificates are added to the socket's CA certificate database; otherwise returns false.

The CA certificate database is used by the socket during the handshake phase to validate the peer's certificate.

For more precise control, use addCaCertificate().

This function was introduced in Qt 5.15.

See also addCaCertificate() and QSslCertificate::fromPath().

void QSslConfiguration::addCaCertificates(const QList<QSslCertificate> &certificates)

Adds certificates to this configuration's CA certificate database. The certificate database must be set prior to the SSL handshake. The CA certificate database is used by the socket during the handshake phase to validate the peer's certificate.

This function was introduced in Qt 5.15.

See also caCertificates(), setCaCertificates(), and addCaCertificate().

QList<QByteArray> QSslConfiguration::allowedNextProtocols() const

This function returns the allowed protocols to be negotiated with the server through the Next Protocol Negotiation (NPN) or Application-Layer Protocol Negotiation (ALPN) TLS extension, as set by setAllowedNextProtocols().

This function was introduced in Qt 5.3.

See also nextNegotiatedProtocol(), nextProtocolNegotiationStatus(), setAllowedNextProtocols(), QSslConfiguration::NextProtocolSpdy3_0, and QSslConfiguration::NextProtocolHttp1_1.

QMap<QByteArray, QVariant> QSslConfiguration::backendConfiguration() const

Returns the backend-specific configuration.

Only options set by setBackendConfigurationOption() or setBackendConfiguration() will be returned. The internal standard configuration of the backend is not reported.

This function was introduced in Qt 5.11.

See also setBackendConfigurationOption() and setBackendConfiguration().

QList<QSslCertificate> QSslConfiguration::caCertificates() const

Returns this connection's CA certificate database. The CA certificate database is used by the socket during the handshake phase to validate the peer's certificate. It can be modified prior to the handshake with setCaCertificates(), or with addCaCertificate() and addCaCertificates().

See also setCaCertificates(), addCaCertificate(), and addCaCertificates().

QList<QSslCipher> QSslConfiguration::ciphers() const

Returns this connection's current cryptographic cipher suite. This list is used during the handshake phase for choosing a session cipher. The returned list of ciphers is ordered by descending preference. (i.e., the first cipher in the list is the most preferred cipher). The session cipher will be the first one in the list that is also supported by the peer.

By default, the handshake phase can choose any of the ciphers supported by this system's SSL libraries, which may vary from system to system. The list of ciphers supported by this system's SSL libraries is returned by QSslSocket::supportedCiphers(). You can restrict the list of ciphers used for choosing the session cipher for this socket by calling setCiphers() with a subset of the supported ciphers. You can revert to using the entire set by calling setCiphers() with the list returned by QSslSocket::supportedCiphers().

See also setCiphers() and QSslSocket::supportedCiphers().

[static] QSslConfiguration QSslConfiguration::defaultConfiguration()

Returns the default SSL configuration to be used in new SSL connections.

The default SSL configuration consists of:

• no local certificate and no private key
• protocol SecureProtocols
• the system's default CA certificate list
• the cipher list equal to the list of the SSL libraries' supported SSL ciphers that are 128 bits or more

See also QSslSocket::supportedCiphers() and setDefaultConfiguration().

[static] QSslConfiguration QSslConfiguration::defaultDtlsConfiguration()

Returns the default DTLS configuration to be used in new DTLS connections.

The default DTLS configuration consists of:

• no local certificate and no private key
• protocol DtlsV1_2OrLater
• the system's default CA certificate list
• the cipher list equal to the list of the SSL libraries' supported TLS 1.2 ciphers that use 128 or more secret bits for the cipher.

See also setDefaultDtlsConfiguration().

QSslDiffieHellmanParameters QSslConfiguration::diffieHellmanParameters() const

Retrieves the current set of Diffie-Hellman parameters.

If no Diffie-Hellman parameters have been set, the QSslConfiguration object defaults to using the 1024-bit MODP group from RFC 2409.

This function was introduced in Qt 5.8.

See also setDiffieHellmanParameters().

bool QSslConfiguration::dtlsCookieVerificationEnabled() const

This function returns true if DTLS cookie verification was enabled on a server-side socket.

See also setDtlsCookieVerificationEnabled().

QVector<QSslEllipticCurve> QSslConfiguration::ellipticCurves() const

Returns this connection's current list of elliptic curves. This list is used during the handshake phase for choosing an elliptic curve (when using an elliptic curve cipher). The returned list of curves is ordered by descending preference (i.e., the first curve in the list is the most preferred one).

By default, the handshake phase can choose any of the curves supported by this system's SSL libraries, which may vary from system to system. The list of curves supported by this system's SSL libraries is returned by QSslSocket::supportedEllipticCurves().

You can restrict the list of curves used for choosing the session cipher for this socket by calling setEllipticCurves() with a subset of the supported ciphers. You can revert to using the entire set by calling setEllipticCurves() with the list returned by QSslSocket::supportedEllipticCurves().

This function was introduced in Qt 5.5.

See also setEllipticCurves.

QSslKey QSslConfiguration::ephemeralServerKey() const

Returns the ephemeral server key used for cipher algorithms with forward secrecy, e.g. DHE-RSA-AES128-SHA.

The ephemeral key is only available when running in client mode, i.e. QSslSocket::SslClientMode. When running in server mode or using a cipher algorithm without forward secrecy a null key is returned. The ephemeral server key will be set before emitting the encrypted() signal.

This function was introduced in Qt 5.7.

bool QSslConfiguration::isNull() const

Returns true if this is a null QSslConfiguration object.

A QSslConfiguration object is null if it has been default-constructed and no setter methods have been called.

See also setProtocol(), setLocalCertificate(), setPrivateKey(), setCiphers(), and setCaCertificates().

QSslCertificate QSslConfiguration::localCertificate() const

Returns the certificate to be presented to the peer during the SSL handshake process.

See also setLocalCertificate().

QList<QSslCertificate> QSslConfiguration::localCertificateChain() const

Returns the certificate chain to be presented to the peer during the SSL handshake process.

This function was introduced in Qt 5.1.

See also setLocalCertificateChain() and localCertificate().

QByteArray QSslConfiguration::nextNegotiatedProtocol() const

This function returns the protocol negotiated with the server if the Next Protocol Negotiation (NPN) or Application-Layer Protocol Negotiation (ALPN) TLS extension was enabled. In order for the NPN/ALPN extension to be enabled, setAllowedNextProtocols() needs to be called explicitly before connecting to the server.

If no protocol could be negotiated or the extension was not enabled, this function returns a QByteArray which is null.

This function was introduced in Qt 5.3.

See also setAllowedNextProtocols() and nextProtocolNegotiationStatus().

QSslConfiguration::NextProtocolNegotiationStatus QSslConfiguration::nextProtocolNegotiationStatus() const

This function returns the status of the Next Protocol Negotiation (NPN) or Application-Layer Protocol Negotiation (ALPN). If the feature has not been enabled through setAllowedNextProtocols(), this function returns NextProtocolNegotiationNone. The status will be set before emitting the encrypted() signal.

This function was introduced in Qt 5.3.

See also setAllowedNextProtocols(), allowedNextProtocols(), nextNegotiatedProtocol(), and QSslConfiguration::NextProtocolNegotiationStatus.

bool QSslConfiguration::ocspStaplingEnabled() const

Returns true if OCSP stapling was enabled by setOCSPStaplingEnabled(), otherwise false (which is the default value).

This function was introduced in Qt 5.13.

See also setOcspStaplingEnabled().

QSslCertificate QSslConfiguration::peerCertificate() const

Returns the peer's digital certificate (i.e., the immediate certificate of the host you are connected to), or a null certificate, if the peer has not assigned a certificate.

The peer certificate is checked automatically during the handshake phase, so this function is normally used to fetch the certificate for display or for connection diagnostic purposes. It contains information about the peer, including its host name, the certificate issuer, and the peer's public key.

Because the peer certificate is set during the handshake phase, it is safe to access the peer certificate from a slot connected to the QSslSocket::sslErrors() signal, QNetworkReply::sslErrors() signal, or the QSslSocket::encrypted() signal.

If a null certificate is returned, it can mean the SSL handshake failed, or it can mean the host you are connected to doesn't have a certificate, or it can mean there is no connection.

If you want to check the peer's complete chain of certificates, use peerCertificateChain() to get them all at once.

See also peerCertificateChain(), QSslSocket::sslErrors(), QSslSocket::ignoreSslErrors(), QNetworkReply::sslErrors(), and QNetworkReply::ignoreSslErrors().

QList<QSslCertificate> QSslConfiguration::peerCertificateChain() const

Returns the peer's chain of digital certificates, starting with the peer's immediate certificate and ending with the CA's certificate.

Peer certificates are checked automatically during the handshake phase. This function is normally used to fetch certificates for display, or for performing connection diagnostics. Certificates contain information about the peer and the certificate issuers, including host name, issuer names, and issuer public keys.

Because the peer certificate is set during the handshake phase, it is safe to access the peer certificate from a slot connected to the QSslSocket::sslErrors() signal, QNetworkReply::sslErrors() signal, or the QSslSocket::encrypted() signal.

If an empty list is returned, it can mean the SSL handshake failed, or it can mean the host you are connected to doesn't have a certificate, or it can mean there is no connection.

If you want to get only the peer's immediate certificate, use peerCertificate().

See also peerCertificate(), QSslSocket::sslErrors(), QSslSocket::ignoreSslErrors(), QNetworkReply::sslErrors(), and QNetworkReply::ignoreSslErrors().

int QSslConfiguration::peerVerifyDepth() const

Returns the maximum number of certificates in the peer's certificate chain to be checked during the SSL handshake phase, or 0 (the default) if no maximum depth has been set, indicating that the whole certificate chain should be checked.

The certificates are checked in issuing order, starting with the peer's own certificate, then its issuer's certificate, and so on.

See also setPeerVerifyDepth() and peerVerifyMode().

QSslSocket::PeerVerifyMode QSslConfiguration::peerVerifyMode() const

Returns the verify mode. This mode decides whether QSslSocket should request a certificate from the peer (i.e., the client requests a certificate from the server, or a server requesting a certificate from the client), and whether it should require that this certificate is valid.

The default mode is AutoVerifyPeer, which tells QSslSocket to use VerifyPeer for clients, QueryPeer for servers.

See also setPeerVerifyMode().

QByteArray QSslConfiguration::preSharedKeyIdentityHint() const

Returns the identity hint.

This function was introduced in Qt 5.8.

See also setPreSharedKeyIdentityHint().

QSslKey QSslConfiguration::privateKey() const

Returns the SSL key assigned to this connection or a null key if none has been assigned yet.

See also setPrivateKey() and localCertificate().

QSsl::SslProtocol QSslConfiguration::protocol() const

Returns the protocol setting for this SSL configuration.

See also setProtocol().

QSslCipher QSslConfiguration::sessionCipher() const

Returns the socket's cryptographic cipher, or a null cipher if the connection isn't encrypted. The socket's cipher for the session is set during the handshake phase. The cipher is used to encrypt and decrypt data transmitted through the socket.

The SSL infrastructure also provides functions for setting the ordered list of ciphers from which the handshake phase will eventually select the session cipher. This ordered list must be in place before the handshake phase begins.

See also ciphers(), setCiphers(), and QSslSocket::supportedCiphers().

QSsl::SslProtocol QSslConfiguration::sessionProtocol() const

Returns the socket's SSL/TLS protocol or UnknownProtocol if the connection isn't encrypted. The socket's protocol for the session is set during the handshake phase.

This function was introduced in Qt 5.4.

See also protocol() and setProtocol().

QByteArray QSslConfiguration::sessionTicket() const

If QSsl::SslOptionDisableSessionPersistence was turned off, this function returns the session ticket used in the SSL handshake in ASN.1 format, suitable to e.g. be persisted to disk. If no session ticket was used or QSsl::SslOptionDisableSessionPersistence was not turned off, this function returns an empty QByteArray.

This function was introduced in Qt 5.2.

See also setSessionTicket(), QSsl::SslOptionDisableSessionPersistence, setSslOption(), and QSslSocket::newSessionTicketReceived().

int QSslConfiguration::sessionTicketLifeTimeHint() const

If QSsl::SslOptionDisableSessionPersistence was turned off, this function returns the session ticket life time hint sent by the server (which might be 0). If the server did not send a session ticket (e.g. when resuming a session or when the server does not support it) or QSsl::SslOptionDisableSessionPersistence was not turned off, this function returns -1.

This function was introduced in Qt 5.2.

See also sessionTicket(), QSsl::SslOptionDisableSessionPersistence, setSslOption(), and QSslSocket::newSessionTicketReceived().

void QSslConfiguration::setAllowedNextProtocols(QList<QByteArray> protocols)

This function sets the allowed protocols to be negotiated with the server through the Next Protocol Negotiation (NPN) or Application-Layer Protocol Negotiation (ALPN) TLS extension; each element in protocols must define one allowed protocol. The function must be called explicitly before connecting to send the NPN/ALPN extension in the SSL handshake. Whether or not the negotiation succeeded can be queried through nextProtocolNegotiationStatus().

This function was introduced in Qt 5.3.

See also nextNegotiatedProtocol(), nextProtocolNegotiationStatus(), allowedNextProtocols(), QSslConfiguration::NextProtocolSpdy3_0, and QSslConfiguration::NextProtocolHttp1_1.

void QSslConfiguration::setBackendConfiguration(const QMap<QByteArray, QVariant> &backendConfiguration = QMap<QByteArray, QVariant>())

Sets or clears the backend-specific configuration.

Without a backendConfiguration parameter this function will clear the backend-specific configuration. More information about the supported options is available in the documentation of setBackendConfigurationOption().

This function was introduced in Qt 5.11.

See also backendConfiguration() and setBackendConfigurationOption().

void QSslConfiguration::setBackendConfigurationOption(const QByteArray &name, const QVariant &value)

Sets the option name in the backend-specific configuration to value.

Options supported by the OpenSSL (>= 1.0.2) backend are available in the supported configuration file commands documentation. The expected type for the value parameter is a QByteArray for all options. The examples show how to use some of the options.

This function was introduced in Qt 5.11.

See also backendConfiguration() and setBackendConfiguration().

void QSslConfiguration::setCaCertificates(const QList<QSslCertificate> &certificates)

Sets this socket's CA certificate database to be certificates. The certificate database must be set prior to the SSL handshake. The CA certificate database is used by the socket during the handshake phase to validate the peer's certificate.

See also caCertificates(), addCaCertificates(), and addCaCertificate().

void QSslConfiguration::setCiphers(const QList<QSslCipher> &ciphers)

Sets the cryptographic cipher suite for this socket to ciphers, which must contain a subset of the ciphers in the list returned by supportedCiphers().

Restricting the cipher suite must be done before the handshake phase, where the session cipher is chosen.

See also ciphers() and QSslSocket::supportedCiphers().

[static] void QSslConfiguration::setDefaultConfiguration(const QSslConfiguration &configuration)

Sets the default SSL configuration to be used in new SSL connections to be configuration. Existing connections are not affected by this call.

See also QSslSocket::supportedCiphers() and defaultConfiguration().

[static] void QSslConfiguration::setDefaultDtlsConfiguration(const QSslConfiguration &configuration)

Sets the default DTLS configuration to be used in new DTLS connections to be configuration. Existing connections are not affected by this call.

See also defaultDtlsConfiguration().

void QSslConfiguration::setDiffieHellmanParameters(const QSslDiffieHellmanParameters &dhparams)

Sets a custom set of Diffie-Hellman parameters to be used by this socket when functioning as a server to dhparams.

If no Diffie-Hellman parameters have been set, the QSslConfiguration object defaults to using the 1024-bit MODP group from RFC 2409.

This function was introduced in Qt 5.8.

See also diffieHellmanParameters().

void QSslConfiguration::setDtlsCookieVerificationEnabled(bool enable)

This function enables DTLS cookie verification when enable is true.

See also dtlsCookieVerificationEnabled().

void QSslConfiguration::setEllipticCurves(const QVector<QSslEllipticCurve> &curves)

Sets the list of elliptic curves to be used by this socket to curves, which must contain a subset of the curves in the list returned by supportedEllipticCurves().

Restricting the elliptic curves must be done before the handshake phase, where the session cipher is chosen.

This function was introduced in Qt 5.5.

See also ellipticCurves.

void QSslConfiguration::setLocalCertificate(const QSslCertificate &certificate)

Sets the certificate to be presented to the peer during SSL handshake to be certificate.

Setting the certificate once the connection has been established has no effect.

A certificate is the means of identification used in the SSL process. The local certificate is used by the remote end to verify the local user's identity against its list of Certification Authorities. In most cases, such as in HTTP web browsing, only servers identify to the clients, so the client does not send a certificate.

See also localCertificate().

void QSslConfiguration::setLocalCertificateChain(const QList<QSslCertificate> &localChain)

Sets the certificate chain to be presented to the peer during the SSL handshake to be localChain.

Setting the certificate chain once the connection has been established has no effect.

A certificate is the means of identification used in the SSL process. The local certificate is used by the remote end to verify the local user's identity against its list of Certification Authorities. In most cases, such as in HTTP web browsing, only servers identify to the clients, so the client does not send a certificate.

Unlike QSslConfiguration::setLocalCertificate() this method allows you to specify any intermediate certificates required in order to validate your certificate. The first item in the list must be the leaf certificate.

This function was introduced in Qt 5.1.

See also localCertificateChain().

void QSslConfiguration::setOcspStaplingEnabled(bool enabled)

If enabled is true, client QSslSocket will send a certificate status request to its peer when initiating a handshake. During the handshake QSslSocket will verify the server's response. This value must be set before the handshake starts.

This function was introduced in Qt 5.13.

See also ocspStaplingEnabled().

void QSslConfiguration::setPeerVerifyDepth(int depth)

Sets the maximum number of certificates in the peer's certificate chain to be checked during the SSL handshake phase, to depth. Setting a depth of 0 means that no maximum depth is set, indicating that the whole certificate chain should be checked.

The certificates are checked in issuing order, starting with the peer's own certificate, then its issuer's certificate, and so on.

See also peerVerifyDepth() and setPeerVerifyMode().

void QSslConfiguration::setPeerVerifyMode(QSslSocket::PeerVerifyMode mode)

Sets the verify mode to mode. This mode decides whether QSslSocket should request a certificate from the peer (i.e., the client requests a certificate from the server, or a server requesting a certificate from the client), and whether it should require that this certificate is valid.

The default mode is AutoVerifyPeer, which tells QSslSocket to use VerifyPeer for clients, QueryPeer for servers.

See also peerVerifyMode().

void QSslConfiguration::setPreSharedKeyIdentityHint(const QByteArray &hint)

Sets the identity hint for a preshared key authentication to hint. This will affect the next initiated handshake; calling this function on an already-encrypted socket will not affect the socket's identity hint.

The identity hint is used in QSslSocket::SslServerMode only!

This function was introduced in Qt 5.8.

See also preSharedKeyIdentityHint().

void QSslConfiguration::setPrivateKey(const QSslKey &key)

Sets the connection's private key to key. The private key and the local certificate are used by clients and servers that must prove their identity to SSL peers.

Both the key and the local certificate are required if you are creating an SSL server socket. If you are creating an SSL client socket, the key and local certificate are required if your client must identify itself to an SSL server.

See also privateKey() and setLocalCertificate().

void QSslConfiguration::setProtocol(QSsl::SslProtocol protocol)

Sets the protocol setting for this configuration to be protocol.

Setting the protocol once the connection has already been established has no effect.

See also protocol().

void QSslConfiguration::setSessionTicket(const QByteArray &sessionTicket)

Sets the session ticket to be used in an SSL handshake. QSsl::SslOptionDisableSessionPersistence must be turned off for this to work, and sessionTicket must be in ASN.1 format as returned by sessionTicket().

This function was introduced in Qt 5.2.

See also sessionTicket(), QSsl::SslOptionDisableSessionPersistence, setSslOption(), and QSslSocket::newSessionTicketReceived().

void QSslConfiguration::setSslOption(QSsl::SslOption option, bool on)

Enables or disables an SSL compatibility option. If on is true, the option is enabled. If on is false, the option is disabled.

See also testSslOption().

[static] QList<QSslCipher> QSslConfiguration::supportedCiphers()

Returns the list of cryptographic ciphers supported by this system. This list is set by the system's SSL libraries and may vary from system to system.

This function was introduced in Qt 5.5.

See also ciphers() and setCiphers().

[static] QVector<QSslEllipticCurve> QSslConfiguration::supportedEllipticCurves()

Returns the list of elliptic curves supported by this system. This list is set by the system's SSL libraries and may vary from system to system.

This function was introduced in Qt 5.5.

See also ellipticCurves() and setEllipticCurves().

void QSslConfiguration::swap(QSslConfiguration &other)

Swaps this SSL configuration instance with other. This function is very fast and never fails.

This function was introduced in Qt 5.0.

[static] QList<QSslCertificate> QSslConfiguration::systemCaCertificates()

This function provides the CA certificate database provided by the operating system. The CA certificate database returned by this function is used to initialize the database returned by caCertificates() on the default QSslConfiguration.

This function was introduced in Qt 5.5.

See also caCertificates(), setCaCertificates(), defaultConfiguration(), addCaCertificate(), and addCaCertificates().

bool QSslConfiguration::testSslOption(QSsl::SslOption option) const

Returns true if the specified SSL compatibility option is enabled.

This function was introduced in Qt 4.8.

See also setSslOption().

bool QSslConfiguration::operator!=(const QSslConfiguration &other) const

Returns true if this QSslConfiguration differs from other. Two QSslConfiguration objects are considered different if any state or setting is different.

See also operator==().

bool QSslConfiguration::operator==(const QSslConfiguration &other) const

Returns true if this QSslConfiguration object is equal to other.

Two QSslConfiguration objects are considered equal if they have the exact same settings and state.

See also operator!=().