QSslConfiguration Class | Qt Network 5.6

Qt 5.6 | Qt Network | C++ Classes | QSslConfiguration

Qt 5.6.2 Reference Documentation

# QSslConfiguration Class

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

Header: | #include <QSslConfiguration>
qmake: | QT += network
Since: | Qt 4.4

- List of all members, including inherited members

Note: All functions in this class are reentrant.

## Public Types

enum | NextProtocolNegotiationStatus { NextProtocolNegotiationNone, NextProtocolNegotiationNegotiated, NextProtocolNegotiationUnsupported }

## Public Functions

| QSslConfiguration()
| QSslConfiguration(const QSslConfiguration &other)
| ~QSslConfiguration()
QList<QByteArray> | allowedNextProtocols() const
QList<QSslCertificate> | caCertificates() const
QList<QSslCipher> | ciphers() const
QVector<QSslEllipticCurve> | ellipticCurves() const
bool | isNull() const
QSslCertificate | localCertificate() const
QList<QSslCertificate> | localCertificateChain() const
QByteArray | nextNegotiatedProtocol() const
NextProtocolNegotiationStatus | nextProtocolNegotiationStatus() const
QSslCertificate | peerCertificate() const
QList<QSslCertificate> | peerCertificateChain() const
int | peerVerifyDepth() const
QSslSocket::PeerVerifyMode | peerVerifyMode() const
QSslKey | privateKey() const
QSsl::SslProtocol | protocol() const
QSslCipher | sessionCipher() const
QSsl::SslProtocol | sessionProtocol() const
QByteArray | sessionTicket() const
int | sessionTicketLifeTimeHint() const
void | setAllowedNextProtocols(QList<QByteArray> protocols)
void | setCaCertificates(const QList<QSslCertificate> &certificates)
void | setCiphers(const QList<QSslCipher> &ciphers)
void | setEllipticCurves(const QVector<QSslEllipticCurve> &curves)
void | setLocalCertificate(const QSslCertificate &certificate)
void | setLocalCertificateChain(const QList<QSslCertificate> &localChain)
void | setPeerVerifyDepth(int depth)
void | setPeerVerifyMode(QSslSocket::PeerVerifyMode mode)
void | setPrivateKey(const QSslKey &key)
void | setProtocol(QSsl::SslProtocol protocol)
void | setSessionTicket(const QByteArray &sessionTicket)
void | setSslOption(QSsl::SslOption option, bool on)
void | swap(QSslConfiguration &other)
bool | testSslOption(QSsl::SslOption option) const
bool | operator!=(const QSslConfiguration &other) const
QSslConfiguration & | operator=(QSslConfiguration &&other)
QSslConfiguration & | operator=(const QSslConfiguration &other)
bool | operator==(const QSslConfiguration &other) const

## Static Public Members

const char | NextProtocolHttp1_1[]
const char | NextProtocolSpdy3_0[]
QSslConfiguration | defaultConfiguration()
void | setDefaultConfiguration(const QSslConfiguration &configuration)
QList<QSslCipher> | supportedCiphers()
QVector<QSslEllipticCurve> | supportedEllipticCurves()
QList<QSslCertificate> | systemCaCertificates()

## Detailed Description

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

QSslConfiguration is used by Qt networking classes to relay information about an open SSL connection and to allow the application to control certain features of that connection.

The settings that QSslConfiguration currently supports are:

- The SSL/TLS protocol to be used
- The certificate to be presented to the peer during connection and its associated private key
- The ciphers allowed to be used for encrypting the connection
- The list of Certificate Authorities certificates that are used to validate the peer's certificate

These settings are applied only during the connection handshake. Setting them after the connection has been established has no effect.

The state that QSslConfiguration supports are:

- The certificate the peer presented during handshake, along with the chain leading to a CA certificate
- The cipher used to encrypt this session

The state can only be obtained once the SSL connection starts, but not necessarily before it's done. Some settings may change during the course of the SSL connection without need to restart it (for instance, the cipher can be changed over time).

State in QSslConfiguration objects cannot be changed.

QSslConfiguration can be used with QSslSocket and the Network Access API.

Note that changing settings in QSslConfiguration is not enough to change the settings in the related SSL connection. You must call setSslConfiguration on a modified QSslConfiguration object to achieve that. The following example illustrates how to change the protocol to TLSv1_0 in a QSslSocket object:

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

See also QSsl::SslProtocol, QSslCertificate, QSslCipher, QSslKey, QSslSocket, QNetworkAccessManager, QSslSocket::sslConfiguration(), and QSslSocket::setSslConfiguration().

## Member Type Documentation

### enum QSslConfiguration::NextProtocolNegotiationStatus

Describes the status of the Next Protocol Negotiation (NPN).

Constant | Value | Description
--- | --- | ---
`QSslConfiguration::NextProtocolNegotiationNone` | `0` | No application protocol has been negotiated (yet).
`QSslConfiguration::NextProtocolNegotiationNegotiated` | `1` | A next protocol has been negotiated (see nextNegotiatedProtocol()).
`QSslConfiguration::NextProtocolNegotiationUnsupported` | `2` | The client and server could not agree on a common next application protocol.

## Member Function Documentation

### 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(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.

### QList<QByteArray> QSslConfiguration::allowedNextProtocols() const

This function returns the allowed protocols to be negotiated with the server through the Next Protocol Negotiation (NPN) 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.

### 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 QSslSocket's addCaCertificate() and addCaCertificates().

See also setCaCertificates().

### 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 (meaning either TLS 1.0 or SSL 3 will be used)
- 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().

### 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.

### 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) TLS extension was enabled. In order for the NPN 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().

### NextProtocolNegotiationStatus QSslConfiguration::nextProtocolNegotiationStatus() const

This function returns the status of the Next Protocol Negotiation (NPN). 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.

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

### 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.

Note: When persisting the session ticket to disk or similar, be careful not to expose the session to a potential attacker, as knowledge of the session allows for eavesdropping on data encrypted with the session parameters.

This function was introduced in Qt 5.2.

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

### 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, and setSslOption().

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

This function sets the allowed protocols to be negotiated with the server through the Next Protocol Negotiation (NPN) TLS extension; each element in protocols must define one allowed protocol. The function must be called explicitly before connecting to send the NPN 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::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().

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

### 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::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::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, and setSslOption().

### 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(), and defaultConfiguration().

### 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==().

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

Move-assignment operator.

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

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

### 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!=().

## Member Variable Documentation

### const char QSslConfiguration::NextProtocolHttp1_1[]

This variable holds the value used for negotiating HTTP 1.1 during the Next Protocol Negotiation.

### const char QSslConfiguration::NextProtocolSpdy3_0[]

This variable holds the value used for negotiating SPDY 3.0 during the Next Protocol Negotiation.