1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
/****************************************************************************
**
** Copyright (C) 2016 Kurt Pattyn <pattyn.kurt@gmail.com>.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtWebSockets module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qwebsocketprotocol_p.h"
#include <QtCore/QString>
#include <QtCore/QSet>
#include <QtCore/QtEndian>
QT_BEGIN_NAMESPACE
/*!
\namespace QWebSocketProtocol
\inmodule QtWebSockets
\brief Contains constants related to the WebSocket standard.
\since 5.3
*/
/*!
\enum QWebSocketProtocol::CloseCode
\inmodule QtWebSockets
The close codes supported by WebSockets V13
\value CloseCodeNormal Normal closure
\value CloseCodeGoingAway Going away
\value CloseCodeProtocolError Protocol error
\value CloseCodeDatatypeNotSupported Unsupported data
\value CloseCodeReserved1004 Reserved
\value CloseCodeMissingStatusCode No status received
\value CloseCodeAbnormalDisconnection Abnormal closure
\value CloseCodeWrongDatatype Invalid frame payload data
\value CloseCodePolicyViolated Policy violation
\value CloseCodeTooMuchData Message too big
\value CloseCodeMissingExtension Mandatory extension missing
\value CloseCodeBadOperation Internal server error
\value CloseCodeTlsHandshakeFailed TLS handshake failed
\sa QWebSocket::close()
*/
/*!
\enum QWebSocketProtocol::Version
\inmodule QtWebSockets
\brief The different defined versions of the WebSocket protocol.
For an overview of the differences between the different protocols, see
\l {pywebsocket's WebSocketProtocolSpec}.
\value VersionUnknown Unknown or unspecified version.
\value Version0 \l{hixie76} and \l{hybi-00}.
Works with key1, key2 and a key in the payload.
Attribute: Sec-WebSocket-Draft value 0.
Not supported by QtWebSockets.
\value Version4 \l{hybi-04}.
Changed handshake: key1, key2, key3
==> Sec-WebSocket-Key, Sec-WebSocket-Nonce, Sec-WebSocket-Accept
Sec-WebSocket-Draft renamed to Sec-WebSocket-Version
Sec-WebSocket-Version = 4.
Not supported by QtWebSockets.
\value Version5 \l{hybi-05}.
Sec-WebSocket-Version = 5
Removed Sec-WebSocket-Nonce
Added Sec-WebSocket-Accept.
Not supported by QtWebSockets.
\value Version6 Sec-WebSocket-Version = 6.
Not supported by QtWebSockets.
\value Version7 \l{hybi-07}.
Sec-WebSocket-Version = 7.
Not supported by QtWebSockets.
\value Version8 hybi-8, hybi-9, hybi-10, hybi-11 and hybi-12.
Status codes 1005 and 1006 are added and all codes are now unsigned
Internal error results in 1006.
Not supported by QtWebSockets.
\value Version13 hybi-13, hybi14, hybi-15, hybi-16, hybi-17 and \l{RFC 6455}.
Sec-WebSocket-Version = 13
Status code 1004 is now reserved
Added 1008, 1009 and 1010
Must support TLS
Clarify multiple version support.
Supported by QtWebSockets.
\value VersionLatest Refers to the latest known version to QtWebSockets.
*/
/*!
\enum QWebSocketProtocol::OpCode
\inmodule QtWebSockets
The frame opcodes as defined by the WebSockets standard
\value OpCodeContinue Continuation frame
\value OpCodeText Text frame
\value OpCodeBinary Binary frame
\value OpCodeReserved3 Reserved
\value OpCodeReserved4 Reserved
\value OpCodeReserved5 Reserved
\value OpCodeReserved6 Reserved
\value OpCodeReserved7 Reserved
\value OpCodeClose Close frame
\value OpCodePing Ping frame
\value OpCodePong Pong frame
\value OpCodeReservedB Reserved
\value OpCodeReservedC Reserved
\value OpCodeReservedD Reserved
\value OpCodeReservedE Reserved
\value OpCodeReservedF Reserved
\internal
*/
/*!
\fn QWebSocketProtocol::isOpCodeReserved(OpCode code)
Checks if \a code is a valid OpCode
\internal
*/
/*!
\fn QWebSocketProtocol::isCloseCodeValid(int closeCode)
Checks if \a closeCode is a valid WebSocket close code
\internal
*/
/*!
\fn QWebSocketProtocol::currentVersion()
Returns the latest version that WebSocket is supporting
\internal
*/
/*!
Parses the \a versionString and converts it to a Version value
\internal
*/
QWebSocketProtocol::Version QWebSocketProtocol::versionFromString(const QString &versionString)
{
bool ok = false;
Version version = VersionUnknown;
const int ver = versionString.toInt(&ok);
QSet<Version> supportedVersions;
supportedVersions << Version0 << Version4 << Version5 << Version6 << Version7 << Version8
<< Version13;
if (Q_LIKELY(ok) && (supportedVersions.contains(static_cast<Version>(ver))))
version = static_cast<Version>(ver);
return version;
}
/*!
Mask the \a payload with the given \a maskingKey and stores the result back in \a payload.
\internal
*/
void QWebSocketProtocol::mask(QByteArray *payload, quint32 maskingKey)
{
Q_ASSERT(payload);
mask(payload->data(), quint64(payload->size()), maskingKey);
}
/*!
Masks the \a payload of length \a size with the given \a maskingKey and
stores the result back in \a payload.
\internal
*/
void QWebSocketProtocol::mask(char *payload, quint64 size, quint32 maskingKey)
{
Q_ASSERT(payload);
const quint8 mask[] = { quint8((maskingKey & 0xFF000000u) >> 24),
quint8((maskingKey & 0x00FF0000u) >> 16),
quint8((maskingKey & 0x0000FF00u) >> 8),
quint8((maskingKey & 0x000000FFu))
};
int i = 0;
while (size-- > 0)
*payload++ ^= mask[i++ % 4];
}
QT_END_NAMESPACE
|
