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

Detailed Description¶
The
QWebSocketCorsAuthenticator
class is used in theoriginAuthenticationRequired()
signal. The class provides a way to pass back the required information to theQWebSocketServer
. 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 theoriginAuthenticationRequired()
signal to a slot. When the origin (origin()
) is accepted, it callssetAllowed
(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
QWebSocketCorsAuthenticator
(origin)¶ QWebSocketCorsAuthenticator(other)
- param origin
unicode
- param other
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
.
-
PySide2.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
-
PySide2.QtWebSockets.QWebSocketCorsAuthenticator.
origin
()¶ - Return type
unicode
Returns the origin this autenticator is handling about.
-
PySide2.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
-
PySide2.QtWebSockets.QWebSocketCorsAuthenticator.
swap
(other)¶ - Parameters
other –
QWebSocketCorsAuthenticator
Swaps
other
with this authenticator.This operation is very fast and never fails.