(Windows) move EINVAL (re)definition from IXSocket.h to IXNetSystem.h (fix #289)

.github/workflows/mkdocs.yml

@@ -21,5 +21,7 @@ jobs:
         pip install pygments
     - name: Build doc
       run: |
+        git clean -dfx .
+        git fetch
         git pull
         mkdocs gh-deploy

.github/workflows/unittest_windows_gcc.yml

@@ -20,7 +20,8 @@ jobs:
         ninja
     - run: |
         cd build
-        ninja test
+        ctest -V
+        # ninja test
 
 #- run: ../build/test/ixwebsocket_unittest.exe
 # working-directory: test

CMakeLists.txt

@@ -88,6 +88,7 @@ set( IXWEBSOCKET_HEADERS
     ixwebsocket/IXSocketTLSOptions.h
     ixwebsocket/IXStrCaseCompare.h
     ixwebsocket/IXUdpSocket.h
+    ixwebsocket/IXUniquePtr.h
     ixwebsocket/IXUrlParser.h
     ixwebsocket/IXUuid.h
     ixwebsocket/IXUtf8Validator.h

README.md

@@ -24,6 +24,7 @@ A bad security bug affecting users compiling with SSL enabled and OpenSSL as the
 
 #include <ixwebsocket/IXNetSystem.h>
 #include <ixwebsocket/IXWebSocket.h>
+#include <ixwebsocket/IXUserAgent.h>
 #include <iostream>
 
 int main()
@@ -34,6 +35,8 @@ int main()
     // Our websocket object
     ix::WebSocket webSocket;
 
+    // Connect to a server with encryption
+    // See https://machinezone.github.io/IXWebSocket/usage/#tls-support-and-configuration
     std::string url("wss://echo.websocket.org");
     webSocket.setUrl(url);
 
@@ -53,6 +56,12 @@ int main()
                 std::cout << "Connection established" << std::endl;
                 std::cout << "> " << std::flush;
             }
+            else if (msg->type == ix::WebSocketMessageType::Error)
+            {
+                // Maybe SSL is not configured properly
+                std::cout << "Connection error: " << msg->errorInfo.reason << std::endl;
+                std::cout << "> " << std::flush;
+            }
         }
     );
 

docs/CHANGELOG.md

@@ -2,6 +2,34 @@
 
 All changes to this project will be documented in this file.
 
+## [11.2.6] - 2021-05-18
+
+(Windows) move EINVAL (re)definition from IXSocket.h to IXNetSystem.h (fix #289)
+
+## [11.2.5] - 2021-04-04
+
+(http client) DEL is not an HTTP method name, but DELETE is
+
+## [11.2.4] - 2021-03-25
+
+(cmake) install IXUniquePtr.h
+
+## [11.2.3] - 2021-03-24
+
+(ssl + windows) missing include for CertOpenStore function
+
+## [11.2.2] - 2021-03-23
+
+(ixwebsocket) version bump
+
+## [11.2.1] - 2021-03-23
+
+(ixwebsocket) version bump
+
+## [11.2.0] - 2021-03-23
+
+(ixwebsocket) correct mingw support (gcc on windows)
+
 ## [11.1.4] - 2021-03-23
 
 (ixwebsocket) add getMinWaitBetweenReconnectionRetries

docs/usage.md

@@ -374,13 +374,10 @@ The webSocket reference is guaranteed to be always valid ; by design the callbac
 // Bound host name, max connections and listen backlog can also be passed in as parameters.
 ix::WebSocketServer server(port);
 
-server.setOnClientMessageCallback(std::shared_ptr<ConnectionState> connectionState,
+server.setOnClientMessageCallback([](std::shared_ptr<ix::ConnectionState> connectionState, ix::WebSocket & webSocket, const ix::WebSocketMessagePtr & msg) {
-                                  WebSocket& webSocket,
-                                  const WebSocketMessagePtr& msg)
-{
     // The ConnectionState object contains information about the connection,
     // at this point only the client ip address and the port.
-    std::cout << "Remote ip: " << connectionState->getRemoteIp();
+    std::cout << "Remote ip: " << connectionState->getRemoteIp() << std::endl;
 
     if (msg->type == ix::WebSocketMessageType::Open)
     {
@@ -398,7 +395,7 @@ server.setOnClientMessageCallback(std::shared_ptr<ConnectionState> connectionSta
         std::cout << "Headers:" << std::endl;
         for (auto it : msg->openInfo.headers)
         {
-            std::cout << it.first << ": " << it.second << std::endl;
+            std::cout << "\t" << it.first << ": " << it.second << std::endl;
         }
     }
     else if (msg->type == ix::WebSocketMessageType::Message)
@@ -407,9 +404,11 @@ server.setOnClientMessageCallback(std::shared_ptr<ConnectionState> connectionSta
         // All connected clients are available in an std::set. See the broadcast cpp example.
         // Second parameter tells whether we are sending the message in binary or text mode.
         // Here we send it in the same mode as it was received.
+        std::cout << "Received: " << msg->str << std::endl;
+
         webSocket.send(msg->str, msg->binary);
     }
-);
+});
 
 auto res = server.listen();
 if (!res.first)

ixwebsocket/IXHttp.cpp

@@ -137,7 +137,7 @@ namespace ix
             {
                 contentLength = std::stoi(headers["Content-Length"]);
             }
-            catch (std::exception)
+            catch(const std::exception&)
             {
                 return std::make_tuple(
                     false, "Error parsing HTTP Header 'Content-Length'", httpRequest);

ixwebsocket/IXHttpClient.cpp

@@ -20,10 +20,11 @@
 
 namespace ix
 {
+    // https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods
     const std::string HttpClient::kPost = "POST";
     const std::string HttpClient::kGet = "GET";
     const std::string HttpClient::kHead = "HEAD";
-    const std::string HttpClient::kDel = "DEL";
+    const std::string HttpClient::kDelete = "DELETE";
     const std::string HttpClient::kPut = "PUT";
     const std::string HttpClient::kPatch = "PATCH";
 
@@ -557,9 +558,9 @@ namespace ix
         return request(url, kHead, std::string(), args);
     }
 
-    HttpResponsePtr HttpClient::del(const std::string& url, HttpRequestArgsPtr args)
+    HttpResponsePtr HttpClient::Delete(const std::string& url, HttpRequestArgsPtr args)
     {
-        return request(url, kDel, std::string(), args);
+        return request(url, kDelete, std::string(), args);
     }
 
     HttpResponsePtr HttpClient::request(const std::string& url,

ixwebsocket/IXHttpClient.h

@@ -30,7 +30,7 @@ namespace ix
 
         HttpResponsePtr get(const std::string& url, HttpRequestArgsPtr args);
         HttpResponsePtr head(const std::string& url, HttpRequestArgsPtr args);
-        HttpResponsePtr del(const std::string& url, HttpRequestArgsPtr args);
+        HttpResponsePtr Delete(const std::string& url, HttpRequestArgsPtr args);
 
         HttpResponsePtr post(const std::string& url,
                              const HttpParameters& httpParameters,
@@ -94,7 +94,7 @@ namespace ix
         const static std::string kPost;
         const static std::string kGet;
         const static std::string kHead;
-        const static std::string kDel;
+        const static std::string kDelete;
         const static std::string kPut;
         const static std::string kPatch;
 

ixwebsocket/IXNetSystem.cpp

@@ -124,14 +124,12 @@ namespace ix
 #endif
     }
 
-} // namespace ix
-
     //
-// mingw does not have inet_ntop and inet_pton, which were taken as is from the musl C library.
+    // mingw does not have inet_ntop, which were taken as is from the musl C library.
     //
-#if defined(_WIN32) && defined(__GNUC__)
     const char* inet_ntop(int af, const void* a0, char* s, socklen_t l)
     {
+#if defined(_WIN32) && defined(__GNUC__)
         const unsigned char* a = (const unsigned char*) a0;
         int i, j, max, best;
         char buf[100];
@@ -190,8 +188,12 @@ const char* inet_ntop(int af, const void* a0, char* s, socklen_t l)
         }
         errno = ENOSPC;
         return 0;
+#else
+        return ::inet_ntop(af, a0, s, l);
+#endif
     }
     
+#if defined(_WIN32) && defined(__GNUC__)
     static int hexval(unsigned c)
     {
         if (c - '0' < 10) return c - '0';
@@ -199,9 +201,14 @@ static int hexval(unsigned c)
         if (c - 'a' < 6) return c - 'a' + 10;
         return -1;
     }
+#endif
 
+    //
+    // mingw does not have inet_pton, which were taken as is from the musl C library.
+    //
     int inet_pton(int af, const char* s, void* a0)
     {
+#if defined(_WIN32) && defined(__GNUC__)
         uint16_t ip[8];
         unsigned char* a = (unsigned char*) a0;
         int i, j, v, d, brk = -1, need_v4 = 0;
@@ -266,5 +273,9 @@ int inet_pton(int af, const char* s, void* a0)
         }
         if (need_v4 && inet_pton(AF_INET, (const char*) s, a - 4) <= 0) return 0;
         return 1;
+#else
+        return ::inet_pton(af, s, a0);
+#endif
     }
-#endif // defined(_WIN32) && defined(__GNUC__)
+
+} // namespace ix

ixwebsocket/IXNetSystem.h

@@ -18,6 +18,19 @@
 #include <io.h>
 #include <ws2def.h>
 
+#undef EWOULDBLOCK
+#undef EAGAIN
+#undef EINPROGRESS
+#undef EBADF
+#undef EINVAL
+
+// map to WSA error codes
+#define EWOULDBLOCK WSAEWOULDBLOCK
+#define EAGAIN WSATRY_AGAIN
+#define EINPROGRESS WSAEINPROGRESS
+#define EBADF WSAEBADF
+#define EINVAL WSAEINVAL
+
 // Define our own poll on Windows, as a wrapper on top of select
 typedef unsigned long int nfds_t;
 
@@ -53,12 +66,6 @@ struct pollfd
 #include <unistd.h>
 #endif
 
-// mingw does not have those
-#if defined(_WIN32) && defined(__GNUC__)
-const char* inet_ntop(int af, const void* src, char* dst, socklen_t size);
-int inet_pton(int af, const char* src, void* dst);
-#endif
-
 namespace ix
 {
 #ifdef _WIN32
@@ -71,4 +78,7 @@ namespace ix
     bool uninitNetSystem();
 
     int poll(struct pollfd* fds, nfds_t nfds, int timeout);
+
+    const char* inet_ntop(int af, const void* src, char* dst, socklen_t size);
+    int inet_pton(int af, const char* src, void* dst);
 } // namespace ix

ixwebsocket/IXSocket.h

@@ -15,20 +15,6 @@
 #ifdef _WIN32
 #include <BaseTsd.h>
 typedef SSIZE_T ssize_t;
-
-#undef EWOULDBLOCK
-#undef EAGAIN
-#undef EINPROGRESS
-#undef EBADF
-#undef EINVAL
-
-// map to WSA error codes
-#define EWOULDBLOCK WSAEWOULDBLOCK
-#define EAGAIN WSATRY_AGAIN
-#define EINPROGRESS WSAEINPROGRESS
-#define EBADF WSAEBADF
-#define EINVAL WSAEINVAL
-
 #endif
 
 #include "IXCancellationRequest.h"

ixwebsocket/IXSocketMbedTLS.cpp

@@ -16,6 +16,11 @@
 #include "IXSocketConnect.h"
 #include <string.h>
 
+#ifdef _WIN32
+// For manipulating the certificate store
+#include <wincrypt.h>
+#endif
+
 namespace ix
 {
     SocketMbedTLS::SocketMbedTLS(const SocketTLSOptions& tlsOptions, int fd)

ixwebsocket/IXSocketOpenSSL.cpp

@@ -24,6 +24,11 @@
 #endif
 #define socketerrno errno
 
+#ifdef _WIN32
+// For manipulating the certificate store
+#include <wincrypt.h>
+#endif
+
 #ifdef _WIN32
 namespace
 {

ixwebsocket/IXSocketServer.cpp

@@ -104,7 +104,7 @@ namespace ix
             server.sin_family = _addressFamily;
             server.sin_port = htons(_port);
 
-            if (inet_pton(_addressFamily, _host.c_str(), &server.sin_addr.s_addr) <= 0)
+            if (ix::inet_pton(_addressFamily, _host.c_str(), &server.sin_addr.s_addr) <= 0)
             {
                 std::stringstream ss;
                 ss << "SocketServer::listen() error calling inet_pton "
@@ -133,7 +133,7 @@ namespace ix
             server.sin6_family = _addressFamily;
             server.sin6_port = htons(_port);
 
-            if (inet_pton(_addressFamily, _host.c_str(), &server.sin6_addr) <= 0)
+            if (ix::inet_pton(_addressFamily, _host.c_str(), &server.sin6_addr) <= 0)
             {
                 std::stringstream ss;
                 ss << "SocketServer::listen() error calling inet_pton "
@@ -338,7 +338,7 @@ namespace ix
             if (_addressFamily == AF_INET)
             {
                 char remoteIp4[INET_ADDRSTRLEN];
-                if (inet_ntop(AF_INET, &client.sin_addr, remoteIp4, INET_ADDRSTRLEN) == nullptr)
+                if (ix::inet_ntop(AF_INET, &client.sin_addr, remoteIp4, INET_ADDRSTRLEN) == nullptr)
                 {
                     int err = Socket::getErrno();
                     std::stringstream ss;
@@ -357,7 +357,8 @@ namespace ix
             else // AF_INET6
             {
                 char remoteIp6[INET6_ADDRSTRLEN];
-                if (inet_ntop(AF_INET6, &client.sin_addr, remoteIp6, INET6_ADDRSTRLEN) == nullptr)
+                if (ix::inet_ntop(AF_INET6, &client.sin_addr, remoteIp6, INET6_ADDRSTRLEN) ==
+                    nullptr)
                 {
                     int err = Socket::getErrno();
                     std::stringstream ss;

ixwebsocket/IXStrCaseCompare.cpp

@@ -14,7 +14,7 @@ namespace ix
     bool CaseInsensitiveLess::NocaseCompare::operator()(const unsigned char& c1,
                                                         const unsigned char& c2) const
     {
-#ifdef _WIN32
+#if defined(_WIN32) && !defined(__GNUC__)
         return std::tolower(c1, std::locale()) < std::tolower(c2, std::locale());
 #else
         return std::tolower(c1) < std::tolower(c2);

ixwebsocket/IXWebSocketServer.cpp

@@ -191,7 +191,6 @@ namespace ix
                         // Make sure the OS send buffer is flushed before moving on
                         do
                         {
-                            size_t bufferedAmount = client->bufferedAmount();
                             std::chrono::duration<double, std::milli> duration(500);
                             std::this_thread::sleep_for(duration);
                         } while (client->bufferedAmount() != 0);

ixwebsocket/IXWebSocketVersion.h

@@ -6,4 +6,4 @@
 
 #pragma once
 
-#define IX_WEBSOCKET_VERSION "11.1.4"
+#define IX_WEBSOCKET_VERSION "11.2.6"

main.cpp

@@ -15,6 +15,7 @@
 
 #include <ixwebsocket/IXNetSystem.h>
 #include <ixwebsocket/IXWebSocket.h>
+#include <ixwebsocket/IXUserAgent.h>
 #include <iostream>
 
 int main()
@@ -25,9 +26,12 @@ int main()
     // Our websocket object
     ix::WebSocket webSocket;
 
+    // Connect to a server with encryption
+    // See https://machinezone.github.io/IXWebSocket/usage/#tls-support-and-configuration
     std::string url("wss://echo.websocket.org");
     webSocket.setUrl(url);
 
+    std::cout << ix::userAgent() << std::endl;
     std::cout << "Connecting to " << url << "..." << std::endl;
 
     // Setup a callback to be fired (in a background thread, watch out for race conditions !)
@@ -44,6 +48,12 @@ int main()
                 std::cout << "Connection established" << std::endl;
                 std::cout << "> " << std::flush;
             }
+            else if (msg->type == ix::WebSocketMessageType::Error)
+            {
+                // Maybe SSL is not configured properly
+                std::cout << "Connection error: " << msg->errorInfo.reason << std::endl;
+                std::cout << "> " << std::flush;
+            }
         }
     );
 

makefile.dev

@@ -113,7 +113,7 @@ test_server:
 test:
 	mkdir -p build && (cd build ; cmake -GNinja -DCMAKE_UNITY_BUILD=ON -DCMAKE_BUILD_TYPE=Debug -DUSE_TLS=1 -DUSE_TEST=1 ..)
 	(cd build ; ninja)
-	(cd build ; ninja test)
+	(cd build ; ninja -v test)
 
 test_asan:
 	mkdir -p build && (cd build ; cmake -GNinja -DCMAKE_UNITY_BUILD=ON -DCMAKE_BUILD_TYPE=Debug -DUSE_TLS=1 -DUSE_TEST=1 .. -DCMAKE_C_FLAGS="-fsanitize=address -fno-omit-frame-pointer" -DCMAKE_CXX_FLAGS="-fsanitize=address -fno-omit-frame-pointer")

ws/ws.cpp

@@ -906,7 +906,7 @@ namespace ix
         // code which display correct results
 
         char str[INET_ADDRSTRLEN];
-        inet_ntop(AF_INET, &addr, str, INET_ADDRSTRLEN);
+        ix::inet_ntop(AF_INET, &addr, str, INET_ADDRSTRLEN);
 
         spdlog::info("host: {} ip: {}", hostname, str);