QWebSocketCorsAuthenticator#

The QWebSocketCorsAuthenticator class provides an authenticator object for Cross Origin Requests (CORS). More…

Synopsis#

Functions#

Note

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

Detailed Description#

The QWebSocketCorsAuthenticator class is used in the originAuthenticationRequired() signal. The class provides a way to pass back the required information to the QWebSocketServer . It provides applications with fine-grained control over which origin URLs are allowed and which aren’t. By default, every origin is accepted. To get fine-grained control, an application connects the originAuthenticationRequired() signal to a slot. When the origin ( origin() ) is accepted, it calls setAllowed (true)

Note

Checking on the origin does not make much sense when the server is accessed via a non-browser client, as that client can set whatever origin header it likes. In case of a browser client, the server SHOULD check the validity of the origin.

See also

WebSocket Security Considerations QWebSocketServer

class PySide6.QtWebSockets.QWebSocketCorsAuthenticator(origin)#

PySide6.QtWebSockets.QWebSocketCorsAuthenticator(other)

Parameters:

Constructs a new QCorsAuthencator object with the given origin.

Note

By default, allowed() returns true. This means that per default every origin is accepted.

Constructs a copy of other.

PySide6.QtWebSockets.QWebSocketCorsAuthenticator.allowed()#
Return type:

bool

Returns true if the origin is allowed, otherwise returns false.

Note

By default, all origins are accepted.

See also

setAllowed()

PySide6.QtWebSockets.QWebSocketCorsAuthenticator.origin()#
Return type:

str

Returns the origin this autenticator is handling about.

PySide6.QtWebSockets.QWebSocketCorsAuthenticator.setAllowed(allowed)#
Parameters:

allowed – bool

Allows or disallows the origin. Setting allowed to true, will accept the connection request for the given origin.

Setting allowed to false, will reject the connection request.

Note

By default, all origins are accepted.

See also

allowed()

PySide6.QtWebSockets.QWebSocketCorsAuthenticator.swap(other)#
Parameters:

other – PySide6.QtWebSockets.QWebSocketCorsAuthenticator

Swaps other with this authenticator.

This operation is very fast and never fails.