CopperSpice API  1.7.4
QSsl Namespace Reference

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

## Typedefs

using SslOptions = QFlags< SslOption >

## Enums

enum  AlternativeNameEntryType

enum  EncodingFormat

enum  KeyAlgorithm

enum  KeyType

enum  SslOption

enum  SslProtocol

## Detailed Description

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

QSslCertificate::alternateSubjectNames()

## Typedef Documentation

Typedef for QFlags<SslOption>. It stores an OR combination of SslOption values.

## Enumeration Type Documentation

Describes the key types for alternate name entries in QSslCertificate.

ConstantValueDescription
QSsl::EmailEntry 0 Email entry, the entry contains an email address that the certificate is valid for.
QSsl::DnsEntry 1 DNS host name entry, the entry contains a host name entry that the certificate is valid for. The entry may contain wildcards.
QSslCertificate::alternateSubjectNames()
 enum QSsl::EncodingFormat

Describes supported encoding formats for certificates and keys.

ConstantValueDescription
QSsl::Pem0The PEM format.
QSsl::Der1The DER format.
 enum QSsl::KeyAlgorithm

Describes the different key algorithms supported by QSslKey.

ConstantValueDescription
QSsl::Rsa1RSA algorithm
QSsl::Dsa2DSA algorithm
QSsl::Ec3Elliptic Curve algorithm
QSsl::Opaque0Key should be treated as a 'black box' by QSslKey

The opaque key facility allows applications to add support for facilities such as PKCS#11 which is not currently offered natively.

 enum QSsl::KeyType

Describes the two types of keys QSslKey supports.

ConstantValueDescription
QSsl::PrivateKey0A private key.
QSsl::PublicKey1A public key.
 enum QSsl::SslOption

Describes the options that can be used to control the details of SSL behavior. These options are generally used to turn features off to work around buggy servers.

ConstantValueDescription
QSsl::SslOptionDisableEmptyFragments 0x01 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.
QSsl::SslOptionDisableSessionTickets 0x02 Disables the SSL session ticket extension. This can cause slower connection setup, however some servers are not compatible with the extension.
QSsl::SslOptionDisableCompression 0x04 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.
QSsl::SslOptionDisableServerNameIndication 0x08 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.
QSsl::SslOptionDisableLegacyRenegotiation 0x10 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.
QSsl::SslOptionDisableSessionSharing 0x20 Disables SSL session sharing via the session ID handshake attribute.
QSsl::SslOptionDisableSessionPersistence 0x40 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.
QSsl::SslOptionDisableServerCipherPreference 0x80 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 publicized by CRIME. The other options are turned off.

Note
Availability of the above options depend on the version of the SSL backend in use.
 enum QSsl::SslProtocol

Describes the protocol of the cipher.

ConstantValueDescription
QSsl::SslV3 0 SSLv3
QSsl::SslV2 1 SSLv2
QSsl::TlsV1_0 2 TLSv1.0
QSsl::TlsV1_1 3 TLSv1.1
QSsl::TlsV1_2 4 TLSv1.2
QSsl::TlsV1SslV3 5 On the client side, this will send a TLS 1.0 Client Hello, enabling TLSv1 and SSLv3 connections. On the server side, this will enable both SSLv3 and TLSv1 connections.
QSsl::TlsV1_0_OrLater 6 TLSv1.0 and later versions. This option is not available when using the WinRT backend due to platform limitations.
QSsl::TlsV1_1_OrLater7 TLSv1.1 and later versions. This option is not available when using the WinRT backend due to platform limitations.
QSsl::TlsV1_2_OrLater8 TLSv1.2 and later versions. This option is not available when using the WinRT backend due to platform limitations.
QSsl::AnyProtocol 9 The socket understands SSLv2, SSLv3, and TLSv1. This value is used by QSslSocket only.
QSsl::SecureProtocols 10 The default option using protocols known to be secure. Currently behaves similar to TlsV1Ssl3 except that SSLv3 connections which can not be upgraded to TLS will be denied.
QSsl::UnknownProtocol -1The cipher's protocol can not be determined.

Most servers using SSL understand both versions (2 and 3), but it is recommended to use the latest version only for security reasons. However, SSL and TLS are not compatible with each other. If you get unexpected handshake failures, verify that your protocol settings are correct.