1 | /**************************************************************************** |
2 | ** |
3 | ** Copyright (C) 2016 Kurt Pattyn <pattyn.kurt@gmail.com>. |
4 | ** Contact: https://www.qt.io/licensing/ |
5 | ** |
6 | ** This file is part of the QtWebSockets module of the Qt Toolkit. |
7 | ** |
8 | ** $QT_BEGIN_LICENSE:LGPL$ |
9 | ** Commercial License Usage |
10 | ** Licensees holding valid commercial Qt licenses may use this file in |
11 | ** accordance with the commercial license agreement provided with the |
12 | ** Software or, alternatively, in accordance with the terms contained in |
13 | ** a written agreement between you and The Qt Company. For licensing terms |
14 | ** and conditions see https://www.qt.io/terms-conditions. For further |
15 | ** information use the contact form at https://www.qt.io/contact-us. |
16 | ** |
17 | ** GNU Lesser General Public License Usage |
18 | ** Alternatively, this file may be used under the terms of the GNU Lesser |
19 | ** General Public License version 3 as published by the Free Software |
20 | ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
21 | ** packaging of this file. Please review the following information to |
22 | ** ensure the GNU Lesser General Public License version 3 requirements |
23 | ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
24 | ** |
25 | ** GNU General Public License Usage |
26 | ** Alternatively, this file may be used under the terms of the GNU |
27 | ** General Public License version 2.0 or (at your option) the GNU General |
28 | ** Public license version 3 or any later version approved by the KDE Free |
29 | ** Qt Foundation. The licenses are as published by the Free Software |
30 | ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
31 | ** included in the packaging of this file. Please review the following |
32 | ** information to ensure the GNU General Public License requirements will |
33 | ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
34 | ** https://www.gnu.org/licenses/gpl-3.0.html. |
35 | ** |
36 | ** $QT_END_LICENSE$ |
37 | ** |
38 | ****************************************************************************/ |
39 | |
40 | /*! |
41 | \class QMaskGenerator |
42 | |
43 | \inmodule QtWebSockets |
44 | \since 5.3 |
45 | |
46 | \brief The QMaskGenerator class provides an abstract base for custom 32-bit mask generators. |
47 | |
48 | The WebSockets specification as outlined in \l {RFC 6455} |
49 | requires that all communication from client to server be masked. This is to prevent |
50 | malicious scripts from attacking badly behaving proxies. |
51 | For more information about the importance of good masking, |
52 | see \l {"Talking to Yourself for Fun and Profit" by Lin-Shung Huang et al}. |
53 | By default QWebSocket uses the reasonably secure QRandomGenerator::global()->generate() function. |
54 | The best measure against attacks mentioned in the document above, |
55 | is to use QWebSocket over a secure connection (\e wss://). |
56 | In general, always be careful to not have 3rd party script access to |
57 | a QWebSocket in your application. |
58 | */ |
59 | |
60 | /*! |
61 | \fn bool QMaskGenerator::seed() |
62 | |
63 | Initializes the QMaskGenerator by seeding the randomizer. |
64 | When seed() is not called, it depends on the specific implementation of a subclass if |
65 | a default seed is used or no seed is used at all. |
66 | Returns \e true if seeding succeeds, otherwise false. |
67 | */ |
68 | |
69 | /*! |
70 | \fn quint32 QMaskGenerator::nextMask() |
71 | |
72 | Returns a new random 32-bit mask. The randomness depends on the RNG used to created the |
73 | mask. |
74 | */ |
75 | |
76 | #include "qmaskgenerator.h" |
77 | |
78 | QT_BEGIN_NAMESPACE |
79 | |
80 | /*! |
81 | Creates a new QMaskGenerator object with the given optional QObject \a parent. |
82 | */ |
83 | QMaskGenerator::QMaskGenerator(QObject *parent) : |
84 | QObject(parent) |
85 | { |
86 | } |
87 | |
88 | /*! |
89 | Destroys the QMaskGenerator object. |
90 | */ |
91 | QMaskGenerator::~QMaskGenerator() |
92 | {} |
93 | |
94 | QT_END_NAMESPACE |
95 | |