Implements an encrypted, secure TCP server over TLS. More…
New in version 6.4.
alertReceived(socket, level, type, description)
alertSent(socket, level, type, description)
This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE
Class to use in place of
QTcpServer to implement TCP server using Transport Layer Security (TLS).
To configure the secure handshake settings, use the applicable setter functions on a
QSslConfiguration object, and then use it as an argument to the
setSslConfiguration() function. All following incoming connections handled will use these settings.
Connect to the signals of this class to respond to the incoming connection attempts. They are the same as the signals on
QSslSocket , but also passes a pointer to the socket in question.
When responding to the
pendingConnectionAvailable() signal, use the
nextPendingConnection() function to fetch the next incoming connection and take it out of the pending connection queue. The
QSslSocket is a child of the
QSslServer and will be deleted when the
QSslServer is deleted. It is still a good idea to destroy the object explicitly when you are done with it, to avoid wasting memory.
Constructs a new
QSslServer with the given
- PySide6.QtNetwork.QSslServer.alertReceived(socket, level, type, description)#
QSslServer emits this signal if an alert message was received by the
socket from a peer.
level tells if the alert was fatal or it was a warning.
type is the code explaining why the alert was sent. When a textual description of the alert message is available, it is supplied in
The signal is mostly for informational and debugging purposes and does not require any handling in the application. If the alert was fatal, underlying backend will handle it and close the connection.
Not all backends support this functionality.
- PySide6.QtNetwork.QSslServer.alertSent(socket, level, type, description)#
QSslServer emits this signal if an alert message was sent from
socket to a peer.
level describes if it was a warning or a fatal error.
type gives the code of the alert message. When a textual description of the alert message is available, it is supplied in
This signal is mostly informational and can be used for debugging purposes, normally it does not require any actions from the application.
Not all backends support this functionality.
- PySide6.QtNetwork.QSslServer.errorOccurred(socket, error)#
This signal is emitted after an error occurred during handshake. The
socketError parameter describes the type of error that occurred.
socket is automatically deleted after this signal is emitted if the socket handshake has not reached encrypted state. But if the
socket is successfully encrypted, it is inserted into the
QSslServer ‘s pending connections queue. When the user has called
nextPendingConnection() it is the user’s responsibility to destroy the
socket or the
socket will not be destroyed until the
QSslServer object is destroyed. If an error occurs on a
socket after it has been inserted into the pending connections queue, this signal will not be emitted, and the
socket will not be removed or destroyed.
You cannot use
QueuedConnection when connecting to this signal, or the
socket will have been already destroyed when the signal is handled.
- PySide6.QtNetwork.QSslServer.handshakeInterruptedOnError(socket, error)#
QSslServer emits this signal if a certificate verification error was found by
socket and if early error reporting was enabled in
QSslConfiguration . An application is expected to inspect the
error and decide if it wants to continue the handshake, or abort it and send an alert message to the peer. The signal-slot connection must be direct.
- Return type:
Returns the currently configured handshake timeout.
- PySide6.QtNetwork.QSslServer.peerVerifyError(socket, error)#
QSslServer 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
socket 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,
QSslServer will proceed to emitting
QSslServer emits this signal when
socket negotiates a PSK ciphersuite, and therefore PSK authentication is then required.
When using PSK, the server must supply 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.
authenticator object is owned by the
socket and must not be deleted by the application.
timeout – int
timeout to use for all incoming handshakes, in milliseconds.
This is relevant in the scenario where a client, whether malicious or accidental, connects to the server but makes no attempt at communicating or initiating a handshake.
QSslServer will then automatically end the connection after
timeout milliseconds have elapsed.
By default the timeout is 5000 milliseconds (5 seconds).
The underlying TLS framework may have their own timeout logic now or in the future, this function does not affect that.
timeout passed to this function will only apply to new connections. If a client is already connected it will use the timeout which was set when it connected.
sslConfiguration to use for all following incoming connections.
This must be called before
listen() to ensure that the desired configuration was in use during all handshakes.
Returns the current ssl configuration.
- PySide6.QtNetwork.QSslServer.sslErrors(socket, errors)#
QSslServer 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
socket 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
ignoreSslErrors() from inside a slot connected to this signal. If you need to access the error list at a later point, you can call sslHandshakeErrors().
errors contains one or more errors that prevent
QSslSocket from verifying the identity of the peer.
You cannot use
QueuedConnection when connecting to this signal, or calling
ignoreSslErrors() will have no effect.
This signal is emitted when the client, connected to
socket, initiates the TLS handshake.