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 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
|
/****************************************************************************
**
** Copyright (C) 2016 Kurt Pattyn <pattyn.kurt@gmail.com>.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the test suite of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** 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-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include <QString>
#include <QtTest>
#include <QNetworkProxy>
#include <QTcpSocket>
#include <QTcpServer>
#include <QtCore/QScopedPointer>
#ifndef QT_NO_OPENSSL
#include <QtNetwork/qsslpresharedkeyauthenticator.h>
#endif
#ifndef QT_NO_SSL
#include <QtNetwork/qsslcipher.h>
#include <QtNetwork/qsslkey.h>
#include <QtNetwork/qsslsocket.h>
#endif
#include <QtWebSockets/QWebSocketServer>
#include <QtWebSockets/QWebSocket>
#include <QtWebSockets/QWebSocketCorsAuthenticator>
#include <QtWebSockets/qwebsocketprotocol.h>
QT_USE_NAMESPACE
Q_DECLARE_METATYPE(QWebSocketProtocol::Version)
Q_DECLARE_METATYPE(QWebSocketProtocol::CloseCode)
Q_DECLARE_METATYPE(QWebSocketServer::SslMode)
Q_DECLARE_METATYPE(QWebSocketCorsAuthenticator *)
#ifndef QT_NO_SSL
Q_DECLARE_METATYPE(QSslError)
#endif
#ifndef QT_NO_OPENSSL
// Use this cipher to force PSK key sharing.
static const QString PSK_CIPHER_WITHOUT_AUTH = QStringLiteral("PSK-AES256-CBC-SHA");
static const QByteArray PSK_CLIENT_PRESHAREDKEY = QByteArrayLiteral("\x1a\x2b\x3c\x4d\x5e\x6f");
static const QByteArray PSK_SERVER_IDENTITY_HINT = QByteArrayLiteral("QtTestServerHint");
static const QByteArray PSK_CLIENT_IDENTITY = QByteArrayLiteral("Client_identity");
class PskProvider : public QObject
{
Q_OBJECT
public:
bool m_server = false;
QByteArray m_identity;
QByteArray m_psk;
public slots:
void providePsk(QSslPreSharedKeyAuthenticator *authenticator)
{
QVERIFY(authenticator);
QCOMPARE(authenticator->identityHint(), PSK_SERVER_IDENTITY_HINT);
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();
void tst_scheme(); // qtbug-55927
void tst_handleConnection();
void tst_handshakeTimeout(); // qtbug-63312, qtbug-57026
void multipleFrames();
private:
bool m_shouldSkipUnsupportedIpv6Test;
#ifdef SHOULD_CHECK_SYSCALL_SUPPORT
bool ipv6GetsockoptionMissing(int level, int optname);
#endif
};
tst_QWebSocketServer::tst_QWebSocketServer() : m_shouldSkipUnsupportedIpv6Test(false)
{
}
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
}
#ifdef SHOULD_CHECK_SYSCALL_SUPPORT
#include <netinet/in.h>
#include <sys/socket.h>
#include <errno.h>
#include <unistd.h>
bool tst_QWebSocketServer::ipv6GetsockoptionMissing(int level, int optname)
{
int testSocket;
testSocket = socket(PF_INET6, SOCK_STREAM, 0);
// If we can't test here, assume it's not missing
if (testSocket == -1)
return false;
bool result = false;
if (getsockopt(testSocket, level, optname, nullptr, 0) == -1) {
if (errno == EOPNOTSUPP) {
result = true;
}
}
close(testSocket);
return result;
}
#endif //SHOULD_CHECK_SYSCALL_SUPPORT
void tst_QWebSocketServer::initTestCase()
{
#ifdef SHOULD_CHECK_SYSCALL_SUPPORT
// Qemu does not have required support for IPV6 socket options.
// If this is detected, skip the test
m_shouldSkipUnsupportedIpv6Test = ipv6GetsockoptionMissing(SOL_IPV6, IPV6_V6ONLY);
#endif
}
void tst_QWebSocketServer::cleanupTestCase()
{
}
void tst_QWebSocketServer::tst_initialisation()
{
{
QWebSocketServer server(QString(), QWebSocketServer::NonSecureMode);
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());
#if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
QCOMPARE(server.socketDescriptor(), -1);
#else // ### Qt 6: Remove leftovers
QCOMPARE(server.nativeDescriptor(), -1);
#endif // (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
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());
#if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
QCOMPARE(server.socketDescriptor(), -1);
#else // ### Qt 6: Remove leftovers
QCOMPARE(server.nativeDescriptor(), -1);
#endif // (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
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);
#if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
QVERIFY(!server.setSocketDescriptor(-2));
QCOMPARE(server.socketDescriptor(), -1);
#else // ### Qt 6: Remove leftovers
QVERIFY(!server.setNativeDescriptor(-2));
QCOMPARE(server.nativeDescriptor(), -1);
#endif // (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
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
server.setHandshakeTimeout(64);
QCOMPARE(server.handshakeTimeoutMS(), 64);
#if QT_HAS_INCLUDE(<chrono>)
auto expected = std::chrono::milliseconds(64);
QCOMPARE(server.handshakeTimeout(), expected);
expected = std::chrono::milliseconds(242);
server.setHandshakeTimeout(expected);
QCOMPARE(server.handshakeTimeoutMS(), 242);
QCOMPARE(server.handshakeTimeout(), expected);
#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();
QTRY_COMPARE(serverClosedSpy.count(), 1);
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()
{
if (m_shouldSkipUnsupportedIpv6Test)
QSKIP("Syscalls needed for ipv6 sockoptions missing functionality");
QWebSocketServer server(QString(), QWebSocketServer::NonSecureMode);
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());
QTRY_COMPARE(socketConnectedSpy.count(), 1);
QCOMPARE(socket.state(), QAbstractSocket::ConnectedState);
QCOMPARE(serverConnectionSpy.count(), 1);
QCOMPARE(corsAuthenticationSpy.count(), 1);
QCOMPARE(serverClosedSpy.count(), 0);
server.close();
QTRY_COMPARE(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()
{
if (m_shouldSkipUnsupportedIpv6Test)
QSKIP("Syscalls needed for ipv6 sockoptions missing functionality");
#ifndef QT_NO_OPENSSL
QWebSocketServer server(QString(), QWebSocketServer::SecureMode);
bool cipherFound = false;
const QList<QSslCipher> supportedCiphers = QSslConfiguration::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();
if (QSslSocket::sslLibraryVersionNumber() >= 0x10101000L)
config.setProtocol(QSsl::TlsV1_2); // With TLS 1.3 there are some issues with PSK, force 1.2
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;
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();
if (QSslSocket::sslLibraryVersionNumber() >= 0x10101000L)
socketConfig.setProtocol(QSsl::TlsV1_2); // With TLS 1.3 there are some issues with PSK, force 1.2
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());
QTRY_COMPARE(socketConnectedSpy.count(), 1);
QCOMPARE(socket.state(), QAbstractSocket::ConnectedState);
QCOMPARE(serverConnectionSpy.count(), 1);
QCOMPARE(serverPskRequiredSpy.count(), 1);
QCOMPARE(socketPskRequiredSpy.count(), 1);
QCOMPARE(serverClosedSpy.count(), 0);
server.close();
QTRY_COMPARE(serverClosedSpy.count(), 1);
QCOMPARE(sslErrorsSpy.count(), 0);
QCOMPARE(serverErrorSpy.count(), 0);
#endif
}
void tst_QWebSocketServer::tst_maxPendingConnections()
{
if (m_shouldSkipUnsupportedIpv6Test)
QSKIP("Syscalls needed for ipv6 sockoptions missing functionality");
//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()));
QSignalSpy socket2ConnectedSpy(&socket2, SIGNAL(connected()));
QSignalSpy socket3ConnectedSpy(&socket3, SIGNAL(connected()));
QVERIFY(server.listen());
socket1.open(server.serverUrl().toString());
QTRY_COMPARE(socket1ConnectedSpy.count(), 1);
QCOMPARE(socket1.state(), QAbstractSocket::ConnectedState);
QCOMPARE(serverConnectionSpy.count(), 1);
QCOMPARE(corsAuthenticationSpy.count(), 1);
socket2.open(server.serverUrl().toString());
QTRY_COMPARE(socket2ConnectedSpy.count(), 1);
QCOMPARE(socket2.state(), QAbstractSocket::ConnectedState);
QCOMPARE(serverConnectionSpy.count(), 2);
QCOMPARE(corsAuthenticationSpy.count(), 2);
socket3.open(server.serverUrl().toString());
QVERIFY(!socket3ConnectedSpy.wait(250));
QCOMPARE(socket3ConnectedSpy.count(), 0);
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();
QTRY_COMPARE(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()
{
if (m_shouldSkipUnsupportedIpv6Test)
QSKIP("Syscalls needed for ipv6 sockoptions missing functionality");
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() +
QStringLiteral(":").append(QString::number(server->serverPort()))));
socket.open(server->serverUrl().toString());
QTRY_COMPARE(socketConnectedSpy.count(), 1);
QCOMPARE(socket.state(), QAbstractSocket::ConnectedState);
QCOMPARE(serverConnectionSpy.count(), 1);
QCOMPARE(corsAuthenticationSpy.count(), 1);
QCOMPARE(serverClosedSpy.count(), 0);
delete server;
QTRY_COMPARE(socketDisconnectedSpy.count(), 1);
}
#ifndef QT_NO_SSL
static void setupSecureServer(QWebSocketServer *secureServer)
{
QSslConfiguration sslConfiguration;
QFile certFile(QStringLiteral(":/localhost.cert"));
QFile keyFile(QStringLiteral(":/localhost.key"));
QVERIFY(certFile.open(QIODevice::ReadOnly));
QVERIFY(keyFile.open(QIODevice::ReadOnly));
QSslCertificate certificate(&certFile, QSsl::Pem);
QSslKey sslKey(&keyFile, QSsl::Rsa, QSsl::Pem);
certFile.close();
keyFile.close();
sslConfiguration.setPeerVerifyMode(QSslSocket::VerifyNone);
sslConfiguration.setLocalCertificate(certificate);
sslConfiguration.setPrivateKey(sslKey);
secureServer->setSslConfiguration(sslConfiguration);
}
#endif
void tst_QWebSocketServer::tst_scheme()
{
if (m_shouldSkipUnsupportedIpv6Test)
QSKIP("Syscalls needed for ipv6 sockoptions missing functionality");
QWebSocketServer plainServer(QString(), QWebSocketServer::NonSecureMode);
QSignalSpy plainServerConnectionSpy(&plainServer, SIGNAL(newConnection()));
QVERIFY(plainServer.listen());
QWebSocket plainSocket;
plainSocket.open(plainServer.serverUrl().toString());
QTRY_COMPARE(plainServerConnectionSpy.count(), 1);
QScopedPointer<QWebSocket> plainServerSocket(plainServer.nextPendingConnection());
QVERIFY(!plainServerSocket.isNull());
QCOMPARE(plainServerSocket->requestUrl().scheme(), QStringLiteral("ws"));
plainServer.close();
#ifndef QT_NO_SSL
QWebSocketServer secureServer(QString(), QWebSocketServer::SecureMode);
setupSecureServer(&secureServer);
if (QTest::currentTestFailed())
return;
QSignalSpy secureServerConnectionSpy(&secureServer, SIGNAL(newConnection()));
QVERIFY(secureServer.listen());
QSslCipher sessionCipher;
QWebSocket secureSocket;
connect(&secureSocket, &QWebSocket::sslErrors,
&secureSocket, [&] {
secureSocket.ignoreSslErrors();
sessionCipher = secureSocket.sslConfiguration().sessionCipher();
});
secureSocket.open(secureServer.serverUrl().toString());
QTRY_COMPARE(secureServerConnectionSpy.count(), 1);
QScopedPointer<QWebSocket> secureServerSocket(secureServer.nextPendingConnection());
QVERIFY(!secureServerSocket.isNull());
QCOMPARE(secureServerSocket->requestUrl().scheme(), QStringLiteral("wss"));
secureServer.close();
QVERIFY(!sessionCipher.isNull());
#endif
}
void tst_QWebSocketServer::tst_handleConnection()
{
QWebSocketServer wsServer(QString(), QWebSocketServer::NonSecureMode);
QSignalSpy wsServerConnectionSpy(&wsServer, &QWebSocketServer::newConnection);
QTcpServer tcpServer;
connect(&tcpServer, &QTcpServer::newConnection,
[&tcpServer, &wsServer]() {
wsServer.handleConnection(tcpServer.nextPendingConnection());
});
QVERIFY(tcpServer.listen());
QWebSocket webSocket;
QSignalSpy wsConnectedSpy(&webSocket, &QWebSocket::connected);
webSocket.open(QStringLiteral("ws://localhost:%1").arg(tcpServer.serverPort()));
QTRY_COMPARE(wsConnectedSpy.count(), 1);
QTRY_COMPARE(wsServerConnectionSpy.count(), 1);
QScopedPointer<QWebSocket> webServerSocket(wsServer.nextPendingConnection());
QVERIFY(!webServerSocket.isNull());
QSignalSpy wsMessageReceivedSpy(webServerSocket.data(), &QWebSocket::textMessageReceived);
webSocket.sendTextMessage("dummy");
QTRY_COMPARE(wsMessageReceivedSpy.count(), 1);
QList<QVariant> arguments = wsMessageReceivedSpy.takeFirst();
QCOMPARE(arguments.first().toString(), QString("dummy"));
QSignalSpy clientMessageReceivedSpy(&webSocket, &QWebSocket::textMessageReceived);
webServerSocket->sendTextMessage("hello");
QVERIFY(webServerSocket->bytesToWrite() > 5); // 5 + a few extra bytes for header
QTRY_COMPARE(webServerSocket->bytesToWrite(), 0);
QTRY_COMPARE(clientMessageReceivedSpy.count(), 1);
arguments = clientMessageReceivedSpy.takeFirst();
QCOMPARE(arguments.first().toString(), QString("hello"));
}
struct SocketSpy {
QTcpSocket *socket;
QSignalSpy *disconnectSpy;
~SocketSpy() {
delete socket;
delete disconnectSpy;
}
};
static void openManyConnections(QList<SocketSpy *> *sockets, quint16 port, int numConnections)
{
for (int i = 0; i < numConnections; i++) {
QTcpSocket *c = new QTcpSocket;
QSignalSpy *spy = new QSignalSpy(c, &QTcpSocket::disconnected);
c->connectToHost("127.0.0.1", port);
sockets->append(new SocketSpy{c, spy});
}
}
// Sum the counts together, for better output on failure (e.g. "FAIL: Actual: 49, Expected: 50")
static int sumSocketSpyCount(const QList<SocketSpy *> &sockets)
{
return std::accumulate(sockets.cbegin(), sockets.cend(), 0, [](int c, SocketSpy *s) {
return c + s->disconnectSpy->count();
});
}
void tst_QWebSocketServer::tst_handshakeTimeout()
{
{ // No Timeout
QWebSocketServer plainServer(QString(), QWebSocketServer::NonSecureMode);
plainServer.setHandshakeTimeout(-1);
QSignalSpy plainServerConnectionSpy(&plainServer, SIGNAL(newConnection()));
QVERIFY(plainServer.listen());
QWebSocket socket;
socket.open(plainServer.serverUrl().toString());
QTRY_COMPARE(plainServerConnectionSpy.count(), 1);
QScopedPointer<QWebSocket> plainServerSocket(plainServer.nextPendingConnection());
QVERIFY(!plainServerSocket.isNull());
plainServer.close();
}
{ // Unencrypted
QWebSocketServer plainServer(QString(), QWebSocketServer::NonSecureMode);
plainServer.setHandshakeTimeout(500);
QSignalSpy plainServerConnectionSpy(&plainServer, SIGNAL(newConnection()));
QVERIFY(plainServer.listen());
/* QTcpServer has a default of 30 pending connections. The test checks
* whether, when that list is full, the connections are dropped after
* a timeout and later pending connections are processed. */
const int numConnections = 50;
QList<SocketSpy *> sockets;
auto cleaner = qScopeGuard([&sockets]() { qDeleteAll(sockets); });
openManyConnections(&sockets, plainServer.serverPort(), numConnections);
QCoreApplication::processEvents();
/* We have 50 plain TCP connections open, that are not proper websockets. */
QCOMPARE(plainServerConnectionSpy.count(), 0);
QWebSocket socket;
socket.open(plainServer.serverUrl().toString());
/* Check that a real websocket will be processed after some non-websocket
* TCP connections timeout. */
QTRY_COMPARE(plainServerConnectionSpy.count(), 1);
QScopedPointer<QWebSocket> plainServerSocket(plainServer.nextPendingConnection());
QVERIFY(!plainServerSocket.isNull());
/* Check that all non websocket connections eventually timeout. */
QTRY_COMPARE(sumSocketSpyCount(sockets), numConnections);
plainServer.close();
}
#if QT_CONFIG(ssl)
{ // Encrypted
QWebSocketServer secureServer(QString(), QWebSocketServer::SecureMode);
setupSecureServer(&secureServer);
if (QTest::currentTestFailed())
return;
secureServer.setHandshakeTimeout(2000);
QSignalSpy secureServerConnectionSpy(&secureServer, SIGNAL(newConnection()));
QVERIFY(secureServer.listen());
const int numConnections = 50;
QList<SocketSpy *> sockets;
auto cleaner = qScopeGuard([&sockets]() { qDeleteAll(sockets); });
openManyConnections(&sockets, secureServer.serverPort(), numConnections);
QCoreApplication::processEvents();
QCOMPARE(secureServerConnectionSpy.count(), 0);
QWebSocket secureSocket;
connect(&secureSocket, QOverload<QAbstractSocket::SocketError>::of(&QWebSocket::error),
[](QAbstractSocket::SocketError error) {
// This shouldn't print but it's useful for debugging when/if it does.
qDebug() << "Error occurred in the client:" << error;
});
QSslConfiguration config = secureSocket.sslConfiguration();
config.setPeerVerifyMode(QSslSocket::VerifyNone);
secureSocket.setSslConfiguration(config);
secureSocket.open(secureServer.serverUrl().toString());
QTRY_COMPARE(secureServerConnectionSpy.count(), 1);
QScopedPointer<QWebSocket> serverSocket(secureServer.nextPendingConnection());
QVERIFY(!serverSocket.isNull());
QTRY_COMPARE(sumSocketSpyCount(sockets), numConnections);
secureServer.close();
}
#endif
{ // Ensure properly handshaked connections are not timed out
QWebSocketServer plainServer(QString(), QWebSocketServer::NonSecureMode);
plainServer.setHandshakeTimeout(250);
QSignalSpy plainServerConnectionSpy(&plainServer, SIGNAL(newConnection()));
QVERIFY(plainServer.listen());
QWebSocket socket;
QSignalSpy socketConnectedSpy(&socket, &QWebSocket::connected);
QSignalSpy socketDisconnectedSpy(&socket, &QWebSocket::disconnected);
socket.open(plainServer.serverUrl().toString());
QTRY_COMPARE(plainServerConnectionSpy.count(), 1);
QTRY_COMPARE(socketConnectedSpy.count(), 1);
QEventLoop loop;
QTimer::singleShot(500, &loop, &QEventLoop::quit);
loop.exec();
QCOMPARE(socketDisconnectedSpy.count(), 0);
}
}
void tst_QWebSocketServer::multipleFrames()
{
QWebSocketServer server(QString(), QWebSocketServer::NonSecureMode);
QSignalSpy serverConnectionSpy(&server, &QWebSocketServer::newConnection);
QVERIFY(server.listen());
QWebSocket socket;
QSignalSpy socketConnectedSpy(&socket, &QWebSocket::connected);
QSignalSpy messageReceivedSpy(&socket, &QWebSocket::binaryMessageReceived);
socket.open(server.serverUrl().toString());
QVERIFY(serverConnectionSpy.wait());
QVERIFY(socketConnectedSpy.wait());
auto serverSocket = std::unique_ptr<QWebSocket>(server.nextPendingConnection());
QVERIFY(serverSocket);
for (int i = 0; i < 10; i++)
serverSocket->sendBinaryMessage(QByteArray("abc"));
if (serverSocket->bytesToWrite())
QVERIFY(serverSocket->flush());
QVERIFY(messageReceivedSpy.wait());
// Since there's no guarantee the operating system will fit all 10 websocket frames into 1 tcp
// frame, let's just assume it will do at least 2. EXCEPT_FAIL any which doesn't merge any.
QVERIFY2(messageReceivedSpy.count() > 1, "Received only 1 message in the TCP frame!");
}
QTEST_MAIN(tst_QWebSocketServer)
#include "tst_qwebsocketserver.moc"
|