Qt 6.x
The Qt SDK
Loading...
Searching...
No Matches
QSsl Namespace Reference

The QSsl namespace declares enums common to all SSL classes in Qt Network. More...

Enumerations

enum  KeyType { PrivateKey , PublicKey }
 Describes the two types of keys QSslKey supports. More...
 
enum  EncodingFormat { Pem , Der }
 Describes supported encoding formats for certificates and keys. More...
 
enum  KeyAlgorithm {
  Opaque , Rsa , Dsa , Ec ,
  Dh
}
 Describes the different key algorithms supported by QSslKey. More...
 
enum  AlternativeNameEntryType { EmailEntry , DnsEntry , IpAddressEntry }
 Describes the key types for alternative name entries in QSslCertificate. More...
 
enum  SslProtocol {
  QT_DEPRECATED_VERSION_X_6_3 =("Use TlsV1_2OrLater instead.") , QT_DEPRECATED_VERSION_X_6_3 =("Use TlsV1_2OrLater instead.") , TlsV1_2 , AnyProtocol ,
  SecureProtocols , QT_DEPRECATED_VERSION_X_6_3 =("Use TlsV1_2OrLater instead.") , QT_DEPRECATED_VERSION_X_6_3 =("Use TlsV1_2OrLater instead.") , TlsV1_2OrLater ,
  QT_DEPRECATED_VERSION_X_6_3 =("Use TlsV1_2OrLater instead.") , QT_DEPRECATED_VERSION_X_6_3 =("Use TlsV1_2OrLater instead.") , DtlsV1_2 , DtlsV1_2OrLater ,
  TlsV1_3 , TlsV1_3OrLater , UnknownProtocol = -1
}
 Describes the protocol of the cipher. More...
 
enum  SslOption {
  SslOptionDisableEmptyFragments = 0x01 , SslOptionDisableSessionTickets = 0x02 , SslOptionDisableCompression = 0x04 , SslOptionDisableServerNameIndication = 0x08 ,
  SslOptionDisableLegacyRenegotiation = 0x10 , SslOptionDisableSessionSharing = 0x20 , SslOptionDisableSessionPersistence = 0x40 , SslOptionDisableServerCipherPreference = 0x80
}
 Describes the options that can be used to control the details of SSL behaviour. More...
 
enum class  AlertLevel { Warning , Fatal , Unknown }
 
enum class  AlertType {
  CloseNotify , UnexpectedMessage = 10 , BadRecordMac = 20 , RecordOverflow = 22 ,
  DecompressionFailure = 30 , HandshakeFailure = 40 , NoCertificate = 41 , BadCertificate = 42 ,
  UnsupportedCertificate = 43 , CertificateRevoked = 44 , CertificateExpired = 45 , CertificateUnknown = 46 ,
  IllegalParameter = 47 , UnknownCa = 48 , AccessDenied = 49 , DecodeError = 50 ,
  DecryptError = 51 , ExportRestriction = 60 , ProtocolVersion = 70 , InsufficientSecurity = 71 ,
  InternalError = 80 , InappropriateFallback = 86 , UserCancelled = 90 , NoRenegotiation = 100 ,
  MissingExtension = 109 , UnsupportedExtension = 110 , CertificateUnobtainable = 111 , UnrecognizedName = 112 ,
  BadCertificateStatusResponse = 113 , BadCertificateHashValue = 114 , UnknownPskIdentity = 115 , CertificateRequired = 116 ,
  NoApplicationProtocol = 120 , UnknownAlertMessage = 255
}
 
enum class  ImplementedClass {
  Key , Certificate , Socket , DiffieHellman ,
  EllipticCurve , Dtls , DtlsCookie
}
 
enum class  SupportedFeature {
  CertificateVerification , ClientSideAlpn , ServerSideAlpn , Ocsp ,
  Psk , SessionTicket , Alerts
}
 

Detailed Description

The QSsl namespace declares enums common to all SSL classes in Qt Network.

Since
4.3

\inmodule QtNetwork

Enumeration Type Documentation

◆ AlertLevel

enum class QSsl::AlertLevel
strong
Enumerator
Warning 
Fatal 
Unknown 

Definition at line 77 of file qssl.h.

◆ AlertType

enum class QSsl::AlertType
strong
Enumerator
CloseNotify 
UnexpectedMessage 
BadRecordMac 
RecordOverflow 
DecompressionFailure 
HandshakeFailure 
NoCertificate 
BadCertificate 
UnsupportedCertificate 
CertificateRevoked 
CertificateExpired 
CertificateUnknown 
IllegalParameter 
UnknownCa 
AccessDenied 
DecodeError 
DecryptError 
ExportRestriction 
ProtocolVersion 
InsufficientSecurity 
InternalError 
InappropriateFallback 
UserCancelled 
NoRenegotiation 
MissingExtension 
UnsupportedExtension 
CertificateUnobtainable 
UnrecognizedName 
BadCertificateStatusResponse 
BadCertificateHashValue 
UnknownPskIdentity 
CertificateRequired 
NoApplicationProtocol 
UnknownAlertMessage 

Definition at line 83 of file qssl.h.

◆ AlternativeNameEntryType

Describes the key types for alternative name entries in QSslCertificate.

\value EmailEntry An email entry; the entry contains an email address that the certificate is valid for.

\value DnsEntry A DNS host name entry; the entry contains a host name entry that the certificate is valid for. The entry may contain wildcards.

\value IpAddressEntry An IP address entry; the entry contains an IP address entry that the certificate is valid for, introduced in Qt 5.13.

See also
QSslCertificate::subjectAlternativeNames()
Enumerator
EmailEntry 
DnsEntry 
IpAddressEntry 

Definition at line 37 of file qssl.h.

◆ EncodingFormat

Describes supported encoding formats for certificates and keys.

\value Pem The PEM format. \value Der The DER format.

Enumerator
Pem 
Der 

Definition at line 24 of file qssl.h.

◆ ImplementedClass

enum class QSsl::ImplementedClass
strong
Enumerator
Key 
Certificate 
Socket 
DiffieHellman 
EllipticCurve 
Dtls 
DtlsCookie 

Definition at line 120 of file qssl.h.

◆ KeyAlgorithm

Describes the different key algorithms supported by QSslKey.

\value Rsa The RSA algorithm. \value Dsa The DSA algorithm. \value Ec The Elliptic Curve algorithm. \value Dh The Diffie-Hellman algorithm. \value Opaque A key that should be treated as a 'black box' by QSslKey.

The opaque key facility allows applications to add support for facilities such as PKCS#11 that Qt does not currently offer natively.

Enumerator
Opaque 
Rsa 
Dsa 
Ec 
Dh 

Definition at line 29 of file qssl.h.

◆ KeyType

Describes the two types of keys QSslKey supports.

\value PrivateKey A private key. \value PublicKey A public key.

Enumerator
PrivateKey 
PublicKey 

Definition at line 19 of file qssl.h.

◆ SslOption

Describes the options that can be used to control the details of SSL behaviour.

These options are generally used to turn features off to work around buggy servers.

\value SslOptionDisableEmptyFragments Disables the insertion of empty fragments into the data when using block ciphers. When enabled, this prevents some attacks (such as the BEAST attack), however it is incompatible with some servers. \value SslOptionDisableSessionTickets Disables the SSL session ticket extension. This can cause slower connection setup, however some servers are not compatible with the extension. \value SslOptionDisableCompression Disables the SSL compression extension. When enabled, this allows the data being passed over SSL to be compressed, however some servers are not compatible with this extension. \value SslOptionDisableServerNameIndication Disables the SSL server name indication extension. When enabled, this tells the server the virtual host being accessed allowing it to respond with the correct certificate. \value SslOptionDisableLegacyRenegotiation Disables the older insecure mechanism for renegotiating the connection parameters. When enabled, this option can allow connections for legacy servers, but it introduces the possibility that an attacker could inject plaintext into the SSL session. \value SslOptionDisableSessionSharing Disables SSL session sharing via the session ID handshake attribute. \value SslOptionDisableSessionPersistence Disables storing the SSL session in ASN.1 format as returned by QSslConfiguration::sessionTicket(). Enabling this feature adds memory overhead of approximately 1K per used session ticket. \value SslOptionDisableServerCipherPreference Disables selecting the cipher chosen based on the servers preferences rather than the order ciphers were sent by the client. This option is only relevant to server sockets, and is only honored by the OpenSSL backend.

By default, SslOptionDisableEmptyFragments is turned on since this causes problems with a large number of servers. SslOptionDisableLegacyRenegotiation is also turned on, since it introduces a security risk. SslOptionDisableCompression is turned on to prevent the attack publicised by CRIME. SslOptionDisableSessionPersistence is turned on to optimize memory usage. The other options are turned off.

Note
Availability of above options depends on the version of the SSL backend in use.
Enumerator
SslOptionDisableEmptyFragments 
SslOptionDisableSessionTickets 
SslOptionDisableCompression 
SslOptionDisableServerNameIndication 
SslOptionDisableLegacyRenegotiation 
SslOptionDisableSessionSharing 
SslOptionDisableSessionPersistence 
SslOptionDisableServerCipherPreference 

Definition at line 65 of file qssl.h.

◆ SslProtocol

Describes the protocol of the cipher.

\value TlsV1_0 TLSv1.0 \value TlsV1_0OrLater TLSv1.0 and later versions. \value TlsV1_1 TLSv1.1. \value TlsV1_1OrLater TLSv1.1 and later versions. \value TlsV1_2 TLSv1.2. \value TlsV1_2OrLater TLSv1.2 and later versions. \value DtlsV1_0 DTLSv1.0 \value DtlsV1_0OrLater DTLSv1.0 and later versions. \value DtlsV1_2 DTLSv1.2 \value DtlsV1_2OrLater DTLSv1.2 and later versions. \value TlsV1_3 TLSv1.3. (Since Qt 5.12) \value TlsV1_3OrLater TLSv1.3 and later versions. (Since Qt 5.12) \value UnknownProtocol The cipher's protocol cannot be determined. \value AnyProtocol Any supported protocol. This value is used by QSslSocket only. \value SecureProtocols The default option, using protocols known to be secure.

Enumerator
QT_DEPRECATED_VERSION_X_6_3 
QT_DEPRECATED_VERSION_X_6_3 
TlsV1_2 
AnyProtocol 
SecureProtocols 
QT_DEPRECATED_VERSION_X_6_3 
QT_DEPRECATED_VERSION_X_6_3 
TlsV1_2OrLater 
QT_DEPRECATED_VERSION_X_6_3 
QT_DEPRECATED_VERSION_X_6_3 
DtlsV1_2 
DtlsV1_2OrLater 
TlsV1_3 
TlsV1_3OrLater 
UnknownProtocol 

Definition at line 43 of file qssl.h.

◆ SupportedFeature

enum class QSsl::SupportedFeature
strong
Enumerator
CertificateVerification 
ClientSideAlpn 
ServerSideAlpn 
Ocsp 
Psk 
SessionTicket 
Alerts 

Definition at line 131 of file qssl.h.