![]() |
Qt 6.x
The Qt SDK
|
The QSslConfiguration class holds the configuration and state of an SSL connection. More...
#include <qsslconfiguration.h>
Public Types | |
enum | NextProtocolNegotiationStatus { NextProtocolNegotiationNone , NextProtocolNegotiationNegotiated , NextProtocolNegotiationUnsupported } |
Describes the status of the Next Protocol Negotiation (NPN) or Application-Layer Protocol Negotiation (ALPN). More... | |
Public Member Functions | |
QSslConfiguration () | |
\variable QSslConfiguration::NextProtocolHttp1_1 | |
QSslConfiguration (const QSslConfiguration &other) | |
Copies the configuration and state of other. | |
~QSslConfiguration () | |
Releases any resources held by QSslConfiguration. | |
QSslConfiguration & | operator= (QSslConfiguration &&other) noexcept |
QSslConfiguration & | operator= (const QSslConfiguration &other) |
Copies the configuration and state of other. | |
void | swap (QSslConfiguration &other) noexcept |
bool | operator== (const QSslConfiguration &other) const |
Returns true if this QSslConfiguration object is equal to other. | |
bool | operator!= (const QSslConfiguration &other) const |
Returns true if this QSslConfiguration differs from other. | |
bool | isNull () const |
Returns true if this is a null QSslConfiguration object. | |
QSsl::SslProtocol | protocol () const |
Returns the protocol setting for this SSL configuration. | |
void | setProtocol (QSsl::SslProtocol protocol) |
Sets the protocol setting for this configuration to be protocol. | |
QSslSocket::PeerVerifyMode | peerVerifyMode () const |
Returns the verify mode. | |
void | setPeerVerifyMode (QSslSocket::PeerVerifyMode mode) |
Sets the verify mode to mode. | |
int | 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. | |
void | 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. | |
QList< QSslCertificate > | localCertificateChain () const |
Returns the certificate chain to be presented to the peer during the SSL handshake process. | |
void | setLocalCertificateChain (const QList< QSslCertificate > &localChain) |
Sets the certificate chain to be presented to the peer during the SSL handshake to be localChain. | |
QSslCertificate | localCertificate () const |
Returns the certificate to be presented to the peer during the SSL handshake process. | |
void | setLocalCertificate (const QSslCertificate &certificate) |
Sets the certificate to be presented to the peer during SSL handshake to be certificate. | |
QSslCertificate | 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. | |
QList< QSslCertificate > | peerCertificateChain () const |
Returns the peer's chain of digital certificates, starting with the peer's immediate certificate and ending with the CA's certificate. | |
QSslCipher | sessionCipher () const |
Returns the socket's cryptographic \l {QSslCipher} {cipher}, or a null cipher if the connection isn't encrypted. | |
QSsl::SslProtocol | sessionProtocol () const |
Returns the socket's SSL/TLS protocol or UnknownProtocol if the connection isn't encrypted. | |
QSslKey | privateKey () const |
Returns the \l {QSslKey} {SSL key} assigned to this connection or a null key if none has been assigned yet. | |
void | setPrivateKey (const QSslKey &key) |
Sets the connection's private \l {QSslKey} {key} to key. | |
QList< QSslCipher > | ciphers () const |
Returns this connection's current cryptographic cipher suite. | |
void | 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(). | |
void | setCiphers (const QString &ciphers) |
QList< QSslCertificate > | caCertificates () const |
Returns this connection's CA certificate database. | |
void | setCaCertificates (const QList< QSslCertificate > &certificates) |
Sets this socket's CA certificate database to be certificates. | |
bool | addCaCertificates (const QString &path, QSsl::EncodingFormat format=QSsl::Pem, QSslCertificate::PatternSyntax syntax=QSslCertificate::PatternSyntax::FixedString) |
void | addCaCertificate (const QSslCertificate &certificate) |
void | addCaCertificates (const QList< QSslCertificate > &certificates) |
void | setSslOption (QSsl::SslOption option, bool on) |
Enables or disables an SSL compatibility option. | |
bool | testSslOption (QSsl::SslOption option) const |
QByteArray | sessionTicket () const |
void | setSessionTicket (const QByteArray &sessionTicket) |
int | sessionTicketLifeTimeHint () const |
QSslKey | ephemeralServerKey () const |
QList< QSslEllipticCurve > | ellipticCurves () const |
void | setEllipticCurves (const QList< QSslEllipticCurve > &curves) |
QByteArray | preSharedKeyIdentityHint () const |
void | setPreSharedKeyIdentityHint (const QByteArray &hint) |
QSslDiffieHellmanParameters | diffieHellmanParameters () const |
void | setDiffieHellmanParameters (const QSslDiffieHellmanParameters &dhparams) |
QMap< QByteArray, QVariant > | backendConfiguration () const |
void | setBackendConfigurationOption (const QByteArray &name, const QVariant &value) |
void | setBackendConfiguration (const QMap< QByteArray, QVariant > &backendConfiguration=QMap< QByteArray, QVariant >()) |
bool | handshakeMustInterruptOnError () const |
void | setHandshakeMustInterruptOnError (bool interrupt) |
bool | missingCertificateIsFatal () const |
void | setMissingCertificateIsFatal (bool cannotRecover) |
void | setOcspStaplingEnabled (bool enable) |
bool | ocspStaplingEnabled () const |
void | setAllowedNextProtocols (const QList< QByteArray > &protocols) |
QList< QByteArray > | allowedNextProtocols () const |
QByteArray | nextNegotiatedProtocol () const |
NextProtocolNegotiationStatus | nextProtocolNegotiationStatus () const |
Static Public Member Functions | |
static QList< QSslCipher > | supportedCiphers () |
static QList< QSslCertificate > | systemCaCertificates () |
static QList< QSslEllipticCurve > | supportedEllipticCurves () |
static QSslConfiguration | defaultConfiguration () |
Returns the default SSL configuration to be used in new SSL connections. | |
static void | setDefaultConfiguration (const QSslConfiguration &configuration) |
Sets the default SSL configuration to be used in new SSL connections to be configuration. | |
Static Public Attributes | |
static const char | ALPNProtocolHTTP2 [] = "h2" |
static const char | NextProtocolHttp1_1 [] = "http/1.1" |
Friends | |
class | QSslSocket |
class | QSslConfigurationPrivate |
class | QSslContext |
class | QTlsBackend |
The QSslConfiguration class holds the configuration and state of an SSL connection.
\reentrant \inmodule QtNetwork
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:
\list
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: \list
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_2 in a QSslSocket object:
Definition at line 40 of file qsslconfiguration.h.
Describes the status of the Next Protocol Negotiation (NPN) or Application-Layer Protocol Negotiation (ALPN).
\value NextProtocolNegotiationNone No application protocol has been negotiated (yet).
\value NextProtocolNegotiationNegotiated A next protocol has been negotiated (see nextNegotiatedProtocol()).
\value NextProtocolNegotiationUnsupported The client and server could not agree on a common next application protocol.
Enumerator | |
---|---|
NextProtocolNegotiationNone | |
NextProtocolNegotiationNegotiated | |
NextProtocolNegotiationUnsupported |
Definition at line 145 of file qsslconfiguration.h.
QSslConfiguration::QSslConfiguration | ( | ) |
\variable QSslConfiguration::NextProtocolHttp1_1
The value used for negotiating HTTP 1.1 during the Next Protocol Negotiation.
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.
Definition at line 114 of file qsslconfiguration.cpp.
QSslConfiguration::QSslConfiguration | ( | const QSslConfiguration & | other | ) |
Copies the configuration and state of other.
If other is null, this object will be null too.
Definition at line 123 of file qsslconfiguration.cpp.
QSslConfiguration::~QSslConfiguration | ( | ) |
Releases any resources held by QSslConfiguration.
Definition at line 131 of file qsslconfiguration.cpp.
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.
Definition at line 694 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::allowRootCertOnDemandLoading, and QSslConfigurationPrivate::caCertificates.
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.
Definition at line 714 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::allowRootCertOnDemandLoading, and QSslConfigurationPrivate::caCertificates.
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().
Definition at line 669 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::caCertificates, certs, and QSslCertificate::fromPath().
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().
Definition at line 1052 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::nextAllowedProtocols.
Referenced by QHttpNetworkConnectionChannel::_q_encrypted(), QNetworkAccessManager::connectToHostEncrypted(), and QSslSocket::setSslConfiguration().
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.
Definition at line 961 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::backendConfig.
Referenced by setBackendConfiguration(), and QSslSocket::setSslConfiguration().
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().
Definition at line 629 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::caCertificates.
Referenced by QSslSocket::setSslConfiguration(), and QTlsPrivate::X509CertificateOpenSSL::verify().
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 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 supportedCiphers().
Definition at line 555 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::ciphers.
Referenced by setCiphers(), setCiphers(), and QSslSocket::setSslConfiguration().
|
static |
Returns the default SSL configuration to be used in new SSL connections.
The default SSL configuration consists of:
\list
Definition at line 1089 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::defaultConfiguration().
Referenced by QNetworkAccessManager::connectToHostEncrypted(), QNetworkRequest::sslConfiguration(), and QTlsPrivate::X509CertificateOpenSSL::verify().
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 2048-bit MODP group from RFC 3526.
Definition at line 928 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::dhParams.
Referenced by QSslSocket::setSslConfiguration().
QList< 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().
Definition at line 854 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::ellipticCurves.
Referenced by QSslSocket::setSslConfiguration().
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.
Definition at line 827 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::ephemeralServerKey.
bool QSslConfiguration::handshakeMustInterruptOnError | ( | ) | const |
Returns true if a verification callback will emit QSslSocket::handshakeInterruptedOnError() early, before concluding the handshake.
Definition at line 1206 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::reportFromCallback.
Referenced by QSslSocket::setSslConfiguration().
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.
Definition at line 215 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::allowRootCertOnDemandLoading, QSslSocket::AutoVerifyPeer, QSslConfigurationPrivate::backendConfig, QSslConfigurationPrivate::caCertificates, QSslConfigurationPrivate::ciphers, QSslDiffieHellmanParameters::defaultParameters(), QSslConfigurationPrivate::defaultSslOptions, QSslConfigurationPrivate::dhParams, QSslConfigurationPrivate::ellipticCurves, QSslConfigurationPrivate::ephemeralServerKey, QMap< Key, T >::isEmpty(), QList< T >::isEmpty(), QSslCertificate::isNull(), QSslKey::isNull(), QByteArray::isNull(), QSslConfigurationPrivate::localCertificateChain, QSslConfigurationPrivate::missingCertIsFatal, QSslConfigurationPrivate::nextAllowedProtocols, QSslConfigurationPrivate::nextNegotiatedProtocol, NextProtocolNegotiationNone, QSslConfigurationPrivate::nextProtocolNegotiationStatus, QSslConfigurationPrivate::ocspStaplingEnabled, QSslConfigurationPrivate::peerCertificate, QSslConfigurationPrivate::peerCertificateChain, QSslConfigurationPrivate::peerVerifyDepth, QSslConfigurationPrivate::peerVerifyMode, QSslConfigurationPrivate::preSharedKeyIdentityHint, QSslConfigurationPrivate::privateKey, QSslConfigurationPrivate::protocol, QSslConfigurationPrivate::reportFromCallback, QSsl::SecureProtocols, QList< T >::size(), QSslConfigurationPrivate::sslOptions, QSslConfigurationPrivate::sslSession, and QSslConfigurationPrivate::sslSessionTicketLifeTimeHint.
Referenced by QHttpNetworkConnectionChannel::init().
QSslCertificate QSslConfiguration::localCertificate | ( | ) | const |
Returns the certificate to be presented to the peer during the SSL handshake process.
Definition at line 382 of file qsslconfiguration.cpp.
References QList< T >::isEmpty(), and QSslConfigurationPrivate::localCertificateChain.
QList< QSslCertificate > QSslConfiguration::localCertificateChain | ( | ) | const |
Returns the certificate chain to be presented to the peer during the SSL handshake process.
Definition at line 344 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::localCertificateChain.
Referenced by QSslSocket::setSslConfiguration().
bool QSslConfiguration::missingCertificateIsFatal | ( | ) | const |
Returns true if errors with code QSslError::NoPeerCertificate cannot be ignored.
Definition at line 1253 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::missingCertIsFatal.
Referenced by QSslSocket::setSslConfiguration().
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.
Definition at line 1019 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::nextNegotiatedProtocol.
Referenced by QHttpNetworkConnectionChannel::_q_encrypted(), and QSslSocket::setSslConfiguration().
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.
Definition at line 1068 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::nextProtocolNegotiationStatus.
Referenced by QHttpNetworkConnectionChannel::_q_encrypted(), and QSslSocket::setSslConfiguration().
bool QSslConfiguration::ocspStaplingEnabled | ( | ) | const |
Definition at line 1191 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::ocspStaplingEnabled.
Referenced by QSslSocket::setSslConfiguration().
|
inline |
Returns true
if this QSslConfiguration differs from other.
Two QSslConfiguration objects are considered different if any state or setting is different.
Definition at line 53 of file qsslconfiguration.h.
References other().
QSslConfiguration & QSslConfiguration::operator= | ( | const QSslConfiguration & | other | ) |
Copies the configuration and state of other.
If other is null, this object will be null too.
Definition at line 140 of file qsslconfiguration.cpp.
References other().
|
inlinenoexcept |
Definition at line 46 of file qsslconfiguration.h.
References other(), and swap().
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.
Definition at line 163 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::allowRootCertOnDemandLoading, QSslConfigurationPrivate::backendConfig, QSslConfigurationPrivate::caCertificates, QSslConfigurationPrivate::ciphers, QSslConfigurationPrivate::dhParams, QSslConfigurationPrivate::dtlsCookieEnabled, QSslConfigurationPrivate::ellipticCurves, QSslConfigurationPrivate::ephemeralServerKey, QSslConfigurationPrivate::localCertificateChain, QSslConfigurationPrivate::missingCertIsFatal, QSslConfigurationPrivate::nextAllowedProtocols, QSslConfigurationPrivate::nextNegotiatedProtocol, QSslConfigurationPrivate::nextProtocolNegotiationStatus, QSslConfigurationPrivate::ocspStaplingEnabled, other(), QSslConfigurationPrivate::peerCertificate, QSslConfigurationPrivate::peerCertificateChain, QSslConfigurationPrivate::peerVerifyDepth, QSslConfigurationPrivate::peerVerifyMode, QSslConfigurationPrivate::preSharedKeyIdentityHint, QSslConfigurationPrivate::privateKey, QSslConfigurationPrivate::protocol, QSslConfigurationPrivate::reportFromCallback, QSslConfigurationPrivate::sessionCipher, QSslConfigurationPrivate::sessionProtocol, QSslConfigurationPrivate::sslOptions, QSslConfigurationPrivate::sslSession, and QSslConfigurationPrivate::sslSessionTicketLifeTimeHint.
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.
Definition at line 439 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::peerCertificate.
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().
Definition at line 471 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::peerCertificateChain.
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.
Definition at line 311 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::peerVerifyDepth.
Referenced by QSslSocket::setSslConfiguration().
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.
Definition at line 278 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::peerVerifyMode.
Referenced by QDtlsPrivateOpenSSL::continueHandshake(), and QSslSocket::setSslConfiguration().
QByteArray QSslConfiguration::preSharedKeyIdentityHint | ( | ) | const |
Returns the identity hint.
Definition at line 897 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::preSharedKeyIdentityHint.
Referenced by QDtlsPrivateOpenSSL::pskServerCallback(), and QSslSocket::setSslConfiguration().
QSslKey QSslConfiguration::privateKey | ( | ) | const |
Returns the \l {QSslKey} {SSL key} assigned to this connection or a null key if none has been assigned yet.
Definition at line 513 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::privateKey.
Referenced by QSslSocket::setSslConfiguration().
QSsl::SslProtocol QSslConfiguration::protocol | ( | ) | const |
Returns the protocol setting for this SSL configuration.
Definition at line 248 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::protocol.
Referenced by setProtocol(), and QSslSocket::setSslConfiguration().
QSslCipher QSslConfiguration::sessionCipher | ( | ) | const |
Returns the socket's cryptographic \l {QSslCipher} {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.
Definition at line 489 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::sessionCipher.
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.
Definition at line 502 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::sessionProtocol.
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.
Definition at line 777 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::sslSession.
Referenced by setSessionTicket(), and QSslSocket::setSslConfiguration().
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.
Definition at line 810 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::sslSessionTicketLifeTimeHint.
Referenced by QSslSocket::setSslConfiguration().
void QSslConfiguration::setAllowedNextProtocols | ( | const 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().
Definition at line 1038 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::nextAllowedProtocols.
Referenced by QHttpNetworkConnectionChannel::_q_encrypted(), and QHttpThreadDelegate::startRequest().
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().
Definition at line 1000 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::backendConfig, and backendConfiguration().
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 \l {https://www.openssl.org/docs/manmaster/man3/SSL_CONF_cmd.html#SUPPORTED-CONFIGURATION-FILE-COMMANDS} {supported configuration file commands} documentation. The expected type for the value parameter is a QByteArray for all options. The \l {https://www.openssl.org/docs/manmaster/man3/SSL_CONF_cmd.html#EXAMPLES}{examples} show how to use some of the options.
Definition at line 984 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::backendConfig.
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.
Definition at line 646 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::allowRootCertOnDemandLoading, and QSslConfigurationPrivate::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.
Definition at line 570 of file qsslconfiguration.cpp.
References ciphers(), and QSslConfigurationPrivate::ciphers.
Sets the cryptographic cipher suite for this configuration to ciphers, which is a colon-separated list of cipher suite names. The ciphers are listed in order of preference, starting with the most preferred cipher. For example:
Each cipher name in ciphers must be the name of a cipher in the list returned by supportedCiphers(). Restricting the cipher suite must be done before the handshake phase, where the session cipher is chosen.
Definition at line 594 of file qsslconfiguration.cpp.
References ciphers(), QSslConfigurationPrivate::ciphers, QList< T >::clear(), QSharedDataPointer< T >::data(), QSslCipher::isNull(), and Qt::SkipEmptyParts.
|
static |
Sets the default SSL configuration to be used in new SSL connections to be configuration.
Existing connections are not affected by this call.
Definition at line 1101 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::setDefaultConfiguration().
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 2048-bit MODP group from RFC 3526.
Definition at line 946 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::dhParams.
void QSslConfiguration::setEllipticCurves | ( | const QList< 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.
Definition at line 871 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::ellipticCurves.
void QSslConfiguration::setHandshakeMustInterruptOnError | ( | bool | interrupt | ) |
If interrupt is true and the underlying backend supports this option, errors found during certificate verification are reported immediately by emitting QSslSocket::handshakeInterruptedOnError(). This allows to stop the unfinished handshake and send a proper alert message to a peer. No special action is required from the application in this case. QSslSocket will close the connection after sending the alert message. If the application after inspecting the error wants to continue the handshake, it must call QSslSocket::continueInterruptedHandshake() from its slot function. The signal-slot connection must be direct.
Definition at line 1233 of file qsslconfiguration.cpp.
References Q_UNUSED, qCWarning, and QSslConfigurationPrivate::reportFromCallback.
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.
Definition at line 405 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::localCertificateChain.
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.
Definition at line 371 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::localCertificateChain.
void QSslConfiguration::setMissingCertificateIsFatal | ( | bool | cannotRecover | ) |
If cannotRecover is true, and verification mode in use is QSslSocket::VerifyPeer or QSslSocket::AutoVerifyPeer (for a client-side socket), the missing peer's certificate would be treated as an unrecoverable error that cannot be ignored. A proper alert message will be sent to the peer before closing the connection.
Definition at line 1271 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::missingCertIsFatal, Q_UNUSED, and qCWarning.
void QSslConfiguration::setOcspStaplingEnabled | ( | bool | enabled | ) |
Definition at line 1174 of file qsslconfiguration.cpp.
References enabled, QSslConfigurationPrivate::ocspStaplingEnabled, and qCWarning.
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.
Definition at line 327 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::peerVerifyDepth, and qCWarning.
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.
Definition at line 294 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::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!
Definition at line 911 of file qsslconfiguration.cpp.
References hint(), and QSslConfigurationPrivate::preSharedKeyIdentityHint.
Sets the connection's private \l {QSslKey} {key} to key.
The private key and the local \l {QSslCertificate} {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.
Definition at line 531 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::privateKey.
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.
Definition at line 262 of file qsslconfiguration.cpp.
References protocol(), and QSslConfigurationPrivate::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().
Definition at line 792 of file qsslconfiguration.cpp.
References sessionTicket(), and QSslConfigurationPrivate::sslSession.
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.
Definition at line 744 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::sslOptions.
|
static |
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.
Definition at line 615 of file qsslconfiguration.cpp.
References QSslSocketPrivate::supportedCiphers().
Referenced by QSslCipher::QSslCipher(), and QSslCipher::QSslCipher().
|
static |
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.
Definition at line 885 of file qsslconfiguration.cpp.
References QSslSocketPrivate::supportedEllipticCurves().
|
inlinenoexcept |
Swaps this SSL configuration instance with other. This function is very fast and never fails.
Definition at line 49 of file qsslconfiguration.h.
|
static |
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.
Definition at line 731 of file qsslconfiguration.cpp.
References QSslSocketPrivate::systemCaCertificates().
bool QSslConfiguration::testSslOption | ( | QSsl::SslOption | option | ) | const |
Returns true
if the specified SSL compatibility option is enabled.
Definition at line 756 of file qsslconfiguration.cpp.
References QSslConfigurationPrivate::sslOptions.
Referenced by QSslContext::cacheSession(), and QSslContext::createSsl().
|
friend |
Definition at line 162 of file qsslconfiguration.h.
|
friend |
Definition at line 163 of file qsslconfiguration.h.
|
friend |
Definition at line 161 of file qsslconfiguration.h.
|
friend |
Definition at line 164 of file qsslconfiguration.h.
|
static |
Definition at line 157 of file qsslconfiguration.h.
Referenced by QHttpNetworkConnectionChannel::_q_encrypted(), QNetworkAccessManager::connectToHostEncrypted(), and QHttpThreadDelegate::startRequest().
|
static |
Definition at line 158 of file qsslconfiguration.h.
Referenced by QHttpNetworkConnectionChannel::_q_encrypted(), and QHttpThreadDelegate::startRequest().