QSslConfiguration Class Reference
[QtNetwork module]

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 in a QSslSocket object:

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

QSslSocket, QNetworkAccessManager, QSslSocket::sslConfiguration(), QSslSocket::setSslConfiguration()

See also QSsl::SslProtocol, QSslCertificate, QSslCipher, and QSslKey.

Member Function Documentation