Describes the peer verification modes for QSslSocket. The default mode is AutoVerifyPeer, which selects an appropriate mode depending on the socket's QSocket::SslMode.

See also

QSslSocket::peerVerifyMode()

Describes the connection modes available for QSslSocket.

Constructs a QSslSocket object. The parent object is passed to the QObject constructor. The new socket's cipher suite is set to the one returned by the static method QSslConfiguration::setCiphers().

Destroys the QSslSocket.

Aborts the current connection and resets the socket. Unlike disconnectFromHost(), this function immediately closes the socket, clearing any pending data in the write buffer.

See also

disconnectFromHost(), close()

Adds the certificate to this socket's CA certificate database. The CA certificate database is used by the socket during the handshake phase to validate the peer's certificate.

To add multiple certificates use addCaCertificates().

See also

QSslConfiguration::caCertificates(), QSslConfiguration::setCaCertificates()

Adds the certificates to this socket's CA certificate database. 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().

See also

QSslConfiguration::caCertificates(), addDefaultCaCertificate()

Searches all files in the path for certificates encoded in the specified format and adds them to this socket's CA certificate database. Path can be explicit, or it can contain wildcards in the format 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().

See also

addCaCertificate(), QSslCertificate::fromPath()

Adds certificate to the default CA certificate database. Each SSL socket's CA certificate database is initialized to the default CA certificate database.

See also

QSslConfiguration::caCertificates(), addCaCertificates()

Adds certificates to the default CA certificate database. Each SSL socket's CA certificate database is initialized to the default CA certificate database.

See also

QSslConfiguration::caCertificates(), addCaCertificates()

Searches all files in the path for certificates with the specified format and adds them to the default CA certificate database. The path can be an explicit file, or it can contain wildcards in the format specified by syntax. Returns true if any CA certificates are added to the default database.

Each SSL socket's CA certificate database is initialized to the default CA certificate database.

See also

QSslConfiguration::caCertificates(), addCaCertificates(), addDefaultCaCertificate()

Reimplemented from QAbstractSocket::atEnd()

Returns the number of decrypted bytes that are immediately available for reading.

Reimplemented from QAbstractSocket::bytesAvailable()

Returns the number of unencrypted bytes that are waiting to be encrypted and written to the network.

Reimplemented from QAbstractSocket::bytesToWrite()

Returns true if one entire line terminated by a single '\n' character can be read, otherwise false is returned.

Reimplemented from QAbstractSocket::canReadLine()

Reimplemented from QAbstractSocket::close()

Attempts to make a connection to address on the given port.

Attempts to make a connection to hostname on the given port.

The socket is opened in the given openMode and first enters HostLookupState, then performs a host name lookup of hostName. If the lookup succeeds, hostFound() is emitted and QAbstractSocket enters ConnectingState. It then attempts to connect to the address or addresses returned by the lookup. Finally, if a connection is established, QAbstractSocket enters ConnectedState and emits connected().

At any point the socket can emit error() to signal that an error occurred.

The parameter hostName can be an IP address like "127.0.0.1" or it can be a host name like "example.com". QAbstractSocket will do a lookup only if required. The port is in native byte order.

See also

state(), peerName(), peerAddress(), peerPort(), waitForConnected()

Attempts to make a connection to hostname on the given port.

The socket is opened in the given openMode and first enters HostLookupState, then performs a host name lookup of hostName. If the lookup succeeds, hostFound() is emitted and QAbstractSocket enters ConnectingState. It then attempts to connect to the address or addresses returned by the lookup. Finally, if a connection is established, QAbstractSocket enters ConnectedState and emits connected().

At any point the socket can emit error() to signal that an error occurred.

The parameter hostName can be an IP address like "127.0.0.1" or it can be a host name like "example.com". QAbstractSocket will do a lookup only if required. The port is in native byte order.

See also

state(), peerName(), peerAddress(), peerPort(), waitForConnected()

Reimplemented from QAbstractSocket::connectToHost()

In addition to the original behavior of connectToHostEncrypted, this overloaded method enables the usage of a different hostname (sslPeerName) for the certificate validation instead of the one used for the TCP connection (hostname).

See also

connectToHostEncrypted()

Starts an encrypted connection to the device hostName on port using mode as the OpenMode. This is equivalent to calling connectToHost() to establish the connection followed by a call to startClientEncryption(). The default for mode is ReadWrite.

QSslSocket first enters the HostLookupState. Then, after entering either the event loop or one of the waitFor...() functions, it enters the ConnectingState, emits connected(), and then initiates the SSL client handshake. At each state change, QSslSocket emits signal stateChanged().

After initiating the SSL client handshake, if the identity of the peer can not be established, signal sslErrors() is emitted. If you want to ignore the errors and continue connecting, you must call ignoreSslErrors(), either from inside a slot function connected to the sslErrors() signal, or prior to entering encrypted mode. If ignoreSslErrors() is not called, the connection is dropped, signal disconnected() is emitted, and QSslSocket returns to the UnconnectedState.

If the SSL handshake is successful, QSslSocket emits encrypted().

The example above shows that text can be written to the socket immediately after requesting the encrypted connection, before the encrypted() signal has been emitted. In such cases, the text is queued in the object and written to the socket after the connection is established and the encrypted() signal has been emitted.

If you want to create a QSslSocket on the server side of a connection you should instead call startServerEncryption() upon receiving the incoming connection through QTcpServer.

See also

connectToHost(), startClientEncryption(), waitForConnected(), waitForEncrypted()

Attempts to close the socket. If there is pending data waiting to be written, QAbstractSocket will enter ClosingState and wait until all data has been written. Eventually, it will enter UnconnectedState and emit the disconnected() signal.

See also

connectToHost()

Reimplemented from QAbstractSocket::disconnectFromHost()

This signal is emitted when QSslSocket enters encrypted mode. After this signal has been emitted, QSslSocket::isEncrypted() will return true, and all further transmissions on the socket will be encrypted.

See also

QSslSocket::connectToHostEncrypted(), QSslSocket::isEncrypted()

Returns the number of encrypted bytes that are awaiting decryption. Normally, this function will return 0 because QSslSocket decrypts its incoming data as soon as it can.

Returns the number of encrypted bytes that are waiting to be written to the network.

This signal is emitted when QSslSocket writes its encrypted data to the network. The totalBytes parameter contains the number of bytes that were successfully written.

See also

QIODevice::bytesWritten()

This method writes as much as possible from the internal write buffer to the underlying network socket, without blocking. If any data was written, this function returns true, otherwise false is returned.

Call this method if you need QSslSocket to start sending buffered data immediately. The number of bytes successfully written depends on the operating system. In most cases, you do not need to call this function, because QAbstractSocket will start sending data automatically once control goes back to the event loop. In the absence of an event loop, call waitForBytesWritten() instead.

See also

write(), waitForBytesWritten()

This slot tells QSslSocket to ignore errors during QSslSocket's handshake phase and continue connecting. If you want to continue with the connection even if errors occur during the handshake phase, then you must call this slot, either from a slot connected to sslErrors(), or before the handshake phase. If you do not call this slot, either in response to errors or before the handshake, the connection will be dropped after the sslErrors() signal has been emitted.

If there are no errors during the SSL handshake phase (i.e., the identity of the peer is established with no problems), QSslSocket will not emit the sslErrors() signal, and it is unnecessary to call this function.

Warning

Be sure to always let the user inspect the errors reported by the sslErrors() signal, and only call this method upon confirmation from the user that proceeding is ok. If there are unexpected errors, the connection should be aborted. Calling this method without inspecting the actual errors will most likely pose a security risk for your application. Use it with great care!

See also

sslErrors()

This method configures QSslSocket to ignore a specific set of errors given in errors. Multiple calls to this method will replace the list of errors that were passed in previous calls. You can clear the list of errors you want to ignore by calling this function with an empty list.

For example, if you want to connect to a Server and allow a self signed certificate use code similar to the following.

See also

sslErrors()

Returns true if the socket is encrypted, otherwise false is returned.

An encrypted socket encrypts all data that is written by calling write() or putChar() before the data is written to the network, and decrypts all incoming data as the data is received from the network, before you call read(), readLine() or getChar().

QSslSocket emits encrypted() when it enters encrypted mode.

You can call sessionCipher() to find which cryptographic cipher is used to encrypt and decrypt your data.

See also

mode()

Returns the socket's local certificate, or an empty certificate if no local certificate has been assigned.

See also

setLocalCertificate(), privateKey()

Returns the socket's local certificate chain, or an empty list if no local certificates have been assigned.

See also

setLocalCertificateChain()

Returns the current mode for the socket. The value can be either UnencryptedMode, where QSslSocket behaves identically to QTcpSocket, or one of SslClientMode or SslServerMode, where the client is either negotiating or in encrypted mode. When the mode changes, QSslSocket emits modeChanged()

See also

SslMode

This signal is emitted when QSslSocket changes from QSslSocket::UnencryptedMode to either QSslSocket::SslClientMode or QSslSocket::SslServerMode. The newMode is the new mode.

See also

QSslSocket::mode()

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 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 does not 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.

See also

peerCertificateChain()

Returns the peer's chain of digital certificates, or an empty list of certificates.

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.

The peer certificates are set in QSslSocket during the handshake phase, so it is safe to call this function from a slot connected to the 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 does not have a certificate, or it can mean there is no connection.

If you want to get only the peer's immediate certificate, use peerCertificate().

See also

peerCertificate()

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

QSslSocket can emit this signal several times during the SSL handshake, before encryption has been established, to indicate that an error has occurred while establishing the identity of the peer. The error is usually an indication that QSslSocket is unable to securely identify the peer.

This signal provides you with an early indication when something's wrong. By connecting to this signal, you can manually choose to tear down the connection from inside the connected slot before the handshake has completed. If no action is taken, QSslSocket will proceed to emitting QSslSocket::sslErrors().

See also

sslErrors()

Returns the socket's verify mode. The 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 informs QSslSocket to use VerifyPeer for clients and QueryPeer for servers.

See also

setPeerVerifyMode(), peerVerifyDepth(), mode()

Returns the different hostname for the certificate validation, as set by setPeerVerifyName or by connectToHostEncrypted.

See also

setPeerVerifyName(), connectToHostEncrypted()

QSslSocket emits this signal when it negotiates a PSK ciphersuite, and therefore a PSK authentication is then required.

When using PSK, the client must send to the server a valid identity and a valid pre shared key, in order for the SSL handshake to continue. Applications can provide this information in a slot connected to this signal, by filling in the passed authenticator object according to their needs.

Ignoring this signal, or failing to provide the required credentials, will cause the handshake to fail, and therefore the connection to be aborted.

The authenticator object is owned by the socket and must not be deleted by the application.

See also

QSslPreSharedKeyAuthenticator

Returns this socket's private key.

See also

setPrivateKey(), localCertificate()

Returns the socket's SSL protocol. By default, QSsl::SecureProtocols is used.

See also

setProtocol()

Reimplemented from QAbstractSocket::readData()

Continues data transfer on the socket. This method should only be used after the socket has been set to pause upon notifications and a notification has been received. The only notification currently supported is QSslSocket::sslErrors(). Calling this method if the socket is not paused results in undefined behavior.

See also

pauseMode(), setPauseMode()

Reimplemented from QAbstractSocket::resume()

Returns the socket's cryptographic cipher, or a null cipher if the connection is not 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.

QSslSocket 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.

See also

QSslConfiguration::ciphers(), QSslConfiguration::setCiphers(), QSslConfiguration::supportedCiphers()

Returns the socket's SSL/TLS protocol or UnknownProtocol if the connection is not encrypted. The socket protocol for the session is set during the handshake phase.

See also

protocol(), setProtocol()

Sets the socket's local certificate to certificate. The local certificate is necessary if you need to confirm your identity to the peer. It is used together with the private key. If you set the local certificate you must also set the private key.

The local certificate and private key are always necessary for server sockets, but are also rarely used by client sockets if the server requires the client to authenticate.

See also

localCertificate(), setPrivateKey()

Sets the socket's local certificate to certificate. The local certificate is necessary if you need to confirm your identity to the peer. It is used together with the private key; if you set the local certificate, you must also set the private key.

The local certificate and private key are always necessary for server sockets, but are also rarely used by client sockets if the server requires the client to authenticate.

See also

localCertificate(), setPrivateKey()

Sets the socket's local certificate to the first one found in fileName, which is parsed according to the specified format.

Sets the certificate chain to be presented to the peer during the SSL handshake to be localChain.

See also

localCertificateChain(), QSslConfiguration::setLocalCertificateChain()

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

Sets the socket's 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 and QueryPeer for servers. Setting this mode after encryption has started has no effect on the current connection.

See also

peerVerifyMode(), setPeerVerifyDepth(), mode()

Sets a different host name, given by hostname, for the certificate validation instead of the one used for the TCP connection.

See also

peerVerifyName(), connectToHostEncrypted()

Sets the socket's private key to key. The private key and the local 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.

See also

privateKey(), setLocalCertificate()

Reads the string in file fileName and decodes it using a specified algorithm and encoding format to construct an SSL key. If the encoded key is encrypted, passPhrase is used to decrypt it.

The socket's private key is set to the constructed key. The private key and the local 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.

See also

privateKey(), setLocalCertificate()

Sets the socket's SSL protocol to protocol. This will affect the next initiated handshake; calling this function on an already-encrypted socket will not affect the socket's protocol.

See also

protocol()

Sets the size of QSslSocket's internal read buffer to be size bytes.

Reimplemented from QAbstractSocket::setReadBufferSize()

Initializes QSslSocket with the native socket descriptor socketDescriptor. Returns true if socketDescriptor is accepted as a valid socket descriptor, otherwise returns false. The socket is opened in the mode specified by openMode, and enters the socket state specified by state.

Note

It is not possible to initialize two sockets with the same native socket descriptor.

See also

socketDescriptor()

Reimplemented from QAbstractSocket::setSocketDescriptor()

Sets the given option to the value described by value.

See also

socketOption()

Reimplemented from QAbstractSocket::setSocketOption()

Sets the socket's SSL configuration to be the contents of configuration. This method sets the local certificate, the ciphers, the private key and the CA certificates to those stored in configuration. It is not possible to set the SSL-state related fields.

See also

sslConfiguration(), setLocalCertificate(), setPrivateKey(), QSslConfiguration::setCaCertificates(), QSslConfiguration::setCiphers()

Returns the value of option.

See also

setSocketOption()

Reimplemented from QAbstractSocket::socketOption()

Returns the socket's SSL configuration state. The default SSL configuration of a socket is to use the default ciphers, default CA certificates, no local private key or certificate.

The SSL configuration also contains fields that can change with time without notice.

See also

setSslConfiguration(), localCertificate(), peerCertificate(), peerCertificateChain(), sessionCipher(), privateKey(), QSslConfiguration::ciphers(), QSslConfiguration::caCertificates()

Returns a list of the last SSL errors that occurred. This is the same list as QSslSocket passes via the sslErrors() signal. If the connection has been encrypted with no errors, this function will return an empty list.

See also

connectToHostEncrypted()

QSslSocket emits this signal after the SSL handshake to indicate that one or more errors have occurred while establishing the identity of the peer. The errors are usually an indication that QSslSocket is unable to securely identify the peer. Unless any action is taken, the connection will be dropped after this signal has been emitted.

If you want to continue connecting despite the errors that have occurred, you must call QSslSocket::ignoreSslErrors() from inside a slot connected to this signal. If you need to access the error list at a later point, you can call sslErrors() (without arguments).

errors contains one or more errors that prevent QSslSocket from verifying the identity of the peer.

Note: You can not use Qt::QueuedConnection when connecting to this signal, or calling QSslSocket::ignoreSslErrors() will have no effect.

See also

peerVerifyError()

Returns the version number of the SSL library in use at compile time. If no SSL support is available then this will return an undefined value.

See also

sslLibraryVersionNumber()

Returns the version string of the SSL library in use at compile time. If no SSL support is available then this will return an empty value.

See also

sslLibraryVersionString()

Returns the version number of the SSL library in use. Note that this is the version of the library in use at runtime not compile time. If no SSL support is available then this will return an undefined value.

Returns the version string of the SSL library in use. Note that this is the version of the library in use at runtime not compile time. If no SSL support is available then this will return an empty value.

Starts a delayed SSL handshake for a client connection. This function can be called when the socket is in the ConnectedState but still in the UnencryptedMode. If it is not yet connected, or if it is already encrypted, this function has no effect.

Clients that implement STARTTLS functionality often make use of delayed SSL handshakes. Most other clients can avoid calling this function directly by using connectToHostEncrypted() instead, which automatically performs the handshake.

See also

connectToHostEncrypted(), startServerEncryption()

Starts a delayed SSL handshake for a server connection. This function can be called when the socket is in the ConnectedState but still in UnencryptedMode. If it is not connected or it is already encrypted, the function has no effect.

For server sockets, calling this function is the only way to initiate the SSL handshake. Most servers will call this function immediately upon receiving a connection, or as a result of having received a protocol-specific command to enter SSL mode (e.g, the server may respond to receiving the string "STARTTLS\r\n" by calling this function).

The most common way to implement an SSL server is to create a subclass of QTcpServer and reimplement QTcpServer::incomingConnection(). The returned socket descriptor is then passed to QSslSocket::setSocketDescriptor().

See also

connectToHostEncrypted(), startClientEncryption()

Returns true if this platform supports SSL encryption, otherwise returns false. If SSL encryption is not supported the socket will fail in the connection phase.

On most platforms SSL support depends on the OpenSSL library. Mac OS X uses the SecureTransport library.

Reimplemented from QAbstractSocket::waitForBytesWritten()

Waits until the socket is connected or msecs, whichever happens first. If the connection has been established this method returns true, otherwise it returns false.

See also

QAbstractSocket::waitForConnected()

Reimplemented from QAbstractSocket::waitForConnected()

Waits until the socket has disconnected or msecs, whichever comes first. If the connection has been disconnected, this method returns true, otherwise it returns false.

See also

QAbstractSocket::waitForDisconnected()

Reimplemented from QAbstractSocket::waitForDisconnected()

Waits until the socket has completed the SSL handshake and has emitted encrypted() or msecs, whichever comes first. If encrypted() has been emitted, this method returns true, otherwise false is returned.

The following example waits up to one second for the socket to be encrypted:

If msecs is -1, this function will not time out.

See also

startClientEncryption(), startServerEncryption(), encrypted(), isEncrypted()

Reimplemented from QAbstractSocket::waitForReadyRead()

Reimplemented from QAbstractSocket::writeData()