Skip to content
GitLab
Select Git revision
  • 6.2.2
  • dev default
  • 6.2
  • 6.2.1
  • 6.2.0
  • 5.12
  • 5.12.12
  • 5.15
  • 5.12.11
  • 5.15.2
  • 5.12.10
  • 5.15.1
  • 5.12.9
  • 5.15.0
  • 5.14
  • wip/cmake
  • 5.12.8
  • 5.14.2
  • 5.14.1
  • 5.12.7
  • v5.15.0-alpha1
  • v5.12.7
  • v5.14.1
  • v5.9.9
  • v5.14.0
  • v5.14.0-rc2
  • v5.14.0-rc1
  • v5.12.6
  • v5.14.0-beta3
  • v5.13.2
  • v5.14.0-beta2
  • v5.14.0-beta1
  • v5.14.0-alpha1
  • v5.12.5
  • v5.13.1
  • v5.13.0
  • v5.13.0-rc3
  • v5.12.4
  • v5.13.0-rc2
  • v5.13.0-rc1
Find file Blame History Permalink
tst_qwebsocketserver.cpp 19.31 KiB
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 test suite of the Qt Toolkit.
7 
**
8 
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
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 General Public License Usage
18 
** Alternatively, this file may be used under the terms of the GNU
19 
** General Public License version 3 as published by the Free Software
20 
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
21 
** included in the packaging of this file. Please review the following
22 
** information to ensure the GNU General Public License requirements will
23 
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
24 
**
25 
** $QT_END_LICENSE$
26 
**
27 
****************************************************************************/
28 
#include <QString>
29 
#include <QtTest>
30 
#include <QNetworkProxy>
31 
#ifndef QT_NO_OPENSSL
32 
#include <QtNetwork/qsslpresharedkeyauthenticator.h>
33 
#include <QtNetwork/qsslcipher.h>
34 
#endif
35 
#include <QtWebSockets/QWebSocketServer>
36 
#include <QtWebSockets/QWebSocket>
37 
#include <QtWebSockets/QWebSocketCorsAuthenticator>
38 
#include <QtWebSockets/qwebsocketprotocol.h>
39
40 
QT_USE_NAMESPACE
41
42 
Q_DECLARE_METATYPE(QWebSocketProtocol::Version)
43 
Q_DECLARE_METATYPE(QWebSocketProtocol::CloseCode)
44 
Q_DECLARE_METATYPE(QWebSocketServer::SslMode)
45 
Q_DECLARE_METATYPE(QWebSocketCorsAuthenticator *)
46 
#ifndef QT_NO_SSL
47 
Q_DECLARE_METATYPE(QSslError)
48 
#endif
49
50 
#ifndef QT_NO_OPENSSL
51 
// Use this cipher to force PSK key sharing.
52 
static const QString PSK_CIPHER_WITHOUT_AUTH = QStringLiteral("PSK-AES256-CBC-SHA");
53 
static const QByteArray PSK_CLIENT_PRESHAREDKEY = QByteArrayLiteral("\x1a\x2b\x3c\x4d\x5e\x6f");
54 
static const QByteArray PSK_SERVER_IDENTITY_HINT = QByteArrayLiteral("QtTestServerHint");
55 
static const QByteArray PSK_CLIENT_IDENTITY = QByteArrayLiteral("Client_identity");
56
57 
class PskProvider : public QObject
58 
{
59 
    Q_OBJECT
60
61 
public:
62 
    bool m_server = false;
63 
    QByteArray m_identity;
64 
    QByteArray m_psk;
65
66 
public slots:
67 
    void providePsk(QSslPreSharedKeyAuthenticator *authenticator)
68 
    {
69 
        QVERIFY(authenticator);
70 
        QCOMPARE(authenticator->identityHint(), PSK_SERVER_IDENTITY_HINT);
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
if (m_server) QCOMPARE(authenticator->maximumIdentityLength(), 0); else QVERIFY(authenticator->maximumIdentityLength() > 0); QVERIFY(authenticator->maximumPreSharedKeyLength() > 0); if (!m_identity.isEmpty()) { authenticator->setIdentity(m_identity); QCOMPARE(authenticator->identity(), m_identity); } if (!m_psk.isEmpty()) { authenticator->setPreSharedKey(m_psk); QCOMPARE(authenticator->preSharedKey(), m_psk); } } }; #endif class tst_QWebSocketServer : public QObject { Q_OBJECT public: tst_QWebSocketServer(); private Q_SLOTS: void init(); void initTestCase(); void cleanupTestCase(); void tst_initialisation(); void tst_settersAndGetters(); void tst_listening(); void tst_connectivity(); void tst_preSharedKey(); void tst_maxPendingConnections(); void tst_serverDestroyedWhileSocketConnected(); }; tst_QWebSocketServer::tst_QWebSocketServer() { } void tst_QWebSocketServer::init() { qRegisterMetaType<QWebSocketProtocol::Version>("QWebSocketProtocol::Version"); qRegisterMetaType<QWebSocketProtocol::CloseCode>("QWebSocketProtocol::CloseCode"); qRegisterMetaType<QWebSocketServer::SslMode>("QWebSocketServer::SslMode"); qRegisterMetaType<QWebSocketCorsAuthenticator *>("QWebSocketCorsAuthenticator *"); #ifndef QT_NO_SSL qRegisterMetaType<QSslError>("QSslError"); #ifndef QT_NO_OPENSSL qRegisterMetaType<QSslPreSharedKeyAuthenticator *>(); #endif #endif } void tst_QWebSocketServer::initTestCase() { } void tst_QWebSocketServer::cleanupTestCase() { } void tst_QWebSocketServer::tst_initialisation() { { QWebSocketServer server(QString(), QWebSocketServer::NonSecureMode);
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
QVERIFY(server.serverName().isEmpty()); QCOMPARE(server.secureMode(), QWebSocketServer::NonSecureMode); QVERIFY(!server.isListening()); QCOMPARE(server.maxPendingConnections(), 30); QCOMPARE(server.serverPort(), quint16(0)); QCOMPARE(server.serverAddress(), QHostAddress()); QCOMPARE(server.socketDescriptor(), -1); QVERIFY(!server.hasPendingConnections()); QVERIFY(!server.nextPendingConnection()); QCOMPARE(server.error(), QWebSocketProtocol::CloseCodeNormal); QVERIFY(server.errorString().isEmpty()); #ifndef QT_NO_NETWORKPROXY QCOMPARE(server.proxy().type(), QNetworkProxy::DefaultProxy); #endif #ifndef QT_NO_SSL QCOMPARE(server.sslConfiguration(), QSslConfiguration::defaultConfiguration()); #endif QCOMPARE(server.supportedVersions().count(), 1); QCOMPARE(server.supportedVersions().at(0), QWebSocketProtocol::VersionLatest); QCOMPARE(server.supportedVersions().at(0), QWebSocketProtocol::Version13); server.close(); //closing a server should not affect any of the parameters //certainly if the server was not opened before QVERIFY(server.serverName().isEmpty()); QCOMPARE(server.secureMode(), QWebSocketServer::NonSecureMode); QVERIFY(!server.isListening()); QCOMPARE(server.maxPendingConnections(), 30); QCOMPARE(server.serverPort(), quint16(0)); QCOMPARE(server.serverAddress(), QHostAddress()); QCOMPARE(server.socketDescriptor(), -1); QVERIFY(!server.hasPendingConnections()); QVERIFY(!server.nextPendingConnection()); QCOMPARE(server.error(), QWebSocketProtocol::CloseCodeNormal); QVERIFY(server.errorString().isEmpty()); #ifndef QT_NO_NETWORKPROXY QCOMPARE(server.proxy().type(), QNetworkProxy::DefaultProxy); #endif #ifndef QT_NO_SSL QCOMPARE(server.sslConfiguration(), QSslConfiguration::defaultConfiguration()); #endif QCOMPARE(server.supportedVersions().count(), 1); QCOMPARE(server.supportedVersions().at(0), QWebSocketProtocol::VersionLatest); QCOMPARE(server.supportedVersions().at(0), QWebSocketProtocol::Version13); QCOMPARE(server.serverUrl(), QUrl()); } { #ifndef QT_NO_SSL QWebSocketServer sslServer(QString(), QWebSocketServer::SecureMode); QCOMPARE(sslServer.secureMode(), QWebSocketServer::SecureMode); #endif } } void tst_QWebSocketServer::tst_settersAndGetters() { QWebSocketServer server(QString(), QWebSocketServer::NonSecureMode); server.setMaxPendingConnections(23); QCOMPARE(server.maxPendingConnections(), 23); server.setMaxPendingConnections(INT_MIN); QCOMPARE(server.maxPendingConnections(), INT_MIN); server.setMaxPendingConnections(INT_MAX); QCOMPARE(server.maxPendingConnections(), INT_MAX); QVERIFY(!server.setSocketDescriptor(-2)); QCOMPARE(server.socketDescriptor(), -1);
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
server.setServerName(QStringLiteral("Qt WebSocketServer")); QCOMPARE(server.serverName(), QStringLiteral("Qt WebSocketServer")); #ifndef QT_NO_NETWORKPROXY QNetworkProxy proxy(QNetworkProxy::Socks5Proxy); server.setProxy(proxy); QCOMPARE(server.proxy(), proxy); #endif #ifndef QT_NO_SSL //cannot set an ssl configuration on a non secure server QSslConfiguration sslConfiguration = QSslConfiguration::defaultConfiguration(); sslConfiguration.setPeerVerifyDepth(sslConfiguration.peerVerifyDepth() + 1); server.setSslConfiguration(sslConfiguration); QVERIFY(server.sslConfiguration() != sslConfiguration); QCOMPARE(server.sslConfiguration(), QSslConfiguration::defaultConfiguration()); QWebSocketServer sslServer(QString(), QWebSocketServer::SecureMode); sslServer.setSslConfiguration(sslConfiguration); QCOMPARE(sslServer.sslConfiguration(), sslConfiguration); QVERIFY(sslServer.sslConfiguration() != QSslConfiguration::defaultConfiguration()); #endif } void tst_QWebSocketServer::tst_listening() { //These listening tests are not too extensive, as the implementation of QWebSocketServer //relies on QTcpServer QWebSocketServer server(QString(), QWebSocketServer::NonSecureMode); QSignalSpy serverAcceptErrorSpy(&server, SIGNAL(acceptError(QAbstractSocket::SocketError))); QSignalSpy serverConnectionSpy(&server, SIGNAL(newConnection())); QSignalSpy serverErrorSpy(&server, SIGNAL(serverError(QWebSocketProtocol::CloseCode))); QSignalSpy corsAuthenticationSpy(&server, SIGNAL(originAuthenticationRequired(QWebSocketCorsAuthenticator*))); QSignalSpy serverClosedSpy(&server, SIGNAL(closed())); #ifndef QT_NO_SSL QSignalSpy peerVerifyErrorSpy(&server, SIGNAL(peerVerifyError(QSslError))); QSignalSpy sslErrorsSpy(&server, SIGNAL(sslErrors(QList<QSslError>))); #endif QVERIFY(server.listen()); //listen on all network interface, choose an appropriate port QVERIFY(server.isListening()); QCOMPARE(serverClosedSpy.count(), 0); server.close(); QVERIFY(serverClosedSpy.wait(1000)); QVERIFY(!server.isListening()); QCOMPARE(serverErrorSpy.count(), 0); QVERIFY(!server.listen(QHostAddress(QStringLiteral("1.2.3.4")), 0)); QCOMPARE(server.error(), QWebSocketProtocol::CloseCodeAbnormalDisconnection); QCOMPARE(server.errorString().toLatin1().constData(), "The address is not available"); QVERIFY(!server.isListening()); QCOMPARE(serverAcceptErrorSpy.count(), 0); QCOMPARE(serverConnectionSpy.count(), 0); QCOMPARE(corsAuthenticationSpy.count(), 0); #ifndef QT_NO_SSL QCOMPARE(peerVerifyErrorSpy.count(), 0); QCOMPARE(sslErrorsSpy.count(), 0); #endif QCOMPARE(serverErrorSpy.count(), 1); QCOMPARE(serverClosedSpy.count(), 1); } void tst_QWebSocketServer::tst_connectivity() { QWebSocketServer server(QString(), QWebSocketServer::NonSecureMode);
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
QSignalSpy serverConnectionSpy(&server, SIGNAL(newConnection())); QSignalSpy serverErrorSpy(&server, SIGNAL(serverError(QWebSocketProtocol::CloseCode))); QSignalSpy corsAuthenticationSpy(&server, SIGNAL(originAuthenticationRequired(QWebSocketCorsAuthenticator*))); QSignalSpy serverClosedSpy(&server, SIGNAL(closed())); #ifndef QT_NO_SSL QSignalSpy peerVerifyErrorSpy(&server, SIGNAL(peerVerifyError(QSslError))); QSignalSpy sslErrorsSpy(&server, SIGNAL(sslErrors(QList<QSslError>))); #endif QWebSocket socket; QSignalSpy socketConnectedSpy(&socket, SIGNAL(connected())); QVERIFY(server.listen()); QCOMPARE(server.serverAddress(), QHostAddress(QHostAddress::Any)); QCOMPARE(server.serverUrl(), QUrl(QStringLiteral("ws://") + QHostAddress(QHostAddress::LocalHost).toString() + QStringLiteral(":").append(QString::number(server.serverPort())))); socket.open(server.serverUrl().toString()); if (socketConnectedSpy.count() == 0) QVERIFY(socketConnectedSpy.wait()); QCOMPARE(socket.state(), QAbstractSocket::ConnectedState); QCOMPARE(serverConnectionSpy.count(), 1); QCOMPARE(corsAuthenticationSpy.count(), 1); QCOMPARE(serverClosedSpy.count(), 0); server.close(); QVERIFY(serverClosedSpy.wait()); QCOMPARE(serverClosedSpy.count(), 1); #ifndef QT_NO_SSL QCOMPARE(peerVerifyErrorSpy.count(), 0); QCOMPARE(sslErrorsSpy.count(), 0); #endif QCOMPARE(serverErrorSpy.count(), 0); } void tst_QWebSocketServer::tst_preSharedKey() { #ifndef QT_NO_OPENSSL QWebSocketServer server(QString(), QWebSocketServer::SecureMode); bool cipherFound = false; const QList<QSslCipher> supportedCiphers = QSslSocket::supportedCiphers(); for (const QSslCipher &cipher : supportedCiphers) { if (cipher.name() == PSK_CIPHER_WITHOUT_AUTH) { cipherFound = true; break; } } if (!cipherFound) QSKIP("SSL implementation does not support the necessary cipher"); QSslCipher cipher(PSK_CIPHER_WITHOUT_AUTH); QList<QSslCipher> list; list << cipher; QSslConfiguration config = QSslConfiguration::defaultConfiguration(); config.setCiphers(list); config.setPeerVerifyMode(QSslSocket::VerifyNone); config.setPreSharedKeyIdentityHint(PSK_SERVER_IDENTITY_HINT); server.setSslConfiguration(config); PskProvider providerServer; providerServer.m_server = true; providerServer.m_identity = PSK_CLIENT_IDENTITY; providerServer.m_psk = PSK_CLIENT_PRESHAREDKEY;
351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
connect(&server, &QWebSocketServer::preSharedKeyAuthenticationRequired, &providerServer, &PskProvider::providePsk); QSignalSpy serverPskRequiredSpy(&server, &QWebSocketServer::preSharedKeyAuthenticationRequired); QSignalSpy serverConnectionSpy(&server, &QWebSocketServer::newConnection); QSignalSpy serverErrorSpy(&server, SIGNAL(serverError(QWebSocketProtocol::CloseCode))); QSignalSpy serverClosedSpy(&server, &QWebSocketServer::closed); QSignalSpy sslErrorsSpy(&server, SIGNAL(sslErrors(QList<QSslError>))); QWebSocket socket; QSslConfiguration socketConfig = QSslConfiguration::defaultConfiguration(); socketConfig.setPeerVerifyMode(QSslSocket::VerifyNone); socketConfig.setCiphers(list); socket.setSslConfiguration(socketConfig); PskProvider providerClient; providerClient.m_identity = PSK_CLIENT_IDENTITY; providerClient.m_psk = PSK_CLIENT_PRESHAREDKEY; connect(&socket, &QWebSocket::preSharedKeyAuthenticationRequired, &providerClient, &PskProvider::providePsk); QSignalSpy socketPskRequiredSpy(&socket, &QWebSocket::preSharedKeyAuthenticationRequired); QSignalSpy socketConnectedSpy(&socket, &QWebSocket::connected); QVERIFY(server.listen()); QCOMPARE(server.serverAddress(), QHostAddress(QHostAddress::Any)); QCOMPARE(server.serverUrl(), QUrl(QString::asprintf("wss://%ls:%d", qUtf16Printable(QHostAddress(QHostAddress::LocalHost).toString()), server.serverPort()))); socket.open(server.serverUrl().toString()); if (socketConnectedSpy.count() == 0) QVERIFY(socketConnectedSpy.wait()); QCOMPARE(socket.state(), QAbstractSocket::ConnectedState); QCOMPARE(serverConnectionSpy.count(), 1); QCOMPARE(serverPskRequiredSpy.count(), 1); QCOMPARE(socketPskRequiredSpy.count(), 1); QCOMPARE(serverClosedSpy.count(), 0); server.close(); QVERIFY(serverClosedSpy.wait()); QCOMPARE(serverClosedSpy.count(), 1); QCOMPARE(sslErrorsSpy.count(), 0); QCOMPARE(serverErrorSpy.count(), 0); #endif } void tst_QWebSocketServer::tst_maxPendingConnections() { //tests if maximum connections are respected //also checks if there are no side-effects like signals that are unexpectedly thrown QWebSocketServer server(QString(), QWebSocketServer::NonSecureMode); server.setMaxPendingConnections(2); QSignalSpy serverConnectionSpy(&server, SIGNAL(newConnection())); QSignalSpy serverErrorSpy(&server, SIGNAL(serverError(QWebSocketProtocol::CloseCode))); QSignalSpy corsAuthenticationSpy(&server, SIGNAL(originAuthenticationRequired(QWebSocketCorsAuthenticator*))); QSignalSpy serverClosedSpy(&server, SIGNAL(closed())); #ifndef QT_NO_SSL QSignalSpy peerVerifyErrorSpy(&server, SIGNAL(peerVerifyError(QSslError))); QSignalSpy sslErrorsSpy(&server, SIGNAL(sslErrors(QList<QSslError>))); #endif QSignalSpy serverAcceptErrorSpy(&server, SIGNAL(acceptError(QAbstractSocket::SocketError))); QWebSocket socket1; QWebSocket socket2; QWebSocket socket3; QSignalSpy socket1ConnectedSpy(&socket1, SIGNAL(connected()));
421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490
QSignalSpy socket2ConnectedSpy(&socket2, SIGNAL(connected())); QSignalSpy socket3ConnectedSpy(&socket3, SIGNAL(connected())); QVERIFY(server.listen()); socket1.open(server.serverUrl().toString()); if (socket1ConnectedSpy.count() == 0) QVERIFY(socket1ConnectedSpy.wait()); QCOMPARE(socket1.state(), QAbstractSocket::ConnectedState); QCOMPARE(serverConnectionSpy.count(), 1); QCOMPARE(corsAuthenticationSpy.count(), 1); socket2.open(server.serverUrl().toString()); if (socket2ConnectedSpy.count() == 0) QVERIFY(socket2ConnectedSpy.wait()); QCOMPARE(socket2.state(), QAbstractSocket::ConnectedState); QCOMPARE(serverConnectionSpy.count(), 2); QCOMPARE(corsAuthenticationSpy.count(), 2); socket3.open(server.serverUrl().toString()); if (socket3ConnectedSpy.count() == 0) QVERIFY(!socket3ConnectedSpy.wait(250)); QCOMPARE(socket3.state(), QAbstractSocket::UnconnectedState); QCOMPARE(serverConnectionSpy.count(), 2); QCOMPARE(corsAuthenticationSpy.count(), 2); QVERIFY(server.hasPendingConnections()); QWebSocket *pSocket = server.nextPendingConnection(); QVERIFY(pSocket); delete pSocket; QVERIFY(server.hasPendingConnections()); pSocket = server.nextPendingConnection(); QVERIFY(pSocket); delete pSocket; QVERIFY(!server.hasPendingConnections()); QVERIFY(!server.nextPendingConnection()); //will resolve in another commit #ifndef Q_OS_WIN QCOMPARE(serverErrorSpy.count(), 1); QCOMPARE(serverErrorSpy.at(0).at(0).value<QWebSocketProtocol::CloseCode>(), QWebSocketProtocol::CloseCodeAbnormalDisconnection); #endif QCOMPARE(serverClosedSpy.count(), 0); server.close(); QVERIFY(serverClosedSpy.wait()); QCOMPARE(serverClosedSpy.count(), 1); #ifndef QT_NO_SSL QCOMPARE(peerVerifyErrorSpy.count(), 0); QCOMPARE(sslErrorsSpy.count(), 0); #endif QCOMPARE(serverAcceptErrorSpy.count(), 0); } void tst_QWebSocketServer::tst_serverDestroyedWhileSocketConnected() { QWebSocketServer * server = new QWebSocketServer(QString(), QWebSocketServer::NonSecureMode); QSignalSpy serverConnectionSpy(server, SIGNAL(newConnection())); QSignalSpy corsAuthenticationSpy(server, SIGNAL(originAuthenticationRequired(QWebSocketCorsAuthenticator*))); QSignalSpy serverClosedSpy(server, SIGNAL(closed())); QWebSocket socket; QSignalSpy socketConnectedSpy(&socket, SIGNAL(connected())); QSignalSpy socketDisconnectedSpy(&socket, SIGNAL(disconnected())); QVERIFY(server->listen()); QCOMPARE(server->serverAddress(), QHostAddress(QHostAddress::Any)); QCOMPARE(server->serverUrl(), QUrl(QStringLiteral("ws://") + QHostAddress(QHostAddress::LocalHost).toString() +
491492493494495496497498499500501502503504505506507508509510511512513
QStringLiteral(":").append(QString::number(server->serverPort())))); socket.open(server->serverUrl().toString()); if (socketConnectedSpy.count() == 0) QVERIFY(socketConnectedSpy.wait()); QCOMPARE(socket.state(), QAbstractSocket::ConnectedState); QCOMPARE(serverConnectionSpy.count(), 1); QCOMPARE(corsAuthenticationSpy.count(), 1); QCOMPARE(serverClosedSpy.count(), 0); delete server; if (socketDisconnectedSpy.count() == 0) QVERIFY(socketDisconnectedSpy.wait()); QCOMPARE(socketDisconnectedSpy.count(), 1); } QTEST_MAIN(tst_QWebSocketServer) #include "tst_qwebsocketserver.moc"