QMaskGenerator Class

The QMaskGenerator class provides an abstract base for custom 32-bit mask generators. More...

Header:	#include <QMaskGenerator>
CMake:	find_package(Qt6 COMPONENTS WebSockets REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::WebSockets)
qmake:	QT += websockets
Since:	Qt 5.3
Inherits:	QObject

• List of all members, including inherited members

Public Functions

	QMaskGenerator(QObject *parent = nullptr)
virtual	~QMaskGenerator() override
virtual quint32	nextMask() = 0
virtual bool	seed() = 0

Detailed Description

The WebSockets specification as outlined in RFC 6455 requires that all communication from client to server be masked. This is to prevent malicious scripts from attacking badly behaving proxies. For more information about the importance of good masking, see "Talking to Yourself for Fun and Profit" by Lin-Shung Huang et al. By default QWebSocket uses the reasonably secure QRandomGenerator::global()->generate() function. The best measure against attacks mentioned in the document above, is to use QWebSocket over a secure connection (wss://). In general, always be careful to not have 3rd party script access to a QWebSocket in your application.

Member Function Documentation

QMaskGenerator::QMaskGenerator(QObject *parent = nullptr)

Creates a new QMaskGenerator object with the given optional QObject parent.

[override virtual] QMaskGenerator::~QMaskGenerator()

Destroys the QMaskGenerator object.

[pure virtual] quint32 QMaskGenerator::nextMask()

Returns a new random 32-bit mask. The randomness depends on the RNG used to created the mask.

[pure virtual] bool QMaskGenerator::seed()

Initializes the QMaskGenerator by seeding the randomizer. When seed() is not called, it depends on the specific implementation of a subclass if a default seed is used or no seed is used at all. Returns true if seeding succeeds, otherwise false.