Update unittest_windows_gcc.yml

Since factory returns a ProxyConnectionState, setOnConnectionCallback
will be a ProxyConnectionState. The code already makes that assumption,
since it does not check of state return value. Using a
static_pointer_cast will allow the library to be build with rtti.

.github/workflows/unittest_windows.yml

@@ -1,27 +0,0 @@
-name: windows
-on:
-  push:
-    paths-ignore:
-    - 'docs/**'
-  pull_request:
-
-jobs:
-  windows:
-    runs-on: windows-latest
-    steps:
-    - uses: actions/checkout@v1
-    - uses: seanmiddleditch/gha-setup-vsdevenv@master
-    - uses: seanmiddleditch/gha-setup-ninja@master
-    - run: |
-        mkdir build
-        cd build
-        cmake -GNinja -DCMAKE_CXX_COMPILER=cl.exe -DCMAKE_C_COMPILER=cl.exe -DUSE_WS=1 -DUSE_TEST=1 -DUSE_ZLIB=OFF -DBUILD_SHARED_LIBS=OFF ..
-    - run: |
-        cd build
-        ninja
-    - run: |
-        cd build
-        ninja test
-
-#- run: ../build/test/ixwebsocket_unittest.exe
-# working-directory: test

.github/workflows/unittest_windows_gcc.yml

@@ -11,7 +11,7 @@ jobs:
     steps:
     - uses: actions/checkout@v1
     - uses: seanmiddleditch/gha-setup-ninja@master
-    - uses: egor-tensin/setup-mingw@v2
+    - uses: bsergean/setup-mingw@d79ce405bac9edef3a1726ef00554a56f0bafe66
     - run: |
         mkdir build
         cd build

CMakeLists.txt

@@ -6,7 +6,7 @@
 cmake_minimum_required(VERSION 3.4.1...3.17.2)
 set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/CMake;${CMAKE_MODULE_PATH}")
 
-project(ixwebsocket C CXX)
+project(ixwebsocket LANGUAGES C CXX VERSION 11.4.4)
 
 set (CMAKE_CXX_STANDARD 11)
 set (CXX_STANDARD_REQUIRED ON)
@@ -136,6 +136,7 @@ if (USE_TLS)
     else() # default to OpenSSL on all other platforms
       if (NOT USE_MBED_TLS) # Unless mbedtls is requested
         set(USE_OPEN_SSL ON)
+        set(requires "openssl")
       endif()
     endif()
 
@@ -165,9 +166,9 @@ if(BUILD_SHARED_LIBS)
         ${IXWEBSOCKET_SOURCES}
         ${IXWEBSOCKET_HEADERS}
     )
-    
+
     # Set library version
-    set_target_properties(ixwebsocket PROPERTIES VERSION 11.3.2)
+    set_target_properties(ixwebsocket PROPERTIES VERSION ${CMAKE_PROJECT_VERSION})
 
 else()
     # Static library
@@ -290,6 +291,10 @@ if (IXWEBSOCKET_INSTALL)
   configure_file("${CMAKE_CURRENT_LIST_DIR}/ixwebsocket-config.cmake.in" "${CMAKE_CURRENT_BINARY_DIR}/ixwebsocket-config.cmake" @ONLY)
   install(FILES "${CMAKE_CURRENT_BINARY_DIR}/ixwebsocket-config.cmake" DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/ixwebsocket")
   
+  set(prefix ${CMAKE_INSTALL_PREFIX})
+  configure_file("${CMAKE_CURRENT_LIST_DIR}/ixwebsocket.pc.in" "${CMAKE_CURRENT_BINARY_DIR}/ixwebsocket.pc" @ONLY)
+  install(FILES "${CMAKE_CURRENT_BINARY_DIR}/ixwebsocket.pc" DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig")
+
   install(EXPORT ixwebsocket
           FILE ixwebsocket-targets.cmake
           NAMESPACE ixwebsocket::

README.md

@@ -99,14 +99,15 @@ Starting with the 11.0.8 release, IXWebSocket should be fully C++11 compatible.
 If your company or project is using this library, feel free to open an issue or PR to amend this list.
 
 - [Machine Zone](https://www.mz.com)
-- [Tokio](https://gitlab.com/HCInk/tokio), a discord library focused on audio playback with node bindings.
+- [Tokio](https://github.com/liz3/tokio), a discord library focused on audio playback with node bindings.
 - [libDiscordBot](https://github.com/tostc/libDiscordBot/tree/master), an easy to use Discord-bot framework.
 - [gwebsocket](https://github.com/norrbotten/gwebsocket), a websocket (lua) module for Garry's Mod
-- [DisCPP](https://github.com/DisCPP/DisCPP), a simple but feature rich Discord API wrapper
+- [DisCPP](https://github.com/DisCPP/DisCPP), a simple but feature rich Discord API wrapper (archived as of Oct 8, 2021)
 - [discord.cpp](https://github.com/luccanunes/discord.cpp), a discord library for making bots
 - [Teleport](http://teleportconnect.com/), Teleport is your own personal remote robot avatar
 - [Abaddon](https://github.com/uowuo/abaddon), An alternative Discord client made with C++/gtkmm 
 - [NovaCoin](https://github.com/novacoin-project/novacoin), a hybrid scrypt PoW + PoS based cryptocurrency.
+- [Candy](https://github.com/lanthora/candy), A WebSocket and TUN based VPN for Linux 
 
 ## Alternative libraries
 
@@ -114,8 +115,8 @@ There are plenty of great websocket libraries out there, which might work for yo
 
 * [websocketpp](https://github.com/zaphoyd/websocketpp) - C++
 * [beast](https://github.com/boostorg/beast) - C++
+* [µWebSockets](https://github.com/uNetworking/uWebSockets) - C++
 * [libwebsockets](https://libwebsockets.org/) - C
-* [µWebSockets](https://github.com/uNetworking/uWebSockets) - C
 * [wslay](https://github.com/tatsuhiro-t/wslay) - C
 
 [uvweb](https://github.com/bsergean/uvweb) is a library written by the IXWebSocket author which is built on top of [uvw](https://github.com/skypjack/uvw), which is a C++ wrapper for [libuv](https://libuv.org/). It has more dependencies and does not support SSL at this point, but it can be used to open multiple connections within a single OS thread thanks to libuv.
@@ -133,9 +134,7 @@ To check the performance of a websocket library, you can look at the [autoroute]
 | Windows           | Disabled          | None              | [![Build2][5]][0] |
 | UWP               | Disabled          | None              | [![Build2][6]][0] |
 | Linux             | OpenSSL           | Address Sanitizer | [![Build2][7]][0] |
-| Mingw             | Disabled          | None              | [![Build2][8]][0] |
 
-* ASAN fails on Linux because of a known problem, we need a 
 * Some tests are disabled on Windows/UWP because of a pathing problem
 * TLS and ZLIB are disabled on Windows/UWP because enabling make the CI run takes a lot of time, for setting up vcpkg.
 
@@ -147,5 +146,4 @@ To check the performance of a websocket library, you can look at the [autoroute]
 [5]: https://github.com/machinezone/IXWebSocket/workflows/windows/badge.svg
 [6]: https://github.com/machinezone/IXWebSocket/workflows/uwp/badge.svg
 [7]: https://github.com/machinezone/IXWebSocket/workflows/linux_asan/badge.svg
-[8]: https://github.com/machinezone/IXWebSocket/workflows/unittest_windows_gcc/badge.svg
 

docs/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 All changes to this project will be documented in this file.
 
+## [11.4.4] - 2023-06-05
+
 ## [11.4.3] - 2022-05-13
 
 Set shorter thread names

ixwebsocket.pc.in

@@ -0,0 +1,11 @@
+prefix=@prefix@
+exec_prefix=${prefix}
+libdir=${exec_prefix}/lib
+includedir=${prefix}/include
+
+Name: ixwebsocket
+Description: websocket and http client and server library, with TLS support and very few dependencies
+Version: @CMAKE_PROJECT_VERSION@
+Libs: -L${libdir} -lixwebsocket
+Cflags: -I${includedir}
+Requires: @requires@

ixwebsocket/IXDNSLookup.cpp

@@ -27,9 +27,13 @@
 
 // mingw build quirks
 #if defined(_WIN32) && defined(__GNUC__)
+#ifndef AI_NUMERICSERV
 #define AI_NUMERICSERV NI_NUMERICSERV
+#endif
+#ifndef AI_ADDRCONFIG
 #define AI_ADDRCONFIG LUP_ADDRCONFIG
 #endif
+#endif
 
 namespace ix
 {

ixwebsocket/IXHttp.cpp

@@ -133,16 +133,20 @@ namespace ix
         if (headers.find("Content-Length") != headers.end())
         {
             int contentLength = 0;
-            try
             {
-                contentLength = std::stoi(headers["Content-Length"]);
+                const char* p = headers["Content-Length"].c_str();
+                char* p_end{};
+                errno = 0;
+                long val = std::strtol(p, &p_end, 10);
+                if (p_end == p            // invalid argument
+                    || errno == ERANGE    // out of range
+                    || val < std::numeric_limits<int>::min()
+                    || val > std::numeric_limits<int>::max()) {
+                    return std::make_tuple(
+                        false, "Error parsing HTTP Header 'Content-Length'", httpRequest);
+                }
+                contentLength = val;
             }
-            catch (const std::exception&)
-            {
-                return std::make_tuple(
-                    false, "Error parsing HTTP Header 'Content-Length'", httpRequest);
-            }
-
             if (contentLength < 0)
             {
                 return std::make_tuple(

ixwebsocket/IXHttpClient.cpp

@@ -209,6 +209,12 @@ namespace ix
             ss << "User-Agent: " << userAgent() << "\r\n";
         }
 
+        // Set an origin header if missing
+        if (args->extraHeaders.find("Origin") == args->extraHeaders.end())
+        {
+            ss << "Origin: " << protocol << "://" << host << ":" << port << "\r\n";
+        }
+
         if (verb == kPost || verb == kPut || verb == kPatch || _forceBody)
         {
             // Set request compression header

ixwebsocket/IXHttpServer.cpp

@@ -148,6 +148,7 @@ namespace ix
                     content = gzipCompress(content);
                     headers["Content-Encoding"] = "gzip";
                 }
+                headers["Accept-Encoding"] = "gzip";
 #endif
 
                 // Log request
@@ -161,11 +162,6 @@ namespace ix
                 // headers["Content-Type"] = "application/octet-stream";
                 headers["Accept-Ranges"] = "none";
 
-                for (auto&& it : request->headers)
-                {
-                    headers[it.first] = it.second;
-                }
-
                 return std::make_shared<HttpResponse>(
                     200, "OK", HttpErrorCode::Ok, headers, content);
             });

ixwebsocket/IXNetSystem.cpp

@@ -69,7 +69,7 @@ namespace ix
             {
                 // We must deselect the networkevents from the socket event. Otherwise the
                 // socket will report states that aren't there.
-                if (_fd != nullptr && _fd->fd != -1)
+                if (_fd != nullptr && (int)_fd->fd != -1)
                     WSAEventSelect(_fd->fd, _event, 0);
                 WSACloseEvent(_event);
             }
@@ -171,7 +171,7 @@ namespace ix
             int count = 0;
             // WSAWaitForMultipleEvents returns the index of the first signaled event. And to emulate WSAPoll()
             // all the signaled events must be processed.
-            while (socketIndex < socketEvents.size())
+            while (socketIndex < (int)socketEvents.size())
             {
                 struct pollfd* fd = socketEvents[socketIndex];
 
@@ -345,7 +345,7 @@ namespace ix
                     buf[best] = buf[best + 1] = ':';
                     memmove(buf + best + 2, buf + best + max, i - best - max + 1);
                 }
-                if (strlen(buf) < l)
+                if (strlen(buf) < (size_t)l)
                 {
                     strcpy(s, buf);
                     return s;

ixwebsocket/IXSocketMbedTLS.cpp

@@ -49,7 +49,7 @@ namespace ix
         mbedtls_pk_init(&_pkey);
     }
 
-    bool SocketMbedTLS::loadSystemCertificates(std::string& /* errorMsg */)
+    bool SocketMbedTLS::loadSystemCertificates(std::string& errorMsg)
     {
 #ifdef _WIN32
         DWORD flags = CERT_STORE_READONLY_FLAG | CERT_STORE_OPEN_EXISTING_FLAG |

ixwebsocket/IXSocketOpenSSL.cpp

@@ -26,6 +26,7 @@
 
 #ifdef _WIN32
 // For manipulating the certificate store
+#include <windows.h>
 #include <wincrypt.h>
 #endif
 
@@ -49,7 +50,7 @@ namespace
         X509_STORE* opensslStore = SSL_CTX_get_cert_store(ssl);
 
         int certificateCount = 0;
-        while (certificateIterator = CertEnumCertificatesInStore(systemStore, certificateIterator))
+        while ((certificateIterator = CertEnumCertificatesInStore(systemStore, certificateIterator)))
         {
             X509* x509 = d2i_X509(NULL,
                                   (const unsigned char**) &certificateIterator->pbCertEncoded,
@@ -293,10 +294,16 @@ namespace ix
      */
     bool SocketOpenSSL::checkHost(const std::string& host, const char* pattern)
     {
+#if OPENSSL_VERSION_NUMBER >= 0x10100000L
+        return true;
+#else
+
 #ifdef _WIN32
         return PathMatchSpecA(host.c_str(), pattern);
 #else
         return fnmatch(pattern, host.c_str(), 0) != FNM_NOMATCH;
+#endif
+
 #endif
     }
 

ixwebsocket/IXWebSocket.cpp

@@ -41,6 +41,7 @@ namespace ix
         , _enablePong(kDefaultEnablePong)
         , _pingIntervalSecs(kDefaultPingIntervalSecs)
         , _pingType(SendMessageKind::Ping)
+        , _autoThreadName(true)
     {
         _ws.setOnCloseCallback(
             [this](uint16_t code, const std::string& reason, size_t wireSize, bool remote)
@@ -370,7 +371,10 @@ namespace ix
 
     void WebSocket::run()
     {
-        setThreadName(getUrl());
+        if (_autoThreadName)
+        {
+            setThreadName(getUrl());
+        }
 
         bool firstConnectionAttempt = true;
 
@@ -627,4 +631,9 @@ namespace ix
         std::lock_guard<std::mutex> lock(_configMutex);
         return _subProtocols;
     }
+
+    void WebSocket::setAutoThreadName(bool enabled)
+    {
+        _autoThreadName = enabled;
+    }
 } // namespace ix

ixwebsocket/IXWebSocket.h

@@ -119,6 +119,8 @@ namespace ix
         uint32_t getMinWaitBetweenReconnectionRetries() const;
         const std::vector<std::string>& getSubProtocols();
 
+        void setAutoThreadName(bool enabled);
+
     private:
         WebSocketSendInfo sendMessage(const IXWebSocketSendData& message,
                                       SendMessageKind sendMessageKind,
@@ -182,6 +184,9 @@ namespace ix
         // Subprotocols
         std::vector<std::string> _subProtocols;
 
+        // enable or disable auto set thread name
+        bool _autoThreadName;
+
         friend class WebSocketServer;
     };
 } // namespace ix

ixwebsocket/IXWebSocketHandshake.cpp

@@ -87,6 +87,7 @@ namespace ix
     WebSocketInitResult WebSocketHandshake::clientHandshake(
         const std::string& url,
         const WebSocketHttpHeaders& extraHeaders,
+        const std::string& protocol,
         const std::string& host,
         const std::string& path,
         int port,
@@ -125,6 +126,12 @@ namespace ix
             ss << "User-Agent: " << userAgent() << "\r\n";
         }
 
+        // Set an origin header if missing
+        if (extraHeaders.find("Origin") == extraHeaders.end())
+        {
+            ss << "Origin: " << protocol << "://" << host << ":" << port << "\r\n";
+        }
+
         for (auto& it : extraHeaders)
         {
             ss << it.first << ": " << it.second << "\r\n";

ixwebsocket/IXWebSocketHandshake.h

@@ -31,6 +31,7 @@ namespace ix
 
         WebSocketInitResult clientHandshake(const std::string& url,
                                             const WebSocketHttpHeaders& extraHeaders,
+                                            const std::string& protocol,
                                             const std::string& host,
                                             const std::string& path,
                                             int port,

ixwebsocket/IXWebSocketProxyServer.cpp

@@ -57,7 +57,7 @@ namespace ix
         server.setOnConnectionCallback(
             [remoteUrl, remoteUrlsMapping](std::weak_ptr<ix::WebSocket> webSocket,
                                            std::shared_ptr<ConnectionState> connectionState) {
-                auto state = std::dynamic_pointer_cast<ProxyConnectionState>(connectionState);
+                auto state = std::static_pointer_cast<ProxyConnectionState>(connectionState);
                 auto remoteIp = connectionState->getRemoteIp();
 
                 // Server connection

ixwebsocket/IXWebSocketServer.cpp

@@ -91,6 +91,9 @@ namespace ix
         setThreadName("Srv:ws:" + connectionState->getId());
 
         auto webSocket = std::make_shared<WebSocket>();
+
+        webSocket->setAutoThreadName(false);
+
         if (_onConnectionCallback)
         {
             _onConnectionCallback(webSocket, connectionState);

ixwebsocket/IXWebSocketTransport.cpp

@@ -140,7 +140,7 @@ namespace ix
                                                   _enablePerMessageDeflate);
 
             result = webSocketHandshake.clientHandshake(
-                remoteUrl, headers, host, path, port, timeoutSecs);
+                remoteUrl, headers, protocol, host, path, port, timeoutSecs);
 
             if (result.http_status >= 300 && result.http_status < 400)
             {
@@ -1174,7 +1174,22 @@ namespace ix
     {
         _requestInitCancellation = true;
 
-        if (_readyState == ReadyState::CLOSING || _readyState == ReadyState::CLOSED) return;
+        if (_readyState == ReadyState::CLOSING || _readyState == ReadyState::CLOSED)
+        {
+            // Wake up the socket polling thread, as
+            // Socket::isReadyToRead() might be still waiting the
+            // interrupt event to happen.
+            bool wakeUpPoll = false;
+            {
+              std::lock_guard<std::mutex> lock(_socketMutex);
+              wakeUpPoll = (_socket && _socket->isWakeUpFromPollSupported());
+            }
+            if (wakeUpPoll)
+            {
+                wakeUpFromPoll(SelectInterrupt::kCloseRequest);
+            }
+            return;
+        }
 
         if (closeWireSize == 0)
         {

ixwebsocket/IXWebSocketVersion.h

@@ -6,4 +6,4 @@
 
 #pragma once
 
-#define IX_WEBSOCKET_VERSION "11.4.3"
+#define IX_WEBSOCKET_VERSION "11.4.4"

test/CMakeLists.txt

@@ -16,7 +16,7 @@ set (TEST_TARGET_NAMES
   IXWebSocketServerTest
   IXWebSocketTestConnectionDisconnection
   IXUrlParserTest
-  IXHttpClientTest
+  # IXHttpClientTest ## FIXME httpbin.org does not seem normal
   IXUnityBuildsTest
   IXHttpTest
   IXDNSLookupTest

test/IXHttpServerTest.cpp

@@ -60,6 +60,7 @@ TEST_CASE("http server", "[httpd]")
         REQUIRE(response->errorCode == HttpErrorCode::Ok);
         REQUIRE(response->statusCode == 200);
         REQUIRE(response->headers["Accept-Encoding"] == "gzip");
+        REQUIRE(response->headers["Content-Encoding"] == "gzip");
 
         server.stop();
     }