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
|
// Copyright (C) 2016 Kurt Pattyn <pattyn.kurt@gmail.com>.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
/*!
\class QWebSocketCorsAuthenticator
\inmodule QtWebSockets
\since 5.3
\brief The QWebSocketCorsAuthenticator class provides an authenticator object for
Cross Origin Requests (CORS).
The QWebSocketCorsAuthenticator class is used in the
\l{QWebSocketServer::}{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
\l{QWebSocketServer::}{originAuthenticationRequired()} signal to a slot.
When the origin (QWebSocketCorsAuthenticator::origin()) is accepted,
it calls QWebSocketCorsAuthenticator::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.
\sa {WebSocket Security Considerations}
\sa QWebSocketServer
*/
#include "qwebsocketcorsauthenticator.h"
#include "qwebsocketcorsauthenticator_p.h"
QT_BEGIN_NAMESPACE
/*!
\internal
*/
QWebSocketCorsAuthenticatorPrivate::QWebSocketCorsAuthenticatorPrivate(const QString &origin,
bool allowed) :
m_origin(origin),
m_isAllowed(allowed)
{}
/*!
Destroys the object.
*/
QWebSocketCorsAuthenticatorPrivate::~QWebSocketCorsAuthenticatorPrivate()
{}
/*!
Constructs a new QCorsAuthencator object with the given \a origin.
\note By default, allowed() returns true. This means that per default every origin is accepted.
*/
QWebSocketCorsAuthenticator::QWebSocketCorsAuthenticator(const QString &origin) :
d_ptr(new QWebSocketCorsAuthenticatorPrivate(origin, true))
{
}
/*!
Destroys the object.
*/
QWebSocketCorsAuthenticator::~QWebSocketCorsAuthenticator()
{
}
/*!
Constructs a copy of \a other.
*/
QWebSocketCorsAuthenticator::QWebSocketCorsAuthenticator(const QWebSocketCorsAuthenticator &other) :
d_ptr(new QWebSocketCorsAuthenticatorPrivate(other.d_ptr->m_origin, other.d_ptr->m_isAllowed))
{
}
/*!
Assigns \a other to this authenticator object.
*/
QWebSocketCorsAuthenticator &
QWebSocketCorsAuthenticator::operator =(const QWebSocketCorsAuthenticator &other)
{
Q_D(QWebSocketCorsAuthenticator);
if (this != &other) {
d->m_origin = other.d_ptr->m_origin;
d->m_isAllowed = other.d_ptr->m_isAllowed;
}
return *this;
}
/*!
Move-constructs a QWebSocketCorsAuthenticator, making it point at the same
object \a other was pointing to.
*/
QWebSocketCorsAuthenticator::QWebSocketCorsAuthenticator(QWebSocketCorsAuthenticator &&other) noexcept :
d_ptr(other.d_ptr.release())
{}
/*!
Move-assigns \a other to this instance.
*/
QWebSocketCorsAuthenticator &
QWebSocketCorsAuthenticator::operator =(QWebSocketCorsAuthenticator &&other) noexcept
{
qSwap(d_ptr, other.d_ptr);
return *this;
}
/*!
Swaps \a other with this authenticator.
This operation is very fast and never fails.
*/
void QWebSocketCorsAuthenticator::swap(QWebSocketCorsAuthenticator &other) noexcept
{
if (&other != this)
qSwap(d_ptr, other.d_ptr);
}
/*!
Returns the origin this autenticator is handling about.
*/
QString QWebSocketCorsAuthenticator::origin() const
{
Q_D(const QWebSocketCorsAuthenticator);
return d->m_origin;
}
/*!
Allows or disallows the origin. Setting \a allowed to true, will accept the connection request
for the given origin.
Setting \a allowed to false, will reject the connection request.
\note By default, all origins are accepted.
*/
void QWebSocketCorsAuthenticator::setAllowed(bool allowed)
{
Q_D(QWebSocketCorsAuthenticator);
d->m_isAllowed = allowed;
}
/*!
Returns true if the origin is allowed, otherwise returns false.
\note By default, all origins are accepted.
*/
bool QWebSocketCorsAuthenticator::allowed() const
{
Q_D(const QWebSocketCorsAuthenticator);
return d->m_isAllowed;
}
QT_END_NAMESPACE
|
