QSslConfiguration¶

PyQt5.QtNetwork.QSslConfiguration

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);

Enums¶

NextProtocolNegotiationStatus

TODO

Member	Value	Description
NextProtocolNegotiationNegotiated	TODO	TODO
NextProtocolNegotiationNone	TODO	TODO
NextProtocolNegotiationUnsupported	TODO	TODO

Attributes¶

NextProtocolHttp1_1: str

This is a read-only class attribute.

TODO

NextProtocolSpdy3_0: str

This is a read-only class attribute.

TODO

Methods¶

__init__()

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.

__init__(QSslConfiguration): Copies the configuration and state of other. If other is null, this object will be null too.

allowedNextProtocols() → List[QByteArray]: TODO

backendConfiguration() → Dict[QByteArray, Any]: TODO

caCertificates() → List[QSslCertificate]: 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().

ciphers() → List[QSslCipher]

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

See also

setCiphers(), supportedCiphers().

@staticmethod defaultConfiguration() → QSslConfiguration

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

diffieHellmanParameters() → QSslDiffieHellmanParameters: TODO

ellipticCurves() → List[QSslEllipticCurve]: TODO

ephemeralServerKey() → QSslKey: TODO

__eq__(QSslConfiguration) → bool: TODO

isNull() → bool

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.

localCertificate() → QSslCertificate: Returns the certificate to be presented to the peer during the SSL handshake process.

See also

setLocalCertificate().

localCertificateChain() → List[QSslCertificate]: TODO

__ne__(QSslConfiguration) → bool: TODO

nextNegotiatedProtocol() → QByteArray: TODO

nextProtocolNegotiationStatus() → NextProtocolNegotiationStatus: TODO

ocspStaplingEnabled() → bool: TODO

peerCertificate() → QSslCertificate

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 sslErrors signal, sslErrors signal, or the 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.

peerCertificateChain() → List[QSslCertificate]

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 sslErrors signal, sslErrors signal, or the 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().

peerVerifyDepth() → int

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(), peerVerifyMode().

peerVerifyMode() → PeerVerifyMode

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

preSharedKeyIdentityHint() → QByteArray: TODO

privateKey() → QSslKey: Returns the QSslKey assigned to this connection or a null key if none has been assigned yet.

See also

setPrivateKey(), localCertificate().

protocol() → SslProtocol: Returns the protocol setting for this SSL configuration.

See also

setProtocol().

sessionCipher() → QSslCipher

Returns the socket’s cryptographic QSslCipher, 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.

sessionProtocol() → SslProtocol: TODO

sessionTicket() → QByteArray: TODO

sessionTicketLifeTimeHint() → int: TODO

setAllowedNextProtocols(Iterable[Union[QByteArray, bytes, bytearray]]): TODO

setBackendConfiguration(backendConfiguration: Dict[Union[QByteArray, bytes, bytearray], Any] = {}): TODO

setBackendConfigurationOption(Union[QByteArray, bytes, bytearray], Any): TODO

setCaCertificates(Iterable[QSslCertificate])

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.

Note: The default configuration uses the system CA certificate database. If that is not available (as is commonly the case on iOS), the default database is empty.

See also

caCertificates().

setCiphers(Iterable[QSslCipher])

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(), supportedCiphers().

@staticmethod setDefaultConfiguration(QSslConfiguration): 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

supportedCiphers(), defaultConfiguration().

setDiffieHellmanParameters(QSslDiffieHellmanParameters): TODO

setEllipticCurves(Iterable[QSslEllipticCurve]): TODO

setLocalCertificate(QSslCertificate)

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

setLocalCertificateChain(Iterable[QSslCertificate]): TODO

setOcspStaplingEnabled(bool): TODO

setPeerVerifyDepth(int)

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(), setPeerVerifyMode().

setPeerVerifyMode(PeerVerifyMode)

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

setPreSharedKeyIdentityHint(Union[QByteArray, bytes, bytearray]): TODO

setPrivateKey(QSslKey)

Sets the connection’s private QSslKey to key. The private key and the local QSslCertificate 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(), setLocalCertificate().

setProtocol(SslProtocol)

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

setSessionTicket(Union[QByteArray, bytes, bytearray]): TODO

setSslOption(SslOption, bool): 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().

@staticmethod supportedCiphers() → List[QSslCipher]: TODO

@staticmethod supportedEllipticCurves() → List[QSslEllipticCurve]: TODO

swap(QSslConfiguration): TODO

@staticmethod systemCaCertificates() → List[QSslCertificate]: TODO

testSslOption(SslOption) → bool: Returns true if the specified SSL compatibility option is enabled.

See also

setSslOption().