Validate that the close reason is proper utf-8. Autobahn 7.5.1

+ws autobahn / Add code to test websocket client compliance with the autobahn test-suite
+Ping received with a payload too large (> 125 bytes) trigger a connection closure
+cobra / add tracking about published messages
+cobra / publish returns a message id, that can be used when
+cobra / new message type in the message received handler when publish/ok is received (can be used to implement an ack system).

.clang-format

@@ -11,7 +11,7 @@ AlignTrailingComments: true
 AllowAllParametersOfDeclarationOnNextLine: true
 AllowShortBlocksOnASingleLine: false
 AllowShortCaseLabelsOnASingleLine: true
-AllowShortFunctionsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: InlineOnly
 AllowShortIfStatementsOnASingleLine: true
 AllowShortLoopsOnASingleLine: false
 AlwaysBreakTemplateDeclarations: true
@@ -42,6 +42,5 @@ NamespaceIndentation: All
 PenaltyReturnTypeOnItsOwnLine: 1000
 PointerAlignment: Left
 SpaceAfterTemplateKeyword: false
-SpaceAfterCStyleCast: true
 Standard: Cpp11
 UseTab: Never

.github/workflows/ccpp.yml

@@ -1,66 +0,0 @@
-name: unittest
-on:
-  push:
-    paths-ignore:
-    - 'docs/**'
-
-jobs:
-  linux:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - name: make test
-      run: make test
-
-  mac_tsan_sectransport:
-    runs-on: macOS-latest
-    steps:
-    - uses: actions/checkout@v1
-    - name: make test_tsan
-      run: make test_tsan
-
-  mac_tsan_mbedtls:
-    runs-on: macOS-latest
-    steps:
-    - uses: actions/checkout@v1
-    - name: install mbedtls
-      run: brew install mbedtls
-    - name: make test
-      run: make test_tsan_mbedtls
-
-  windows_openssl:
-    runs-on: windows-latest
-    steps:
-    - uses: actions/checkout@v1
-    - uses: seanmiddleditch/gha-setup-vsdevenv@master
-    - run: |
-        mkdir build
-        cd build
-        cmake -DCMAKE_CXX_COMPILER=cl.exe -DUSE_WS=1 -DUSE_TEST=1 ..
-    - run: cmake --build build
-
-    # Running the unittest does not work, the binary cannot be found
-    #- run: ../build/test/ixwebsocket_unittest.exe
-    # working-directory: test
-
-#
-#   Windows with OpenSSL is working but disabled as it takes 13 minutes (10 for openssl) to build with vcpkg
-#
-#   windows_openssl:
-#     runs-on: windows-latest
-#     steps:
-#     - uses: actions/checkout@v1
-#     - uses: seanmiddleditch/gha-setup-vsdevenv@master
-#     - run: |
-#         vcpkg install zlib:x64-windows
-#         vcpkg install openssl:x64-windows
-#     - run: |
-#         mkdir build
-#         cd build
-#         cmake -DCMAKE_TOOLCHAIN_FILE=c:/vcpkg/scripts/buildsystems/vcpkg.cmake -DCMAKE_CXX_COMPILER=cl.exe -DUSE_OPEN_SSL=1 -DUSE_TLS=1 -DUSE_WS=1 -DUSE_TEST=1 ..
-#     - run: cmake --build build
-# 
-#     # Running the unittest does not work, the binary cannot be found
-#     #- run: ../build/test/ixwebsocket_unittest.exe
-#     # working-directory: test
-

.github/workflows/mkdocs.yml

@@ -1,25 +0,0 @@
-name: mkdocs
-on:
-  push:
-    paths:
-    - 'docs/**'
-
-jobs:
-  linux:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v1
-      with:
-        python-version: 3.8
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install mkdocs
-        pip install mkdocs-material
-        pip install pygments
-    - name: Build doc
-      run: |
-        git pull
-        mkdocs gh-deploy

.github/workflows/stale.yml

@@ -1,19 +0,0 @@
-name: Mark stale issues and pull requests
-
-on:
-  schedule:
-  - cron: "0 0 * * *"
-
-jobs:
-  stale:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/stale@v1
-      with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }}
-        stale-issue-message: 'Stale issue message'
-        stale-pr-message: 'Stale pull request message'
-        stale-issue-label: 'no-issue-activity'
-        stale-pr-label: 'no-pr-activity'

.gitignore

@@ -1,7 +1,3 @@
 build
 *.pyc
 venv
-ixsnake/ixsnake/.certs/
-site/
-ws/.certs/
-ws/.srl

.pre-commit-config.yaml

@@ -1,12 +1,12 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.5.0
+    rev: v2.3.0
     hooks:
     -   id: check-yaml
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
+
 -   repo: https://github.com/pocc/pre-commit-hooks
-    rev: v1.1.1
+    rev: ''
     hooks:
-    -    id: clang-format
-         args: [-i, -style=file]
+    -   id: clang-format

.travis.yml

@@ -0,0 +1,56 @@
+language: bash
+
+# See https://github.com/amaiorano/vectrexy/blob/master/.travis.yml
+# for ideas on installing vcpkg
+
+matrix:
+  include:
+    # macOS
+    - os: osx
+      env:
+        - HOMEBREW_NO_AUTO_UPDATE=1
+      compiler: clang
+      script:
+        - brew install mbedtls
+        - python test/run.py
+        - make ws
+
+    # Linux
+    - os: linux
+      dist: bionic
+      before_install:
+        - sudo apt-get install -y libmbedtls-dev
+      script: 
+        - python test/run.py
+        - make ws
+      env:
+        - CC=gcc
+        - CXX=g++
+
+    # Clang + Linux disabled for now
+    # - os: linux
+    #   dist: xenial
+    #   script: python test/run.py
+    #   env:
+    #     - CC=clang 
+    #     - CXX=clang++
+
+    # Windows
+    # - os: windows
+    #   env:
+    #     - CMAKE_PATH="/c/Program Files/CMake/bin"
+    #   script: 
+    #     - cd third_party/zlib
+    #     - cmake .
+    #     - cmake --build . --target install
+    #     - cd ../..
+    #     # - cd third_party/mbedtls
+    #     # - cmake .
+    #     # - cmake --build . --target install
+    #     # - cd ../..
+    #     - export PATH=$CMAKE_PATH:$PATH
+    #     - cd test
+    #     - cmake .
+    #     - cmake --build --parallel .
+    #     - ixwebsocket_unittest.exe
+    #     # - python test/run.py

CMake/FindJsonCpp.cmake

@@ -1,19 +0,0 @@
-# Find package structure taken from libcurl
-
-include(FindPackageHandleStandardArgs)
-
-find_path(JSONCPP_INCLUDE_DIRS json/json.h)
-find_library(JSONCPP_LIBRARY jsoncpp)
-
-find_package_handle_standard_args(JsonCpp
-    FOUND_VAR
-      JSONCPP_FOUND
-    REQUIRED_VARS
-      JSONCPP_LIBRARY
-      JSONCPP_INCLUDE_DIRS
-    FAIL_MESSAGE
-      "Could NOT find jsoncpp"
-)
-
-set(JSONCPP_INCLUDE_DIRS ${JSONCPP_INCLUDE_DIRS})
-set(JSONCPP_LIBRARIES ${JSONCPP_LIBRARY})

CMake/FindSpdLog.cmake

@@ -1,19 +0,0 @@
-# Find package structure taken from libcurl
-
-include(FindPackageHandleStandardArgs)
-
-find_path(SPDLOG_INCLUDE_DIRS spdlog/spdlog.h)
-find_library(JSONCPP_LIBRARY spdlog)
-
-find_package_handle_standard_args(SPDLOG
-    FOUND_VAR
-    SPDLOG_FOUND
-    REQUIRED_VARS
-      SPDLOG_LIBRARY
-      SPDLOG_INCLUDE_DIRS
-    FAIL_MESSAGE
-      "Could NOT find spdlog"
-)
-
-set(SPDLOG_INCLUDE_DIRS ${SPDLOG_INCLUDE_DIRS})
-set(SPDLOG_LIBRARIES ${SPDLOG_LIBRARY})

CMakeLists.txt

@@ -12,7 +12,8 @@ set (CMAKE_CXX_STANDARD 14)
 set (CXX_STANDARD_REQUIRED ON)
 set (CMAKE_CXX_EXTENSIONS OFF)
 
-if (UNIX)
+# -Wshorten-64-to-32 does not work with clang
+if (NOT WIN32)
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic")
 endif()
 
@@ -21,7 +22,6 @@ if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang")
 endif()
 
 set( IXWEBSOCKET_SOURCES
-    ixwebsocket/IXBench.cpp
     ixwebsocket/IXCancellationRequest.cpp
     ixwebsocket/IXConnectionState.cpp
     ixwebsocket/IXDNSLookup.cpp
@@ -36,23 +36,22 @@ set( IXWEBSOCKET_SOURCES
     ixwebsocket/IXSocketConnect.cpp
     ixwebsocket/IXSocketFactory.cpp
     ixwebsocket/IXSocketServer.cpp
-    ixwebsocket/IXSocketTLSOptions.cpp
-    ixwebsocket/IXUdpSocket.cpp
     ixwebsocket/IXUrlParser.cpp
     ixwebsocket/IXUserAgent.cpp
     ixwebsocket/IXWebSocket.cpp
     ixwebsocket/IXWebSocketCloseConstants.cpp
     ixwebsocket/IXWebSocketHandshake.cpp
     ixwebsocket/IXWebSocketHttpHeaders.cpp
+    ixwebsocket/IXWebSocketMessageQueue.cpp
     ixwebsocket/IXWebSocketPerMessageDeflate.cpp
     ixwebsocket/IXWebSocketPerMessageDeflateCodec.cpp
     ixwebsocket/IXWebSocketPerMessageDeflateOptions.cpp
     ixwebsocket/IXWebSocketServer.cpp
     ixwebsocket/IXWebSocketTransport.cpp
+    ixwebsocket/LUrlParser.cpp
 )
 
 set( IXWEBSOCKET_HEADERS
-    ixwebsocket/IXBench.h
     ixwebsocket/IXCancellationRequest.h
     ixwebsocket/IXConnectionState.h
     ixwebsocket/IXDNSLookup.h
@@ -69,8 +68,6 @@ set( IXWEBSOCKET_HEADERS
     ixwebsocket/IXSocketConnect.h
     ixwebsocket/IXSocketFactory.h
     ixwebsocket/IXSocketServer.h
-    ixwebsocket/IXSocketTLSOptions.h
-    ixwebsocket/IXUdpSocket.h
     ixwebsocket/IXUrlParser.h
     ixwebsocket/IXUtf8Validator.h
     ixwebsocket/IXUserAgent.h
@@ -79,10 +76,9 @@ set( IXWEBSOCKET_HEADERS
     ixwebsocket/IXWebSocketCloseInfo.h
     ixwebsocket/IXWebSocketErrorInfo.h
     ixwebsocket/IXWebSocketHandshake.h
-    ixwebsocket/IXWebSocketHandshakeKeyGen.h
     ixwebsocket/IXWebSocketHttpHeaders.h
-    ixwebsocket/IXWebSocketInitResult.h
     ixwebsocket/IXWebSocketMessage.h
+    ixwebsocket/IXWebSocketMessageQueue.h
     ixwebsocket/IXWebSocketMessageType.h
     ixwebsocket/IXWebSocketOpenInfo.h
     ixwebsocket/IXWebSocketPerMessageDeflate.h
@@ -92,6 +88,8 @@ set( IXWEBSOCKET_HEADERS
     ixwebsocket/IXWebSocketServer.h
     ixwebsocket/IXWebSocketTransport.h
     ixwebsocket/IXWebSocketVersion.h
+    ixwebsocket/LUrlParser.h
+    ixwebsocket/libwshandshake.hpp
 )
 
 if (UNIX)
@@ -105,37 +103,35 @@ if (APPLE)
     list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/apple/IXSetThreadName_apple.cpp)
 elseif (WIN32)
     list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/windows/IXSetThreadName_windows.cpp)
-elseif (${CMAKE_SYSTEM_NAME} MATCHES "FreeBSD")
-    list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/freebsd/IXSetThreadName_freebsd.cpp)
 else()
     list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/linux/IXSetThreadName_linux.cpp)
+    list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSelectInterruptEventFd.cpp)
+    list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSelectInterruptEventFd.h)
 endif()
 
-option(USE_TLS "Enable TLS support" FALSE)
+if (WIN32)
+  set(USE_MBED_TLS TRUE)
+endif()
 
+set(USE_OPEN_SSL FALSE)
 if (USE_TLS)
-    # default to securetranport on Apple if nothing is configured
-    if (APPLE)
-      if (NOT USE_MBED_TLS AND NOT USE_OPEN_SSL) # unless we want something else
-        set(USE_SECURE_TRANSPORT ON)
-      endif()
-    else() # default to OpenSSL on all other platforms
-      if (NOT USE_MBED_TLS) # Unless mbedtls is requested
-        set(USE_OPEN_SSL ON)
-      endif()
-    endif()
+    add_definitions(-DIXWEBSOCKET_USE_TLS)
 
     if (USE_MBED_TLS)
+        add_definitions(-DIXWEBSOCKET_USE_MBED_TLS)
         list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketMbedTLS.h)
         list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketMbedTLS.cpp)
-    elseif (USE_SECURE_TRANSPORT)
+    elseif (APPLE)
         list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketAppleSSL.h)
         list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketAppleSSL.cpp)
-    elseif (USE_OPEN_SSL)
+    elseif (WIN32)
+        list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketSChannel.h)
+        list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketSChannel.cpp)
+    else()
+        add_definitions(-DIXWEBSOCKET_USE_OPEN_SSL)
+        set(USE_OPEN_SSL TRUE)
         list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketOpenSSL.h)
         list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketOpenSSL.cpp)
-    else()
-        message(FATAL_ERROR "TLS Configuration error: unknown backend")
     endif()
 endif()
 
@@ -144,70 +140,13 @@ add_library( ixwebsocket STATIC
     ${IXWEBSOCKET_HEADERS}
 )
 
-if (USE_TLS)
-    target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_TLS)
-    if (USE_MBED_TLS)
-        target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_MBED_TLS)
-    elseif (USE_OPEN_SSL)
-        target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_OPEN_SSL)
-    elseif (USE_SECURE_TRANSPORT)
-        target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_SECURE_TRANSPORT)
-    else()
-        message(FATAL_ERROR "TLS Configuration error: unknown backend")
-    endif()
-endif()
-
-if (USE_TLS)
-  if (USE_OPEN_SSL)
-    message(STATUS "TLS configured to use openssl")
-
-    # Help finding Homebrew's OpenSSL on macOS
-    if (APPLE)
-      set(CMAKE_LIBRARY_PATH ${CMAKE_LIBRARY_PATH} /usr/local/opt/openssl/lib)
-      set(CMAKE_INCLUDE_PATH ${CMAKE_INCLUDE_PATH} /usr/local/opt/openssl/include)
-    endif()
-
-    # This OPENSSL_FOUND check is to help find a cmake manually configured OpenSSL
-    if (NOT OPENSSL_FOUND)
-      find_package(OpenSSL REQUIRED)
-    endif()
-    message(STATUS "OpenSSL: " ${OPENSSL_VERSION})
-
-    add_definitions(${OPENSSL_DEFINITIONS})
-    target_include_directories(ixwebsocket PUBLIC ${OPENSSL_INCLUDE_DIR})
-    target_link_libraries(ixwebsocket ${OPENSSL_LIBRARIES})
-  elseif (USE_MBED_TLS)
-    message(STATUS "TLS configured to use mbedtls")
-
-    find_package(MbedTLS REQUIRED)
-    target_include_directories(ixwebsocket PUBLIC ${MBEDTLS_INCLUDE_DIRS})
-    target_link_libraries(ixwebsocket ${MBEDTLS_LIBRARIES})
-  elseif (USE_SECURE_TRANSPORT)
-    message(STATUS "TLS configured to use secure transport")
-    target_link_libraries(ixwebsocket "-framework foundation" "-framework security")
-  endif()
-endif()
-
-# This ZLIB_FOUND check is to help find a cmake manually configured zlib
-if (NOT ZLIB_FOUND)
-  find_package(ZLIB)
-endif()
-if (ZLIB_FOUND)
-  include_directories(${ZLIB_INCLUDE_DIRS})
-  target_link_libraries(ixwebsocket ${ZLIB_LIBRARIES})
-else()
-  include_directories(third_party/zlib ${CMAKE_CURRENT_BINARY_DIR}/third_party/zlib)
-  add_subdirectory(third_party/zlib)
-  target_link_libraries(ixwebsocket zlibstatic)
+if (APPLE AND USE_TLS AND NOT USE_MBED_TLS)
+  target_link_libraries(ixwebsocket "-framework foundation" "-framework security")
 endif()
 
 if (WIN32)
-  target_link_libraries(ixwebsocket wsock32 ws2_32 shlwapi)
+  target_link_libraries(ixwebsocket wsock32 ws2_32)
   add_definitions(-D_CRT_SECURE_NO_WARNINGS)
-
-  if (USE_TLS)
-    target_link_libraries(ixwebsocket Crypt32)
-  endif()
 endif()
 
 if (UNIX)
@@ -215,9 +154,40 @@ if (UNIX)
   target_link_libraries(ixwebsocket ${CMAKE_THREAD_LIBS_INIT})
 endif()
 
+if (USE_TLS AND USE_OPEN_SSL)
+  find_package(OpenSSL REQUIRED)
+  add_definitions(${OPENSSL_DEFINITIONS})
+  message(STATUS "OpenSSL: " ${OPENSSL_VERSION})
+  include_directories(${OPENSSL_INCLUDE_DIR})
+  target_link_libraries(ixwebsocket ${OPENSSL_LIBRARIES})
+endif()
+
+if (USE_TLS AND USE_MBED_TLS)
+  if (USE_VENDORED_THIRD_PARTY)
+    set (ENABLE_PROGRAMS OFF)
+    add_subdirectory(third_party/mbedtls)
+    include_directories(third_party/mbedtls/include)
+
+    target_link_libraries(ixwebsocket mbedtls)
+  else()
+    find_package(MbedTLS REQUIRED)
+    include_directories(${MBEDTLS_INCLUDE_DIRS})
+    target_link_libraries(ixwebsocket ${MBEDTLS_LIBRARIES})
+  endif()
+endif()
+
+find_package(ZLIB)
+if (ZLIB_FOUND)
+  include_directories(${ZLIB_INCLUDE_DIRS})
+  target_link_libraries(ixwebsocket ${ZLIB_LIBRARIES})
+else()
+  add_subdirectory(third_party/zlib)
+  include_directories(third_party/zlib ${CMAKE_CURRENT_BINARY_DIR}/third_party/zlib)
+  target_link_libraries(ixwebsocket zlibstatic)
+endif()
 
 set( IXWEBSOCKET_INCLUDE_DIRS
-    ${CMAKE_CURRENT_SOURCE_DIR}
+    .
 )
 
 if (CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
@@ -234,24 +204,6 @@ install(TARGETS ixwebsocket
         PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_PREFIX}/include/ixwebsocket/
 )
 
-if (USE_WS OR USE_TEST)
-  add_subdirectory(ixcore)
-  add_subdirectory(ixcrypto)
-  add_subdirectory(ixcobra)
-  add_subdirectory(ixsnake)
-  add_subdirectory(ixsentry)
-  add_subdirectory(ixbots)
-
-  add_subdirectory(third_party/spdlog spdlog)
-
-  if (USE_WS)
-      add_subdirectory(ws)
-  endif()
-  if (USE_TEST)
-      add_subdirectory(test)
-  endif()
-endif()
-
-if (USE_LUAROCKS)
-    add_subdirectory(luarocks)
+if (USE_WS)
+    add_subdirectory(ws)
 endif()

DOCKER_VERSION

@@ -0,0 +1 @@
+5.1.6

README.md

@@ -1,47 +1,13 @@
 ## Hello world
 
-![Build status](https://github.com/machinezone/IXWebSocket/workflows/unittest/badge.svg)
+![Alt text](https://travis-ci.org/machinezone/IXWebSocket.svg?branch=master) 
 
 IXWebSocket is a C++ library for WebSocket client and server development. It has minimal dependencies (no boost), is very simple to use and support everything you'll likely need for websocket dev (SSL, deflate compression, compiles on most platforms, etc...). HTTP client and server code is also available, but it hasn't received as much testing.
 
-It is been used on big mobile video game titles sending and receiving tons of messages since 2017 (iOS and Android). It was tested on macOS, iOS, Linux, Android, Windows and FreeBSD. Two important design goals are simplicity and correctness.
+It is been used on big mobile video game titles sending and receiving tons of messages since 2017 (iOS and Android).
 
-```cpp
-// Required on Windows
-ix::initNetSystem();
+Interested ? Go read the [docs](https://bsergean.github.io/IXWebSocket/site/) ! If things don't work as expected, please create an issue in github, or even better a pull request if you know how to fix your problem.
 
-// Our websocket object
-ix::WebSocket webSocket;
+IXWebSocket is actively being developed, check out the [changelog](CHANGELOG.md) to know what's cooking. If you are looking for a real time messaging service (the chat-like 'server' your websocket code will talk to) with many features such as history, backed by Redis, look at [cobra](https://github.com/machinezone/cobra).
 
-std::string url("ws://localhost:8080/");
-webSocket.setUrl(url);
-
-// Setup a callback to be fired (in a background thread, watch out for race conditions !)
-// when a message or an event (open, close, error) is received
-webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
-    {
-        if (msg->type == ix::WebSocketMessageType::Message)
-        {
-            std::cout << msg->str << std::endl;
-        }
-    }
-);
-
-// Now that our callback is setup, we can start our background thread and receive messages
-webSocket.start();
-
-// Send a message to the server (default to TEXT mode)
-webSocket.send("hello world");
-```
-
-Interested? Go read the [docs](https://machinezone.github.io/IXWebSocket/)! If things don't work as expected, please create an issue on GitHub, or even better a pull request if you know how to fix your problem.
-
-IXWebSocket is actively being developed, check out the [changelog](https://machinezone.github.io/IXWebSocket/CHANGELOG/) to know what's cooking. If you are looking for a real time messaging service (the chat-like 'server' your websocket code will talk to) with many features such as history, backed by Redis, look at [cobra](https://github.com/machinezone/cobra).
-
-IXWebSocket client code is autobahn compliant beginning with the 6.0.0 version. See the current [test results](https://bsergean.github.io/autobahn/reports/clients/index.html). Some tests are still failing in the server code.
-
-## Users
-
-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)
+IXWebSocket is not yet autobahn compliant, but we are working on changing this. See the current compliance [test results](https://bsergean.github.io/IXWebSocket/autobahn/index.html).

SECURITY.md

@@ -1,11 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 7.x.x   | :white_check_mark: |
-
-## Reporting a Vulnerability
-
-Users should send an email to bsergean@gmail.com to report a vulnerability.

appveyor.yml

@@ -2,21 +2,13 @@ image:
 - Visual Studio 2017
 
 install:
-- cd C:\Tools\vcpkg
-- git pull
-- .\bootstrap-vcpkg.bat
-- cd %APPVEYOR_BUILD_FOLDER%
+- ls -al
 - cmd: call "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat"
-- vcpkg install zlib:x64-windows
-- vcpkg install mbedtls:x64-windows
+- cd test
 - mkdir build
 - cd build
-- cmake -DCMAKE_TOOLCHAIN_FILE=c:/tools/vcpkg/scripts/buildsystems/vcpkg.cmake -DUSE_WS=1 -DUSE_TEST=1 -DUSE_TLS=1 -G"NMake Makefiles" ..
+- cmake -G"NMake Makefiles" ..
 - nmake
-- cd ..
-- cd test
-- ..\build\test\ixwebsocket_unittest.exe
-
-cache: c:\tools\vcpkg\installed\
+- ixwebsocket_unittest.exe
 
 build: off

docker-compose.yml

@@ -1,67 +1,43 @@
 version: "3"
 services:
-  # snake:
-  #   image: bsergean/ws:build
-  #   entrypoint: ws snake --port 8767 --host 0.0.0.0 --redis_hosts redis1
-  #   ports:
-  #     - "8767:8767"
-  #   networks:
-  #     - ws-net
-  #   depends_on:
-  #     - redis1
+  snake:
+    image: bsergean/ws:build
+    entrypoint: ws snake --port 8765 --host 0.0.0.0 --redis_hosts redis1
+    ports:
+      - "8765:8765"
+    networks:
+      - ws-net
+    depends_on:
+      - redis1
 
-  # proxy:
-  #   image: bsergean/ws:build
-  #   entrypoint: strace ws proxy_server --remote_host 'wss://cobra.addsrv.com' --host 0.0.0.0 --port 8765 -v
-  #   ports:
-  #     - "8765:8765"
-  #   networks:
-  #     - ws-net
-
-  #pyproxy:
-  #  image: bsergean/ws_proxy:build
-  #  entrypoint: /usr/bin/ws_proxy.py --remote_url 'wss://cobra.addsrv.com' --host 0.0.0.0 --port 8765
-  #  ports:
-  #    - "8765:8765"
-  #  networks:
-  #    - ws-net
-
-  #      #  ws:
-  #      #    security_opt:
-  #      #    - seccomp:unconfined
-  #      #    cap_add:
-  #      #    - SYS_PTRACE
-  #      #    stdin_open: true
-  #      #    tty: true
-  #      #    image: bsergean/ws:build
-  #      #    entrypoint: sh
-  #      #    networks:
-  #      #      - ws-net
-  #      #    depends_on:
-  #      #      - redis1
-  #      #
-  #      #  redis1:
-  #      #    image: redis:alpine
-  #      #    networks:
-  #      #      - ws-net
-  #      #
-  #      #  statsd:
-  #      #    image: jaconel/statsd
-  #      #    ports:
-  #      #      - "8125:8125"
-  #      #    environment:
-  #      #      - STATSD_DUMP_MSG=true
-  #      #      - GRAPHITE_HOST=127.0.0.1
-  #      #    networks:
-  #      #      - ws-net
-
-  compile:
-    image: alpine
-    entrypoint: sh
+  ws:
+    security_opt:
+    - seccomp:unconfined
+    cap_add:
+    - SYS_PTRACE
     stdin_open: true
     tty: true
-    volumes:
-      - /Users/bsergeant/src/foss:/home/bsergean/src/foss
+    image: bsergean/ws:build
+    entrypoint: bash
+    networks:
+      - ws-net
+    depends_on:
+      - redis1
+
+  redis1:
+    image: redis:alpine
+    networks:
+      - ws-net
+
+  statsd:
+    image: jaconel/statsd
+    ports:
+      - "8125:8125"
+    environment:
+      - STATSD_DUMP_MSG=true
+      - GRAPHITE_HOST=127.0.0.1
+    networks:
+      - ws-net
 
 networks:
   ws-net:

docker/Dockerfile.alpine

@@ -1,13 +1,12 @@
-FROM alpine:3.11 as build
+FROM alpine as build
 
-RUN apk add --no-cache \
-    gcc g++ musl-dev linux-headers \
-    cmake mbedtls-dev make zlib-dev
+RUN apk add --no-cache gcc g++ musl-dev linux-headers cmake openssl-dev 
+RUN apk add --no-cache make
+RUN apk add --no-cache zlib-dev
 
-RUN addgroup -S app && \
-    adduser -S -G app app && \
-    chown -R app:app /opt && \
-    chown -R app:app /usr/local
+RUN addgroup -S app && adduser -S -G app app 
+RUN chown -R app:app /opt
+RUN chown -R app:app /usr/local
 
 # There is a bug in CMake where we cannot build from the root top folder
 # So we build from /opt
@@ -15,25 +14,20 @@ COPY --chown=app:app . /opt
 WORKDIR /opt
 
 USER app
-RUN make ws_mbedtls_install && \
-    sh tools/trim_repo_for_docker.sh
+RUN [ "make" ]
 
-FROM alpine:3.11 as runtime
+FROM alpine as runtime
 
-RUN apk add --no-cache libstdc++ mbedtls ca-certificates && \
-    addgroup -S app && \
-    adduser -S -G app app
+RUN apk add --no-cache libstdc++
 
+RUN addgroup -S app && adduser -S -G app app 
 COPY --chown=app:app --from=build /usr/local/bin/ws /usr/local/bin/ws
-
-# COPY --chown=app:app --from=build /opt /opt
-
-RUN chmod +x /usr/local/bin/ws && \
-    ldd /usr/local/bin/ws
+RUN chmod +x /usr/local/bin/ws
+RUN ldd /usr/local/bin/ws
 
 # Now run in usermode
 USER app
 WORKDIR /home/app
 
 ENTRYPOINT ["ws"]
-EXPOSE 8008
+CMD ["--help"]

docker/Dockerfile.centos

@@ -1,41 +0,0 @@
-FROM centos:8 as build
-
-RUN yum install -y gcc-c++ make cmake zlib-devel openssl-devel redhat-rpm-config
-
-RUN yum install -y epel-release
-RUN yum install -y mbedtls-devel
-
-RUN groupadd app && useradd -g app app
-RUN chown -R app:app /opt
-RUN chown -R app:app /usr/local
-
-# There is a bug in CMake where we cannot build from the root top folder
-# So we build from /opt
-COPY --chown=app:app . /opt
-WORKDIR /opt
-
-USER app
-RUN [ "make", "ws_mbedtls_install" ]
-RUN [ "rm", "-rf", "build" ]
-
-FROM centos:8 as runtime
-
-RUN yum install -y gdb strace
-
-RUN yum install -y epel-release
-RUN yum install -y mbedtls
-
-RUN groupadd app && useradd -g app app
-COPY --chown=app:app --from=build /usr/local/bin/ws /usr/local/bin/ws
-RUN chmod +x /usr/local/bin/ws
-RUN ldd /usr/local/bin/ws
-
-# Copy source code for gcc
-COPY --chown=app:app --from=build /opt /opt
-
-# Now run in usermode
-USER app
-WORKDIR /home/app
-
-ENTRYPOINT ["ws"]
-EXPOSE 8008

docker/Dockerfile.debian

@@ -2,14 +2,14 @@
 FROM debian:buster as build
 
 ENV DEBIAN_FRONTEND noninteractive
-RUN apt-get update
-RUN apt-get -y install wget
+RUN apt-get update 
+RUN apt-get -y install wget 
 RUN mkdir -p /tmp/cmake
 WORKDIR /tmp/cmake
-RUN wget https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz
+RUN wget https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz 
 RUN tar zxf cmake-3.14.0-Linux-x86_64.tar.gz
 
-RUN apt-get -y install g++
+RUN apt-get -y install g++ 
 RUN apt-get -y install libssl-dev
 RUN apt-get -y install libz-dev
 RUN apt-get -y install make
@@ -25,9 +25,9 @@ RUN ["make"]
 FROM debian:buster as runtime
 
 ENV DEBIAN_FRONTEND noninteractive
-RUN apt-get update
-# Runtime
-RUN apt-get install -y libssl1.1
+RUN apt-get update 
+# Runtime 
+RUN apt-get install -y libssl1.1 
 RUN apt-get install -y ca-certificates
 RUN ["update-ca-certificates"]
 

docker/Dockerfile.fedora

@@ -8,7 +8,7 @@ RUN yum install -y openssl-devel
 RUN yum install -y wget
 RUN mkdir -p /tmp/cmake
 WORKDIR /tmp/cmake
-RUN wget https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz
+RUN wget https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz 
 RUN tar zxf cmake-3.14.0-Linux-x86_64.tar.gz
 
 ARG CMAKE_BIN_PATH=/tmp/cmake/cmake-3.14.0-Linux-x86_64/bin
@@ -27,7 +27,7 @@ FROM fedora:30 as runtime
 
 RUN yum install -y libtsan
 
-RUN groupadd app && useradd -g app app
+RUN groupadd app && useradd -g app app 
 COPY --chown=app:app --from=build /usr/local/bin/ws /usr/local/bin/ws
 RUN chmod +x /usr/local/bin/ws
 RUN ldd /usr/local/bin/ws

docker/Dockerfile.ubuntu_bionic

@@ -2,14 +2,14 @@
 FROM ubuntu:bionic as build
 
 ENV DEBIAN_FRONTEND noninteractive
-RUN apt-get update
-RUN apt-get -y install wget
+RUN apt-get update 
+RUN apt-get -y install wget 
 RUN mkdir -p /tmp/cmake
 WORKDIR /tmp/cmake
-RUN wget https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz
+RUN wget https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz 
 RUN tar zxf cmake-3.14.0-Linux-x86_64.tar.gz
 
-RUN apt-get -y install g++
+RUN apt-get -y install g++ 
 RUN apt-get -y install libssl-dev
 RUN apt-get -y install libz-dev
 RUN apt-get -y install make

docker/Dockerfile.ubuntu_disco

@@ -2,14 +2,14 @@
 FROM ubuntu:disco as build
 
 ENV DEBIAN_FRONTEND noninteractive
-RUN apt-get update
-RUN apt-get -y install wget
+RUN apt-get update 
+RUN apt-get -y install wget 
 RUN mkdir -p /tmp/cmake
 WORKDIR /tmp/cmake
-RUN wget https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz
+RUN wget https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz 
 RUN tar zxf cmake-3.14.0-Linux-x86_64.tar.gz
 
-RUN apt-get -y install g++
+RUN apt-get -y install g++ 
 RUN apt-get -y install libssl-dev
 RUN apt-get -y install libz-dev
 RUN apt-get -y install make
@@ -20,5 +20,4 @@ COPY . .
 ARG CMAKE_BIN_PATH=/tmp/cmake/cmake-3.14.0-Linux-x86_64/bin
 ENV PATH="${CMAKE_BIN_PATH}:${PATH}"
 
-# RUN ["make", "test"]
-CMD ["sh"]
+RUN ["make", "test"]

docker/Dockerfile.ubuntu_xenial

@@ -2,14 +2,14 @@
 FROM ubuntu:xenial as build
 
 ENV DEBIAN_FRONTEND noninteractive
-RUN apt-get update
-RUN apt-get -y install wget
+RUN apt-get update 
+RUN apt-get -y install wget 
 RUN mkdir -p /tmp/cmake
 WORKDIR /tmp/cmake
-RUN wget https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz
+RUN wget https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz 
 RUN tar zxf cmake-3.14.0-Linux-x86_64.tar.gz
 
-RUN apt-get -y install g++
+RUN apt-get -y install g++ 
 RUN apt-get -y install libssl-dev
 RUN apt-get -y install libz-dev
 RUN apt-get -y install make

docs/CHANGELOG.md

@@ -1,623 +1,11 @@
 # Changelog
-All changes to this project will be documented in this file.
-
-## [9.5.2] - 2020-04-27
-
-(cmake) fix cmake broken tls option parsing
-
-## [9.5.1] - 2020-04-27
-
-(http client) Set default values for most HttpRequestArgs struct members (fix #185)
-
-## [9.5.0] - 2020-04-25
-
-(ssl) Default to OpenSSL on Windows, since it can load the system certificates by default
-
-## [9.4.1] - 2020-04-25
-
-(header) Add a space between header name and header value since most http parsers expects it, although it it not required. Cf #184 and #155
-
-## [9.4.0] - 2020-04-24
-
-(ssl) Add support for supplying SSL CA from memory, for OpenSSL and MbedTLS backends
-
-## [9.3.3] - 2020-04-17
-
-(ixbots) display sent/receive message, per seconds as accumulated
-
-## [9.3.2] - 2020-04-17
-
-(ws) add a --logfile option to configure all logs to go to a file
-
-## [9.3.1] - 2020-04-16
-
-(cobra bots) add a utility class to factor out the common bots features (heartbeat) and move all bots to used it + convert cobra_subscribe to be a bot and add a unittest for it
-
-## [9.3.0] - 2020-04-15
-
-(websocket) add a positive number to the heartbeat message sent, incremented each time the heartbeat is sent
-
-## [9.2.9] - 2020-04-15
-
-(ixcobra) change cobra event callback to use a struct instead of several objects, which is more flexible/extensible
-
-## [9.2.8] - 2020-04-15
-
-(ixcobra) make CobraConnection_EventType an enum class (CobraEventType)
-
-## [9.2.7] - 2020-04-14
-
-(ixsentry) add a library method to upload a payload directly to sentry
-
-## [9.2.6] - 2020-04-14
-
-(ixcobra) snake server / handle invalid incoming json messages + cobra subscriber in fluentd mode insert a created_at timestamp entry
-
-## [9.2.5] - 2020-04-13
-
-(websocket) WebSocketMessagePtr is a unique_ptr instead of a shared_ptr
-
-## [9.2.4] - 2020-04-13
-
-(websocket) use persistent member variable as temp variables to encode/decode zlib messages in order to reduce transient allocations
-
-## [9.2.3] - 2020-04-13
-
-(ws) add a --runtime option to ws cobra_subscribe to optionally limit how much time it will run
-
-## [9.2.2] - 2020-04-04
-
-(third_party deps) fix #177, update bundled spdlog to 1.6.0
-
-## [9.2.1] - 2020-04-04
-
-(windows) when using OpenSSL, the system store is used to populate the cacert. No need to ship a cacert.pem file with your app.
-
-## [9.2.0] - 2020-04-04
-
-(windows) ci: windows build with TLS (mbedtls) + verify that we can be build with OpenSSL
-
-## [9.1.9] - 2020-03-30
-
-(cobra to statsd bot) add ability to extract a numerical value and send a timer event to statsd, with the --timer option
-
-## [9.1.8] - 2020-03-29
-
-(cobra to statsd bot) bot init was missing + capture socket error
-
-## [9.1.7] - 2020-03-29
-
-(cobra to statsd bot) add ability to extract a numerical value and send a gauge event to statsd, with the --gauge option
-
-## [9.1.6] - 2020-03-29
-
-(ws cobra subscriber) use a Json::StreamWriter to write to std::cout, and save one std::string allocation for each message printed
-
-## [9.1.5] - 2020-03-29
-
-(docker) trim down docker image (300M -> 12M) / binary built without symbol and size optimization, and source code not copied over
-
-## [9.1.4] - 2020-03-28
-
-(jsoncpp) update bundled copy to version 1.9.3 (at sha 3beb37ea14aec1bdce1a6d542dc464d00f4a6cec)
-
-## [9.1.3] - 2020-03-27
-
-(docker) alpine docker build with release with debug info, and bundle ca-certificates
-
-## [9.1.2] - 2020-03-26
-
-(mac ssl) rename DarwinSSL -> SecureTransport (see this too -> https://github.com/curl/curl/issues/3733)
-
-## [9.1.1] - 2020-03-26
-
-(websocket) fix data race accessing _socket object without mutex protection when calling wakeUpFromPoll in WebSocketTransport.cpp
-
-## [9.1.0] - 2020-03-26
-
-(ixcobra) add explicit event types for handshake, authentication and subscription failure, and handle those by exiting in ws_cobra_subcribe and friends
-
-## [9.0.3] - 2020-03-24
-
-(ws connect) display statistics about how much time it takes to stop the connection
-
-## [9.0.2] - 2020-03-24
-
-(socket) works with unique_ptr<Socket> instead of shared_ptr<Socket> in many places
-
-## [9.0.1] - 2020-03-24
-
-(socket) selectInterrupt member is an unique_ptr instead of being a shared_ptr
-
-## [9.0.0] - 2020-03-23
-
-(websocket) reset per-message deflate codec everytime we connect to a server/client
-
-## [8.3.4] - 2020-03-23
-
-(websocket) fix #167, a long standing issue with sending empty messages with per-message deflate extension (and hopefully other zlib bug)
-
-## [8.3.3] - 2020-03-22
-
-(cobra to statsd) port to windows and add a unittest
-
-## [8.3.2] - 2020-03-20
-
-(websocket+tls) fix hang in tls handshake which could lead to ANR, discovered through unittesting.
-
-## [8.3.1] - 2020-03-20
-
-(cobra) CobraMetricsPublisher can be configure with an ix::CobraConfig + more unittest use SSL in server + client
-
-## [8.3.0] - 2020-03-18
-
-(websocket) Simplify ping/pong based heartbeat implementation
-
-## [8.2.7] - 2020-03-17
-
-(ws) ws connect gains a new option to set the interval at which to send pings
-(ws) ws echo_server gains a new option (-p) to disable responding to pings with pongs
-
-```
-IXWebSocket$ ws connect --ping_interval 2 wss://echo.websocket.org
-Type Ctrl-D to exit prompt...
-Connecting to url: wss://echo.websocket.org
-> ws_connect: connected
-[2020-03-17 23:53:02.726] [info] Uri: /
-[2020-03-17 23:53:02.726] [info] Headers:
-[2020-03-17 23:53:02.727] [info] Connection: Upgrade
-[2020-03-17 23:53:02.727] [info] Date: Wed, 18 Mar 2020 06:45:05 GMT
-[2020-03-17 23:53:02.727] [info] Sec-WebSocket-Accept: 0gtqbxW0aVL/QI/ICpLFnRaiKgA=
-[2020-03-17 23:53:02.727] [info] sec-websocket-extensions:
-[2020-03-17 23:53:02.727] [info] Server: Kaazing Gateway
-[2020-03-17 23:53:02.727] [info] Upgrade: websocket
-[2020-03-17 23:53:04.894] [info] Received pong
-[2020-03-17 23:53:06.859] [info] Received pong
-[2020-03-17 23:53:08.881] [info] Received pong
-[2020-03-17 23:53:10.848] [info] Received pong
-[2020-03-17 23:53:12.898] [info] Received pong
-[2020-03-17 23:53:14.865] [info] Received pong
-[2020-03-17 23:53:16.890] [info] Received pong
-[2020-03-17 23:53:18.853] [info] Received pong
-
-[2020-03-17 23:53:19.388] [info]
-ws_connect: connection closed: code 1000 reason Normal closure
-
-[2020-03-17 23:53:19.502] [info] Received 208 bytes
-[2020-03-17 23:53:19.502] [info] Sent 0 bytes
-```
-
-## [8.2.6] - 2020-03-16
-
-(cobra to sentry bot + docker) default docker file uses mbedtls + ws cobra_to_sentry pass tls options to sentryClient.
-
-## [8.2.5] - 2020-03-13
-
-(cobra client) ws cobra subscribe resubscribe at latest position after being disconnected
-
-## [8.2.4] - 2020-03-13
-
-(cobra client) can subscribe with a position
-
-## [8.2.3] - 2020-03-13
-
-(cobra client) pass the message position to the subscription data callback
-
-## [8.2.2] - 2020-03-12
-
-(openssl tls backend) Fix a hand in OpenSSL when using TLS v1.3 ... by disabling TLS v1.3
-
-## [8.2.1] - 2020-03-11
-
-(cobra) IXCobraConfig struct has tlsOptions and per message deflate options
-
-## [8.2.0] - 2020-03-11
-
-(cobra) add IXCobraConfig struct to pass cobra config around
-
-## [8.1.9] - 2020-03-09
-
-(ws cobra_subscribe) add a --fluentd option to wrap a message in an enveloppe so that fluentd can recognize it
-
-## [8.1.8] - 2020-03-02
-
-(websocket server) fix regression with disabling zlib extension on the server side. If a client does not support this extension the server will handle it fine. We still need to figure out how to disable the option.
-
-## [8.1.7] - 2020-02-26
-
-(websocket) traffic tracker received bytes is message size while it should be wire size
-
-## [8.1.6] - 2020-02-26
-
-(ws_connect) display sent/received bytes statistics on exit
-
-## [8.1.5] - 2020-02-23
-
-(server) give thread name to some usual worker threads / unittest is broken !!
-
-## [8.1.4] - 2020-02-22
-
-(websocket server) fix regression from 8.1.2, where per-deflate message compression was always disabled
-
-## [8.1.3] - 2020-02-21
-
-(client + server) Fix #155 / http header parser should treat the space(s) after the : delimiter as optional. Fixing this bug made us discover that websocket sub-protocols are not properly serialiazed, but start with a ,
-
-## [8.1.2] - 2020-02-18
-
-(WebSocketServer) add option to disable deflate compression, exposed with the -x option to ws echo_server
-
-## [8.1.1] - 2020-02-18
-
-(ws cobra to statsd and sentry sender) exit if no messages are received for one minute, which is a sign that something goes wrong on the server side. That should be changed to be configurable in the future
-
-## [8.1.0] - 2020-02-13
-
-(http client + sentry minidump upload) Multipart stream closing boundary is invalid + mark some options as mandatory in the command line tools
-
-## [8.0.7] - 2020-02-12
-
-(build) remove the unused subtree which was causing some way of installing to break
-
-## [8.0.6] - 2020-01-31
-
-(snake) add an option to disable answering pongs as response to pings, to test cobra client behavior with hanged connections
-
-## [8.0.5] - 2020-01-31
-
-(IXCobraConnection) set a ping timeout of 90 seconds. If no pong messages are received as responses to ping for a while, give up and close the connection
-
-## [8.0.4] - 2020-01-31
-
-(cobra to sentry) remove noisy logging
-
-## [8.0.3] - 2020-01-30
-
-(ixcobra) check if we are authenticated in publishNext before trying to publish a message
-
-## [8.0.2] - 2020-01-28
-
-Extract severity level when emitting messages to sentry
-
-## [8.0.1] - 2020-01-28
-
-Fix bug #151 - If a socket connection is interrupted, calling stop() on the IXWebSocket object blocks until the next retry
-
-## [8.0.0] - 2020-01-26
-
-(SocketServer) add ability to bind on an ipv6 address
-
-## [7.9.6] - 2020-01-22
-
-(ws) add a dnslookup sub-command, to get the ip address of a remote host
-
-## [7.9.5] - 2020-01-14
-
-(windows) fix #144, get rid of stubbed/un-implemented windows schannel ssl backend
-
-## [7.9.4] - 2020-01-12
-
-(openssl + mbedssl) fix #140, can send large files with ws send over ssl / still broken with apple ssl
-
-## [7.9.3] - 2020-01-10
-
-(apple ssl) model write method after the OpenSSL one for consistency
-
-## [7.9.2] - 2020-01-06
-
-(apple ssl) unify read and write ssl utility code
-
-## [7.9.1] - 2020-01-06
-
-(websocket client) better error propagation when errors are detected while sending data
-(ws send) detect failures to send big files, terminate in those cases and report error
-
-## [7.9.0] - 2020-01-04
-
-(ws send) add option (-x) to disable per message deflate compression
-
-## [7.8.9] - 2020-01-04
-
-(ws send + receive) handle all message types (ping + pong + fragment) / investigate #140
-
-## [7.8.8] - 2019-12-28
-
-(mbedtls) fix related to private key file parsing and initialization
-
-## [7.8.6] - 2019-12-28
-
-(ws cobra to sentry/statsd) fix for handling null events properly for empty queues + use queue to send data to statsd
-
-## [7.8.5] - 2019-12-28
-
-(ws cobra to sentry) handle null events for empty queues
-
-## [7.8.4] - 2019-12-27
-
-(ws cobra to sentry) game is picked in a fair manner, so that all games get the same share of sent events
-
-## [7.8.3] - 2019-12-27
-
-(ws cobra to sentry) refactor queue related code into a class
-
-## [7.8.2] - 2019-12-25
-
-(ws cobra to sentry) bound the queue size used to hold up cobra messages before they are sent to sentry. Default queue size is a 100 messages. Without such limit the program runs out of memory when a subscriber receive a lot of messages that cannot make it to sentry
-
-## [7.8.1] - 2019-12-25
-
-(ws client) use correct compilation defines so that spdlog is not used as a header only library (reduce binary size and increase compilation speed)
-
-## [7.8.0] - 2019-12-24
-
-(ws client) all commands use spdlog instead of std::cerr or std::cout for logging
-
-## [7.6.5] - 2019-12-24
-
-(cobra client) send a websocket ping every 30s to keep the connection opened
-
-## [7.6.4] - 2019-12-22
-
-(client) error handling, quote url in error case when failing to parse one
-(ws) ws_cobra_publish: register callbacks before connecting
-(doc) mention mbedtls in supported ssl server backend
-
-## [7.6.3] - 2019-12-20
-
-(tls) add a simple description of the TLS configuration routine for debugging
-
-## [7.6.2] - 2019-12-20
-
-(mbedtls) correct support for using own certificate and private key
-
-## [7.6.1] - 2019-12-20
-
-(ws commands) in websocket proxy, disable automatic reconnections + in Dockerfile, use alpine 3.11
-
-## [7.6.0] - 2019-12-19
-
-(cobra) Add TLS options to all cobra commands and classes. Add example to the doc.
-
-## [7.5.8] - 2019-12-18
-
-(cobra-to-sentry) capture application version from device field
-
-## [7.5.7] - 2019-12-18
-
-(tls) Experimental TLS server support with mbedtls (windows) + process cert tlsoption (client + server)
-
-## [7.5.6] - 2019-12-18
-
-(tls servers) Make it clear that apple ssl and mbedtls backends do not support SSL in server mode
-
-## [7.5.5] - 2019-12-17
-
-(tls options client) TLSOptions struct _validated member should be initialized to false
-
-## [7.5.4] - 2019-12-16
-
-(websocket client) improve the error message when connecting to a non websocket server
-
-Before:
-
-```
-Connection error: Got bad status connecting to example.com:443, status: 200, HTTP Status line: HTTP/1.1 200 OK
-```
-
-After:
-
-```
-Connection error: Expecting status 101 (Switching Protocol), got 200 status connecting to example.com:443, HTTP Status line: HTTP/1.1 200 OK
-```
-
-## [7.5.3] - 2019-12-12
-
-(server) attempt at fixing #131 by using blocking writes in server mode
-
-## [7.5.2] - 2019-12-11
-
-(ws) cobra to sentry - created events with sentry tags based on tags present in the cobra messages
-
-## [7.5.1] - 2019-12-06
-
-(mac) convert SSL errors to utf8
-
-## [7.5.0] - 2019-12-05
-
-- (ws) cobra to sentry. Handle Error 429 Too Many Requests and politely wait before sending more data to sentry.
-
-In the example below sentry we are sending data too fast, sentry asks us to slow down which we do. Notice how the sent count stop increasing, while we are waiting for 41 seconds.
-
-```
-[2019-12-05 15:50:33.759] [info] messages received 2449 sent 3
-[2019-12-05 15:50:34.759] [info] messages received 5533 sent 7
-[2019-12-05 15:50:35.759] [info] messages received 8612 sent 11
-[2019-12-05 15:50:36.759] [info] messages received 11562 sent 15
-[2019-12-05 15:50:37.759] [info] messages received 14410 sent 19
-[2019-12-05 15:50:38.759] [info] messages received 17236 sent 23
-[2019-12-05 15:50:39.282] [error] Error sending data to sentry: 429
-[2019-12-05 15:50:39.282] [error] Body: {"exception":[{"stacktrace":{"frames":[{"filename":"WorldScene.lua","function":"WorldScene.lua:1935","lineno":1958},{"filename":"WorldScene.lua","function":"onUpdate_WorldCam","lineno":1921},{"filename":"WorldMapTile.lua","function":"__index","lineno":239}]},"value":"noisytypes: Attempt to call nil(nil,2224139838)!"}],"platform":"python","sdk":{"name":"ws","version":"1.0.0"},"tags":[["game","niso"],["userid","107638363"],["environment","live"]],"timestamp":"2019-12-05T23:50:39Z"}
-
-[2019-12-05 15:50:39.282] [error] Response: {"error_name":"rate_limit","error":"Creation of this event was denied due to rate limiting"}
-[2019-12-05 15:50:39.282] [warning] Error 429 - Too Many Requests. ws will sleep and retry after 41 seconds
-[2019-12-05 15:50:39.760] [info] messages received 18839 sent 25
-[2019-12-05 15:50:40.760] [info] messages received 18839 sent 25
-[2019-12-05 15:50:41.760] [info] messages received 18839 sent 25
-[2019-12-05 15:50:42.761] [info] messages received 18839 sent 25
-[2019-12-05 15:50:43.762] [info] messages received 18839 sent 25
-[2019-12-05 15:50:44.763] [info] messages received 18839 sent 25
-[2019-12-05 15:50:45.768] [info] messages received 18839 sent 25
-```
-
-## [7.4.5] - 2019-12-03
-
-- (ws) #125 / fix build problem when jsoncpp is not installed locally
-
-## [7.4.4] - 2019-12-03
-
-- (ws) #125 / cmake detects an already installed jsoncpp and will try to use this one if present
-
-## [7.4.3] - 2019-12-03
-
-- (http client) use std::unordered_map instead of std::map for HttpParameters and HttpFormDataParameters class aliases
-
-## [7.4.2] - 2019-12-02
-
-- (client) internal IXDNSLookup class requires a valid cancellation request function callback to be passed in
-
-## [7.4.1] - 2019-12-02
-
-- (client) fix an overflow in the exponential back off code
-
-## [7.4.0] - 2019-11-25
-
-- (http client) Add support for multipart HTTP POST upload
-- (ixsentry) Add support for uploading a minidump to sentry
-
-## [7.3.5] - 2019-11-20
-
-- On Darwin SSL, add ability to skip peer verification.
-
-## [7.3.4] - 2019-11-20
-
-- 32-bits compile fix, courtesy of @fcojavmc
-
-## [7.3.1] - 2019-11-16
-
-- ws proxy_server / remote server close not forwarded to the client
-
-## [7.3.0] - 2019-11-15
-
-- New ws command: `ws proxy_server`.
-
-## [7.2.2] - 2019-11-01
-
-- Tag a release + minor reformating.
-
-## [7.2.1] - 2019-10-26
-
-- Add unittest to IXSentryClient to lua backtrace parsing code
-
-## [7.2.0] - 2019-10-24
-
-- Add cobra_metrics_to_redis sub-command to create streams for each cobra metric event being received.
-
-## [7.1.0] - 2019-10-13
-
-- Add client support for websocket subprotocol. Look for the new addSubProtocol method for details.
-
-## [7.0.0] - 2019-10-01
-
-- TLS support in server code, only implemented for the OpenSSL SSL backend for now.
-
-## [6.3.4] - 2019-09-30
-
-- all ws subcommands propagate tls options to servers (unimplemented) or ws or http client (implemented) (contributed by Matt DeBoer)
-
-## [6.3.3] - 2019-09-30
-
-- ws has a --version option
-
-## [6.3.2] - 2019-09-29
-
-- (http + websocket clients) can specify cacert and some other tls options (not implemented on all backend). This makes it so that server certs can finally be validated on windows.
-
-## [6.3.1] - 2019-09-29
-
-- Add ability to use OpenSSL on apple platforms.
-
-## [6.3.0] - 2019-09-28
-
-- ixcobra / fix crash in CobraConnection::publishNext when the queue is empty + handle CobraConnection_PublishMode_Batch in CobraMetricsThreadedPublisher
-
-## [6.2.9] - 2019-09-27
-
-- mbedtls fixes / the unittest now pass on macOS, and hopefully will on Windows/AppVeyor as well.
-
-## [6.2.8] - 2019-09-26
-
-- Http server: add options to ws https to redirect all requests to a given url. POST requests will get a 200 and an empty response.
-
-```
-ws httpd -L --redirect_url https://www.google.com
-```
-
-## [6.2.7] - 2019-09-25
-
-- Stop having ws send subcommand send a binary message in text mode, which would cause error in `make ws_test` shell script test.
-
-## [6.2.6] - 2019-09-24
-
-- Fix 2 race conditions detected with TSan, one in CobraMetricsPublisher::push and another one in WebSocketTransport::sendData (that one was bad).
-
-## [6.2.5] - 2019-09-23
-
-- Add simple Redis Server which is only capable of doing publish / subscribe. New ws redis_server sub-command to use it. The server is used in the unittest, so that we can run on CI in environment where redis isn not available like github actions env.
-
-## [6.2.4] - 2019-09-22
-
-- Add options to configure TLS ; contributed by Matt DeBoer. Only implemented for OpenSSL TLS backend for now.
-
-## [6.2.3] - 2019-09-21
-
-- Fix crash in the Linux unittest in the HTTP client code, in Socket::readBytes
-- Cobra Metrics Publisher code returns the message id of the message that got published, to be used to validated that it got sent properly when receiving an ack.
-
-## [6.2.2] - 2019-09-19
-
-- In DNS lookup code, make sure the weak pointer we use lives through the expected scope (if branch)
-
-## [6.2.1] - 2019-09-17
-
-- On error while doing a client handshake, additionally display port number next to the host name
-
-## [6.2.0] - 2019-09-09
-
-- websocket and http server: server does not close the bound client socket in many cases
-- improve some websocket error messages
-- add a utility function with unittest to parse status line and stop using scanf which triggers warnings on Windows
-- update ws CLI11 (our command line argument parsing library) to the latest, which fix a compiler bug about optional
-
-## [6.1.0] - 2019-09-08
-
-- move poll wrapper on top of select (only used on Windows) to the ix namespace
-
-## [6.0.1] - 2019-09-05
-
-- add cobra metrics publisher + server unittest
-- add cobra client + server unittest
-- ws snake (cobra simple server) add basic support for unsubscription + subscribe send the proper subscription data + redis client subscription can be cancelled
-- IXCobraConnection / pdu handlers can crash if they receive json data which is not an object
-
-## [6.0.0] - 2019-09-04
-
-- all client autobahn test should pass !
-- zlib/deflate has a bug with windowsbits == 8, so we silently upgrade it to 9/ (fix autobahn test 13.X which uses 8 for the windows size)
-
-## [5.2.0] - 2019-09-04
-
-- Fragmentation: for sent messages which are compressed, the continuation fragments should not have the rsv1 bit set (fix all autobahn tests for zlib compression 12.X)
-- Websocket Server / do a case insensitive string search when looking for an Upgrade header whose value is websocket. (some client use WebSocket with some upper-case characters)
-
-## [5.1.9] - 2019-09-03
-
-- ws autobahn / report progress with spdlog::info to get timing info
-- ws autobahn / use condition variables for stopping test case + add more logging on errors
-
-## [5.1.8] - 2019-09-03
-
-- Per message deflate/compression: handle fragmented messages (fix autobahn test: 12.1.X and probably others)
-
-## [5.1.7] - 2019-09-03
-
-- Receiving invalid UTF-8 TEXT message should fail and close the connection (fix remaining autobahn test: 6.X UTF-8 Handling)
+All notable changes to this project will be documented in this file.
 
 ## [5.1.6] - 2019-09-03
 
 - Sending invalid UTF-8 TEXT message should fail and close the connection (fix remaining autobahn test: 6.X UTF-8 Handling)
 - Fix failing unittest which was sending binary data in text mode with WebSocket::send to call properly call WebSocket::sendBinary instead.
 - Validate that the reason is proper utf-8. (fix autobahn test 7.5.1)
-- Validate close codes. Autobahn 7.9.*
 
 ## [5.1.5] - 2019-09-03
 
@@ -645,7 +33,7 @@ Close connections when reserved bits are used (fix autobahn test: 3.X Reserved B
 - add utf-8 validation code, not hooked up properly yet
 - Ping received with a payload too large (> 125 bytes) trigger a connection closure
 - cobra / add tracking about published messages
-- cobra / publish returns a message id, that can be used when
+- cobra / publish returns a message id, that can be used when 
 - cobra / new message type in the message received handler when publish/ok is received (can be used to implement an ack system).
 
 ## [5.0.9] - 2019-08-30
@@ -659,7 +47,7 @@ ws connect --max_wait 5000 ws://example.com # will only wait 5 seconds max betwe
 
 ## [5.0.7] - 2019-08-23
 - WebSocket: add new option to pass in extra HTTP headers when connecting.
-- `ws connect` add new option (-H, works like [curl](https://stackoverflow.com/questions/356705/how-to-send-a-header-using-a-http-request-through-a-curl-call)) to pass in extra HTTP headers when connecting
+- `ws connect` add new option (-H, works like [curl](https://stackoverflow.com/questions/356705/how-to-send-a-header-using-a-http-request-through-a-curl-call)) to pass in extra HTTP headers when connecting 
 
 If you run against `ws echo_server` you will see the headers being received printed in the terminal.
 ```

docs/build.md

@@ -18,22 +18,8 @@ There is a unittest which can be executed by typing `make test`.
 Options for building:
 
 * `-DUSE_TLS=1` will enable TLS support
-* `-DUSE_OPEN_SSL=1` will use [openssl](https://www.openssl.org/) for the TLS support (default on Linux and Windows)
-* `-DUSE_MBED_TLS=1` will use [mbedlts](https://tls.mbed.org/) for the TLS support
+* `-DUSE_MBED_TLS=1` will use [mbedlts](https://tls.mbed.org/) for the TLS support (default on Windows)
 * `-DUSE_WS=1` will build the ws interactive command line tool
-* `-DUSE_TEST=1` will build the unittest
-
-If you are on Windows, look at the [appveyor](https://github.com/machinezone/IXWebSocket/blob/master/appveyor.yml) file (not maintained much though) or rather the [github actions](https://github.com/machinezone/IXWebSocket/blob/master/.github/workflows/ccpp.yml#L40) which have instructions for building dependencies.
-
-It is also possible to externally include the project, so that everything is fetched over the wire when you build like so:
-
-```
-    ExternalProject_Add(
-        IXWebSocket
-        GIT_REPOSITORY https://github.com/machinezone/IXWebSocket.git
-        ...
-    )
-```
 
 ### vcpkg
 
@@ -45,23 +31,18 @@ vcpkg install ixwebsocket
 
 ### Conan
 
-[ ![Download](https://api.bintray.com/packages/conan/conan-center/ixwebsocket%3A_/images/download.svg) ](https://bintray.com/conan/conan-center/ixwebsocket%3A_/_latestVersion)
+Support for building with conan was contributed by Olivia Zoe (thanks !). The package name to reference is `IXWebSocket/5.0.0@LunarWatcher/stable`. The package is in the process to be published to the official conan package repo, but in the meantime, it can be accessed by adding a new remote 
 
-Conan is currently supported through a recipe in [Conan Center](https://github.com/conan-io/conan-center-index/tree/master/recipes/ixwebsocket) ([Bintray entry](https://bintray.com/conan/conan-center/ixwebsocket%3A_)).
-
-Package reference
-
-* Conan 1.21.0 and up: `ixwebsocket/7.9.2`
-* Earlier versions: `ixwebsocket/7.9.2@_/_`
-
-Note that the version listed here might not be the latest one. See Bintray or the recipe itself for the latest version. If you're migrating from the previous, custom Bintray remote, note that the package reference _has_ to be lower-case.
+```
+conan remote add remote_name_here https://api.bintray.com/conan/oliviazoe0/conan-packages
+```
 
 ### Docker
 
 There is a Dockerfile for running the unittest on Linux, and to run the `ws` tool. It is also available on the docker registry.
 
 ```
-docker run docker.pkg.github.com/machinezone/ixwebsocket/ws:latest --help
+docker run bsergean/ws
 ```
 
 To use docker-compose you must make a docker container first.
@@ -76,3 +57,6 @@ app@ca2340eb9106:~$ ws --help
 ws is a websocket tool
 ...
 ```
+
+
+

docs/cobra.md

@@ -1,81 +0,0 @@
-## General
-
-[cobra](https://github.com/machinezone/cobra) is a real time messaging server. The `ws` utility can run a cobra server (named snake), and has client to publish and subscribe to a cobra server.
-
-Bring up 3 terminals and run a server, a publisher and a subscriber in each one. As you publish data you should see it being received by the subscriber. You can run `redis-cli MONITOR` too to see how redis is being used.
-
-### Server
-
-You will need to have a redis server running locally. To run the server:
-
-```bash
-$ cd <ixwebsocket-top-level-folder>/ixsnake/ixsnake
-$ ws snake
-{
-  "apps": {
-    "FC2F10139A2BAc53BB72D9db967b024f": {
-      "roles": {
-        "_sub": {
-          "secret": "66B1dA3ED5fA074EB5AE84Dd8CE3b5ba"
-        },
-        "_pub": {
-          "secret": "1c04DB8fFe76A4EeFE3E318C72d771db"
-        }
-      }
-    }
-  }
-}
-
-redis host: 127.0.0.1
-redis password:
-redis port: 6379
-```
-
-### Publisher
-
-```bash
-$ cd <ixwebsocket-top-level-folder>/ws
-$ ws cobra_publish --appkey FC2F10139A2BAc53BB72D9db967b024f --endpoint ws://127.0.0.1:8008 --rolename _pub --rolesecret 1c04DB8fFe76A4EeFE3E318C72d771db test_channel cobraMetricsSample.json
-[2019-11-27 09:06:12.980] [info] Publisher connected
-[2019-11-27 09:06:12.980] [info] Connection: Upgrade
-[2019-11-27 09:06:12.980] [info] Sec-WebSocket-Accept: zTtQKMKbvwjdivURplYXwCVUCWM=
-[2019-11-27 09:06:12.980] [info] Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-[2019-11-27 09:06:12.980] [info] Server: ixwebsocket/7.4.0 macos ssl/DarwinSSL zlib 1.2.11
-[2019-11-27 09:06:12.980] [info] Upgrade: websocket
-[2019-11-27 09:06:12.982] [info] Publisher authenticated
-[2019-11-27 09:06:12.982] [info] Published msg 3
-[2019-11-27 09:06:12.982] [info] Published message id 3 acked
-```
-
-### Subscriber
-
-```bash
-$ ws cobra_subscribe --appkey FC2F10139A2BAc53BB72D9db967b024f --endpoint ws://127.0.0.1:8008 --rolename _pub --rolesecret 1c04DB8fFe76A4EeFE3E318C72d771db test_channel
-#messages 0 msg/s 0
-[2019-11-27 09:07:39.341] [info] Subscriber connected
-[2019-11-27 09:07:39.341] [info] Connection: Upgrade
-[2019-11-27 09:07:39.341] [info] Sec-WebSocket-Accept: 9vkQWofz49qMCUlTSptCCwHWm+Q=
-[2019-11-27 09:07:39.341] [info] Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-[2019-11-27 09:07:39.341] [info] Server: ixwebsocket/7.4.0 macos ssl/DarwinSSL zlib 1.2.11
-[2019-11-27 09:07:39.341] [info] Upgrade: websocket
-[2019-11-27 09:07:39.342] [info] Subscriber authenticated
-[2019-11-27 09:07:39.345] [info] Subscriber: subscribed to channel test_channel
-#messages 0 msg/s 0
-#messages 0 msg/s 0
-#messages 0 msg/s 0
-{"baz":123,"foo":"bar"}
-
-#messages 1 msg/s 1
-#messages 1 msg/s 0
-#messages 1 msg/s 0
-{"baz":123,"foo":"bar"}
-
-{"baz":123,"foo":"bar"}
-
-#messages 3 msg/s 2
-#messages 3 msg/s 0
-{"baz":123,"foo":"bar"}
-
-#messages 4 msg/s 1
-^C
-```

docs/design.md

@@ -6,9 +6,7 @@ The per message deflate compression option is supported. It can lead to very nic
 
 ### TLS/SSL
 
-Connections can be optionally secured and encrypted with TLS/SSL when using a wss:// endpoint, or using normal un-encrypted socket with ws:// endpoints. AppleSSL is used on iOS and macOS, OpenSSL and mbedTLS can be used on Android, Linux and Windows.
-
-If you are using OpenSSL, try to be on a version higher than 1.1.x as there there are thread safety problems with 1.0.x.
+Connections can be optionally secured and encrypted with TLS/SSL when using a wss:// endpoint, or using normal un-encrypted socket with ws:// endpoints. AppleSSL is used on iOS and macOS, OpenSSL is used on Android and Linux, mbedTLS is used on Windows.
 
 ### Polling and background thread work
 
@@ -26,19 +24,14 @@ Large frames are broken up into smaller chunks or messages to avoid filling up t
 
 The library has an interactive tool which is handy for testing compatibility ith other libraries. We have tested our client against Python, Erlang, Node.js, and C++ websocket server libraries.
 
-The unittest tries to be comprehensive, and has been running on multiple platforms, with different sanitizers such as a thread sanitizer to catch data races or the undefined behavior sanitizer.
+The unittest tries to be comprehensive, and has been running on multiple platoform, with different sanitizers such as thread sanitizer to catch data races or the undefined behavior sanitizer.
 
-The regression test is running after each commit on github actions for multiple configurations.
-
-* Linux
-* macOS with thread sanitizer
-* macOS, with OpenSSL, with thread sanitizer
-* macOS, with MbedTLS, with thread sanitizer
-* Windows, with MbedTLS (the unittest is not run yet)
+The regression test is running after each commit on travis.
 
 ## Limitations
 
-* On some configuration (mostly Android) certificate validation needs to be setup so that SocketTLSOptions.caFile point to a pem file, such as the one distributed by Firefox. Unless that setup is done connecting to a wss endpoint will display an error. With mbedtls the message will contain `error in handshake : X509 - Certificate verification failed, e.g. CRL, CA or signature check failed`.
+* On Windows TLS is not setup yet to validate certificates.
+* There is no convenient way to embed a ca cert.
 * Automatic reconnection works at the TCP socket level, and will detect remote end disconnects. However, if the device/computer network become unreachable (by turning off wifi), it is quite hard to reliably and timely detect it at the socket level using `recv` and `send` error codes. [Here](https://stackoverflow.com/questions/14782143/linux-socket-how-to-detect-disconnected-network-in-a-client-program) is a good discussion on the subject. This behavior is consistent with other runtimes such as node.js. One way to detect a disconnected device with low level C code is to do a name resolution with DNS but this can be expensive. Mobile devices have good and reliable API to do that.
 * The server code is using select to detect incoming data, and creates one OS thread per connection. This is not as scalable as strategies using epoll or kqueue.
 
@@ -80,3 +73,5 @@ Here is a simplistic diagram which explains how the code is structured in term o
 |                       |
 +-----------------------+
 ```
+
+

docs/index.md

@@ -1,4 +1,4 @@
-![Build status](https://github.com/machinezone/IXWebSocket/workflows/unittest/badge.svg)
+![Alt text](https://travis-ci.org/machinezone/IXWebSocket.svg?branch=master)
 
 ## Introduction
 
@@ -9,15 +9,14 @@
 * Linux
 * Android
 * Windows
-* FreeBSD
 
 ## Example code
 
-```c++
-// Required on Windows
+```
+# Required on Windows
 ix::initNetSystem();
 
-// Our websocket object
+# Our websocket object
 ix::WebSocket webSocket;
 
 std::string url("ws://localhost:8080/");
@@ -40,27 +39,8 @@ webSocket.start();
 webSocket.send("hello world");
 ```
 
-## Why another library?
+## Why another library ?
 
 There are 2 main reasons that explain why IXWebSocket got written. First, we needed a C++ cross-platform client library, which should have few dependencies. What looked like the most solid one, [websocketpp](https://github.com/zaphoyd/websocketpp) did depend on boost and this was not an option for us. Secondly, there were other available libraries with fewer dependencies (C ones), but they required calling an explicit poll routine periodically to know if a client had received data from a server, which was not elegant.
 
-We started by solving those 2 problems, then we added server websocket code, then an HTTP client, and finally a very simple HTTP server. IXWebSocket comes with a command line utility named ws which is quite handy, and is now packaged with alpine linux. You can install it with `apk add ws`.
-
-* Few dependencies (only zlib)
-* Simple to use ; uses std::string and std::function callbacks.
-* Complete support of the websocket protocol, and basic http support.
-* Client and Server
-* TLS support
-
-## Alternative libraries
-
-There are plenty of great websocket libraries out there, which might work for you. Here are a couple of serious ones.
-
-* [websocketpp](https://github.com/zaphoyd/websocketpp) - C++
-* [beast](https://github.com/boostorg/beast) - C++
-* [libwebsockets](https://libwebsockets.org/) - C
-* [µWebSockets](https://github.com/uNetworking/uWebSockets) - C
-
-## Contributing
-
-IXWebSocket is developed on [GitHub](https://github.com/machinezone/IXWebSocket). We'd love to hear about how you use it; opening up an issue on GitHub is ok for that. If things don't work as expected, please create an issue on GitHub, or even better a pull request if you know how to fix your problem.
+We started by solving those 2 problems, then we added server websocket code, then an HTTP client, and finally a very simple HTTP server.

docs/packages.md

@@ -1,94 +0,0 @@
-Notes on how we can update the different packages for ixwebsocket.
-
-## VCPKG
-
-Visit the [releases](https://github.com/machinezone/IXWebSocket/releases) page on Github. A tag must have been made first.
-
-Download the latest entry.
-
-```
-$ cd /tmp
-/tmp$ curl -s -O -L https://github.com/machinezone/IXWebSocket/archive/v9.1.9.tar.gz
-/tmp$
-/tmp$ openssl sha512 v9.1.9.tar.gz
-SHA512(v9.1.9.tar.gz)= f1fd731b5f6a9ce6d6d10bee22a5d9d9baaa8ea0564d6c4cd7eb91dcb88a45c49b2c7fdb75f8640a3589c1b30cee33ef5df8dcbb55920d013394d1e33ddd3c8e
-```
-
-Now go punch those values in the vcpkg ixwebsocket port config files. Here is what the diff look like.
-
-```
-vcpkg$ git diff
-diff --git a/ports/ixwebsocket/CONTROL b/ports/ixwebsocket/CONTROL
-index db9c2adc9..4acae5c3f 100644
---- a/ports/ixwebsocket/CONTROL
-+++ b/ports/ixwebsocket/CONTROL
-@@ -1,5 +1,5 @@
- Source: ixwebsocket
--Version: 8.0.5
-+Version: 9.1.9
- Build-Depends: zlib
- Homepage: https://github.com/machinezone/IXWebSocket
- Description: Lightweight WebSocket Client and Server + HTTP Client and Server
-diff --git a/ports/ixwebsocket/portfile.cmake b/ports/ixwebsocket/portfile.cmake
-index de082aece..68e523a05 100644
---- a/ports/ixwebsocket/portfile.cmake
-+++ b/ports/ixwebsocket/portfile.cmake
-@@ -1,8 +1,8 @@
- vcpkg_from_github(
-     OUT_SOURCE_PATH SOURCE_PATH
-     REPO machinezone/IXWebSocket
--    REF v8.0.5
--    SHA512 9dcc20d9a0629b92c62a68a8bd7c8206f18dbd9e93289b0b687ec13c478ce9ad1f3563b38c399c8277b0d3812cc78ca725786ba1dedbc3445b9bdb9b689e8add
-+    REF v9.1.9
-+    SHA512 f1fd731b5f6a9ce6d6d10bee22a5d9d9baaa8ea0564d6c4cd7eb91dcb88a45c49b2c7fdb75f8640a3589c1b30cee33ef5df8dcbb55920d013394d1e33ddd3c8e
- )
-```
-
-You will need a fork of the vcpkg repo to make a pull request.
-
-```
-git fetch upstream
-git co master
-git reset --hard upstream/master
-git push origin master --force
-```
-
-Make the pull request (I use a new branch to do that).
-
-```
-vcpkg$ git co -b feature/ixwebsocket_9.1.9
-M	ports/ixwebsocket/CONTROL
-M	ports/ixwebsocket/portfile.cmake
-Switched to a new branch 'feature/ixwebsocket_9.1.9'
-vcpkg$
-vcpkg$
-vcpkg$ git commit -am 'ixwebsocket: update to 9.1.9'
-[feature/ixwebsocket_9.1.9 8587a4881] ixwebsocket: update to 9.1.9
- 2 files changed, 3 insertions(+), 3 deletions(-)
-vcpkg$
-vcpkg$ git push
-fatal: The current branch feature/ixwebsocket_9.1.9 has no upstream branch.
-To push the current branch and set the remote as upstream, use
-
-    git push --set-upstream origin feature/ixwebsocket_9.1.9
-
-vcpkg$ git push --set-upstream origin feature/ixwebsocket_9.1.9
-
-Enumerating objects: 11, done.
-Counting objects: 100% (11/11), done.
-Delta compression using up to 8 threads
-Compressing objects: 100% (6/6), done.
-Writing objects: 100% (6/6), 621 bytes | 621.00 KiB/s, done.
-Total 6 (delta 4), reused 0 (delta 0)
-remote: Resolving deltas: 100% (4/4), completed with 4 local objects.
-remote:
-remote: Create a pull request for 'feature/ixwebsocket_9.1.9' on GitHub by visiting:
-remote:      https://github.com/bsergean/vcpkg/pull/new/feature/ixwebsocket_9.1.9
-remote:
-To https://github.com/bsergean/vcpkg.git
- * [new branch]          feature/ixwebsocket_9.1.9 -> feature/ixwebsocket_9.1.9
-Branch 'feature/ixwebsocket_9.1.9' set up to track remote branch 'feature/ixwebsocket_9.1.9' from 'origin' by rebasing.
-vcpkg$
-```
-
-Just visit this url, https://github.com/bsergean/vcpkg/pull/new/feature/ixwebsocket_9.1.9, printed on the console, to make the pull request.

docs/usage.md

@@ -6,7 +6,7 @@ The [*ws*](https://github.com/machinezone/IXWebSocket/tree/master/ws) folder cou
 
 To use the network system on Windows, you need to initialize it once with *WSAStartup()* and clean it up with *WSACleanup()*. We have helpers for that which you can use, see below. This init would typically take place in your main function.
 
-```cpp
+```
 #include <ixwebsocket/IXNetSystem.h>
 
 int main()
@@ -22,12 +22,12 @@ int main()
 
 ## WebSocket client API
 
-```cpp
+```
 #include <ixwebsocket/IXWebSocket.h>
 
 ...
 
-// Our websocket object
+# Our websocket object
 ix::WebSocket webSocket;
 
 std::string url("ws://localhost:8080/");
@@ -35,7 +35,7 @@ webSocket.setUrl(url);
 
 // Optional heart beat, sent every 45 seconds when there is not any traffic
 // to make sure that load balancers do not kill an idle connection.
-webSocket.setPingInterval(45);
+webSocket.setHeartBeatPeriod(45);
 
 // Per message deflate connection is enabled by default. You can tweak its parameters or disable it
 webSocket.disablePerMessageDeflate();
@@ -82,9 +82,9 @@ If the connection was closed and sending failed, the return value will be set to
 
 ### Open and Close notifications
 
-The onMessage event will be fired when the connection is opened or closed. This is similar to the [JavaScript browser API](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket), which has `open` and `close` events notification that can be registered with the browser `addEventListener`.
+The onMessage event will be fired when the connection is opened or closed. This is similar to the [Javascript browser API](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket), which has `open` and `close` events notification that can be registered with the browser `addEventListener`.
 
-```cpp
+```
 webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
     {
         if (msg->type == ix::WebSocketMessageType::Open)
@@ -115,7 +115,7 @@ webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
 
 A message will be fired when there is an error with the connection. The message type will be `ix::WebSocketMessageType::Error`. Multiple fields will be available on the event to describe the error.
 
-```cpp
+```
 webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
     {
         if (msg->type == ix::WebSocketMessageType::Error)
@@ -140,7 +140,7 @@ webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
 
 The url can be set and queried after a websocket object has been created. You will have to call `stop` and `start` if you want to disconnect and connect to that new url.
 
-```cpp
+```
 std::string url("wss://example.com");
 websocket.configure(url);
 ```
@@ -149,7 +149,7 @@ websocket.configure(url);
 
 Ping/pong messages are used to implement keep-alive. 2 message types exists to identify ping and pong messages. Note that when a ping message is received, a pong is instantly send back as requested by the WebSocket spec.
 
-```cpp
+```
 webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
     {
         if (msg->type == ix::WebSocketMessageType::Ping ||
@@ -163,7 +163,7 @@ webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
 
 A ping message can be sent to the server, with an optional data string.
 
-```cpp
+```
 websocket.ping("ping data, optional (empty string is ok): limited to 125 bytes long");
 ```
 
@@ -173,40 +173,25 @@ You can configure an optional heart beat / keep-alive, sent every 45 seconds
 when there is no any traffic to make sure that load balancers do not kill an
 idle connection.
 
-```cpp
-webSocket.setPingInterval(45);
+```
+webSocket.setHeartBeatPeriod(45);
 ```
 
 ### Supply extra HTTP headers.
 
 You can set extra HTTP headers to be sent during the WebSocket handshake.
 
-```cpp
+```
 WebSocketHttpHeaders headers;
 headers["foo"] = "bar";
 webSocket.setExtraHeaders(headers);
 ```
 
-### Subprotocols
-
-You can specify subprotocols to be set during the WebSocket handshake. For more info you can refer to [this doc](https://hpbn.co/websocket/#subprotocol-negotiation).
-
-```cpp
-webSocket.addSubprotocol("appProtocol-v1");
-webSocket.addSubprotocol("appProtocol-v2");
-```
-
-The protocol that the server did accept is available in the open info `protocol` field.
-
-```cpp
-std::cout << "protocol: " << msg->openInfo.protocol << std::endl;
-```
-
 ### Automatic reconnection
 
 Automatic reconnection kicks in when the connection is disconnected without the user consent. This feature is on by default and can be turned off.
 
-```cpp
+```
 webSocket.enableAutomaticReconnection();  // turn on
 webSocket.disableAutomaticReconnection(); // turn off
 bool enabled = webSocket.isAutomaticReconnectionEnabled(); // query state
@@ -239,14 +224,14 @@ Wait time(ms): 10000
 
 The waiting time is capped by default at 10s between 2 attempts, but that value can be changed and queried.
 
-```cpp
-webSocket.setMaxWaitBetweenReconnectionRetries(5 * 1000); // 5000ms = 5s
+```
+webSocket.setMaxWaitBetweenReconnectionRetries(5 * 1000); // 5000ms = 5s 
 uint32_t m = webSocket.getMaxWaitBetweenReconnectionRetries();
 ```
 
 ## WebSocket server API
 
-```cpp
+```
 #include <ixwebsocket/IXWebSocketServer.h>
 
 ...
@@ -311,7 +296,7 @@ server.wait();
 
 ## HTTP client API
 
-```cpp
+```
 #include <ixwebsocket/IXHttpClient.h>
 
 ...
@@ -394,7 +379,7 @@ bool ok = httpClient.performRequest(args, [](const HttpResponsePtr& response)
 
 ## HTTP server API
 
-```cpp
+```
 #include <ixwebsocket/IXHttpServer.h>
 
 ix::HttpServer server(port, hostname);
@@ -412,7 +397,7 @@ server.wait();
 
 If you want to handle how requests are processed, implement the setOnConnectionCallback callback, which takes an HttpRequestPtr as input, and returns an HttpResponsePtr. You can look at HttpServer::setDefaultConnectionCallback for a slightly more advanced callback example.
 
-```cpp
+```
 setOnConnectionCallback(
     [this](HttpRequestPtr request,
            std::shared_ptr<ConnectionState> /*connectionState*/) -> HttpResponsePtr
@@ -431,40 +416,3 @@ setOnConnectionCallback(
                                               content);
 }
 ```
-
-## TLS support and configuration
-
-To leverage TLS features, the library must be compiled with the option `USE_TLS=1`.
-
-If you are using OpenSSL, try to be on a version higher than 1.1.x as there there are thread safety problems with 1.0.x.
-
-Then, secure sockets are automatically used when connecting to a `wss://*` url.
-
-Additional TLS options can be configured by passing a `ix::SocketTLSOptions` instance to the
-`setTLSOptions` on `ix::WebSocket` (or `ix::WebSocketServer` or `ix::HttpServer`)
-
-```cpp
-webSocket.setTLSOptions({
-    .certFile = "path/to/cert/file.pem",
-    .keyFile = "path/to/key/file.pem",
-    .caFile = "path/to/trust/bundle/file.pem", // as a file, or in memory buffer in PEM format
-    .tls = true // required in server mode
-});
-```
-
-Specifying `certFile` and `keyFile` configures the certificate that will be used to communicate with TLS peers.
-
-On a client, this is only necessary for connecting to servers that require a client certificate.
-
-On a server, this is necessary for TLS support.
-
-Specifying `caFile` configures the trusted roots bundle file (in PEM format) that will be used to verify peer certificates.
- - The special value of `SYSTEM` (the default) indicates that the system-configured trust bundle should be used; this is generally what you want when connecting to any publicly exposed API/server.
- - The special value of `NONE` can be used to disable peer verification; this is only recommended to rule out certificate verification when testing connectivity.
- - If the value contain the special value `-----BEGIN CERTIFICATE-----`, the value will be read from memory, and not from a file. This is convenient on platforms like Android where reading / writing to the file system can be challenging without proper permissions, or without knowing the location of a temp directory.
-
-For a client, specifying `caFile` can be used if connecting to a server that uses a self-signed cert, or when using a custom CA in an internal environment.
-
-For a server, specifying `caFile` implies that:
-1. You require clients to present a certificate
-1. It must be signed by one of the trusted roots in the file

docs/ws.md

@@ -29,181 +29,6 @@ Subcommands:
   httpd                       HTTP server
 ```
 
-## curl
-
-The curl subcommand try to be compatible with the curl syntax, to fetch http pages.
-
-Making a HEAD request with the -I parameter.
-
-```
-$ ws curl -I https://www.google.com/
-
-Accept-Ranges: none
-Alt-Svc: quic=":443"; ma=2592000; v="46,43",h3-Q048=":443"; ma=2592000,h3-Q046=":443"; ma=2592000,h3-Q043=":443"; ma=2592000
-Cache-Control: private, max-age=0
-Content-Type: text/html; charset=ISO-8859-1
-Date: Tue, 08 Oct 2019 21:36:57 GMT
-Expires: -1
-P3P: CP="This is not a P3P policy! See g.co/p3phelp for more info."
-Server: gws
-Set-Cookie: NID=188=ASwfz8GrXQrHCLqAz-AndLOMLcz0rC9yecnf3h0yXZxRL3rTufTU_GDDwERp7qQL7LZ_EB8gCRyPXGERyOSAgaqgnrkoTmvWrwFemRLMaOZ896GrHobi5fV7VLklnSG2w48Gj8xMlwxfP7Z-bX-xR9UZxep1tHM6UmFQdD_GkBE; expires=Wed, 08-Apr-2020 21:36:57 GMT; path=/; domain=.google.com; HttpOnly
-Transfer-Encoding: chunked
-Vary: Accept-Encoding
-X-Frame-Options: SAMEORIGIN
-X-XSS-Protection: 0
-Upload size: 143
-Download size: 0
-Status: 200
-```
-
-Making a POST request with the -F parameter.
-
-```
-$ ws curl -F foo=bar https://httpbin.org/post
-foo: bar
-Downloaded 438 bytes out of 438
-Access-Control-Allow-Credentials: true
-Access-Control-Allow-Origin: *
-Connection: keep-alive
-Content-Encoding:
-Content-Length: 438
-Content-Type: application/json
-Date: Tue, 08 Oct 2019 21:47:54 GMT
-Referrer-Policy: no-referrer-when-downgrade
-Server: nginx
-X-Content-Type-Options: nosniff
-X-Frame-Options: DENY
-X-XSS-Protection: 1; mode=block
-Upload size: 219
-Download size: 438
-Status: 200
-payload: {
-  "args": {},
-  "data": "",
-  "files": {},
-  "form": {
-    "foo": "bar"
-  },
-  "headers": {
-    "Accept": "*/*",
-    "Content-Length": "7",
-    "Content-Type": "application/x-www-form-urlencoded",
-    "Host": "httpbin.org",
-    "User-Agent": "ixwebsocket/7.0.0 macos ssl/OpenSSL OpenSSL 1.0.2q  20 Nov 2018 zlib 1.2.11"
-  },
-  "json": null,
-  "origin": "155.94.127.118, 155.94.127.118",
-  "url": "https://httpbin.org/post"
-}
-```
-
-Passing in a custom header with -H.
-
-```
-$ ws curl -F foo=bar -H 'my_custom_header: baz' https://httpbin.org/post
-my_custom_header:  baz
-foo: bar
-Downloaded 470 bytes out of 470
-Access-Control-Allow-Credentials: true
-Access-Control-Allow-Origin: *
-Connection: keep-alive
-Content-Encoding:
-Content-Length: 470
-Content-Type: application/json
-Date: Tue, 08 Oct 2019 21:50:25 GMT
-Referrer-Policy: no-referrer-when-downgrade
-Server: nginx
-X-Content-Type-Options: nosniff
-X-Frame-Options: DENY
-X-XSS-Protection: 1; mode=block
-Upload size: 243
-Download size: 470
-Status: 200
-payload: {
-  "args": {},
-  "data": "",
-  "files": {},
-  "form": {
-    "foo": "bar"
-  },
-  "headers": {
-    "Accept": "*/*",
-    "Content-Length": "7",
-    "Content-Type": "application/x-www-form-urlencoded",
-    "Host": "httpbin.org",
-    "My-Custom-Header": "baz",
-    "User-Agent": "ixwebsocket/7.0.0 macos ssl/OpenSSL OpenSSL 1.0.2q  20 Nov 2018 zlib 1.2.11"
-  },
-  "json": null,
-  "origin": "155.94.127.118, 155.94.127.118",
-  "url": "https://httpbin.org/post"
-}
-```
-
-## connect
-
-The connect command connects to a websocket endpoint, and starts an interactive prompt. Line editing, such as using the direction keys to fetch the last thing you tried to type) is provided. That command is pretty useful to try to send random data to an endpoint and verify that the service handles it with grace (such as sending invalid json).
-
-```
-ws connect wss://echo.websocket.org
-Type Ctrl-D to exit prompt...
-Connecting to url: wss://echo.websocket.org
-> ws_connect: connected
-Uri: /
-Handshake Headers:
-Connection: Upgrade
-Date: Tue, 08 Oct 2019 21:38:44 GMT
-Sec-WebSocket-Accept: 2j6LBScZveqrMx1W/GJkCWvZo3M=
-sec-websocket-extensions:
-Server: Kaazing Gateway
-Upgrade: websocket
-Received ping
-Received ping
-Received ping
-Hello world !
-> Received 13 bytes
-ws_connect: received message: Hello world !
-> Hello world !
-> Received 13 bytes
-ws_connect: received message: Hello world !
-```
-
-```
-ws connect 'ws://jeanserge.com/v2?appkey=_pubsub'
-Type Ctrl-D to exit prompt...
-Connecting to url: ws://jeanserge.com/v2?appkey=_pubsub
-> ws_connect: connected
-Uri: /v2?appkey=_pubsub
-Handshake Headers:
-Connection: Upgrade
-Date: Tue, 08 Oct 2019 21:45:28 GMT
-Sec-WebSocket-Accept: LYHmjh9Gsu/Yw7aumQqyPObOEV4=
-Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-Server: Python/3.7 websockets/8.0.2
-Upgrade: websocket
-bababababababab
-> ws_connect: connection closed: code 1000 reason
-
-ws_connect: connected
-Uri: /v2?appkey=_pubsub
-Handshake Headers:
-Connection: Upgrade
-Date: Tue, 08 Oct 2019 21:45:44 GMT
-Sec-WebSocket-Accept: I1rqxdLgTU+opPi5/zKPBTuXdLw=
-Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-Server: Python/3.7 websockets/8.0.2
-Upgrade: websocket
-```
-
-## Websocket proxy
-
-```
-ws proxy_server --remote_host ws://127.0.0.1:9000 -v
-Listening on 127.0.0.1:8008
-```
-
-If you connect to ws://127.0.0.1:8008, the proxy will connect to ws://127.0.0.1:9000 and pass all traffic to this server.
-
 ## File transfer
 
 ```
@@ -243,127 +68,6 @@ Options:
   --transfer-timeout INT      Transfer timeout
 ```
 
-## Cobra client and server
+## Cobra Client
 
-[cobra](https://github.com/machinezone/cobra) is a real time messenging server. ws has several sub-command to interact with cobra. There is also a minimal cobra compatible server named snake available.
-
-Below are examples on running a snake server and clients with TLS enabled (the server only works with the OpenSSL and the Mbed TLS backend for now).
-
-First, generate certificates.
-
-```
-$ cd /path/to/IXWebSocket
-$ cd ixsnake/ixsnake
-$ bash ../../ws/generate_certs.sh
-Generating RSA private key, 2048 bit long modulus
-.....+++
-.................+++
-e is 65537 (0x10001)
-generated ./.certs/trusted-ca-key.pem
-generated ./.certs/trusted-ca-crt.pem
-Generating RSA private key, 2048 bit long modulus
-..+++
-.......................................+++
-e is 65537 (0x10001)
-generated ./.certs/trusted-server-key.pem
-Signature ok
-subject=/O=machinezone/O=IXWebSocket/CN=trusted-server
-Getting CA Private Key
-generated ./.certs/trusted-server-crt.pem
-Generating RSA private key, 2048 bit long modulus
-...................................+++
-..................................................+++
-e is 65537 (0x10001)
-generated ./.certs/trusted-client-key.pem
-Signature ok
-subject=/O=machinezone/O=IXWebSocket/CN=trusted-client
-Getting CA Private Key
-generated ./.certs/trusted-client-crt.pem
-Generating RSA private key, 2048 bit long modulus
-..............+++
-.......................................+++
-e is 65537 (0x10001)
-generated ./.certs/untrusted-ca-key.pem
-generated ./.certs/untrusted-ca-crt.pem
-Generating RSA private key, 2048 bit long modulus
-..........+++
-................................................+++
-e is 65537 (0x10001)
-generated ./.certs/untrusted-client-key.pem
-Signature ok
-subject=/O=machinezone/O=IXWebSocket/CN=untrusted-client
-Getting CA Private Key
-generated ./.certs/untrusted-client-crt.pem
-Generating RSA private key, 2048 bit long modulus
-.....................................................................................+++
-...........+++
-e is 65537 (0x10001)
-generated ./.certs/selfsigned-client-key.pem
-Signature ok
-subject=/O=machinezone/O=IXWebSocket/CN=selfsigned-client
-Getting Private key
-generated ./.certs/selfsigned-client-crt.pem
-```
-
-Now run the snake server.
-
-```
-$ export certs=.certs
-$ ws snake --tls --port 8765 --cert-file ${certs}/trusted-server-crt.pem --key-file ${certs}/trusted-server-key.pem --ca-file ${certs}/trusted-ca-crt.pem
-{
-  "apps": {
-    "FC2F10139A2BAc53BB72D9db967b024f": {
-      "roles": {
-        "_sub": {
-          "secret": "66B1dA3ED5fA074EB5AE84Dd8CE3b5ba"
-        },
-        "_pub": {
-          "secret": "1c04DB8fFe76A4EeFE3E318C72d771db"
-        }
-      }
-    }
-  }
-}
-
-redis host: 127.0.0.1
-redis password:
-redis port: 6379
-```
-
-As a new connection comes in, such output should be printed
-
-```
-[2019-12-19 20:27:19.724] [info] New connection
-id: 0
-Uri: /v2?appkey=_health
-Headers:
-Connection: Upgrade
-Host: 127.0.0.1:8765
-Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-Sec-WebSocket-Key: d747B0fE61Db73f7Eh47c0==
-Sec-WebSocket-Protocol: json
-Sec-WebSocket-Version: 13
-Upgrade: websocket
-User-Agent: ixwebsocket/7.5.8 macos ssl/OpenSSL OpenSSL 1.0.2q  20 Nov 2018 zlib 1.2.11
-```
-
-To connect and publish a message, do:
-
-```
-$ export certs=.certs
-$ cd /path/to/ws/folder
-$ ls cobraMetricsSample.json
-cobraMetricsSample.json
-$ ws cobra_publish --endpoint wss://127.0.0.1:8765 --appkey FC2F10139A2BAc53BB72D9db967b024f --rolename _pub --rolesecret 1c04DB8fFe76A4EeFE3E318C72d771db --channel foo --cert-file ${certs}/trusted-client-crt.pem --key-file ${certs}/trusted-client-key.pem --ca-file ${certs}/trusted-ca-crt.pem cobraMetricsSample.json
-[2019-12-19 20:46:42.656] [info] Publisher connected
-[2019-12-19 20:46:42.657] [info] Connection: Upgrade
-[2019-12-19 20:46:42.657] [info] Sec-WebSocket-Accept: rs99IFThoBrhSg+k8G4ixH9yaq4=
-[2019-12-19 20:46:42.657] [info] Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-[2019-12-19 20:46:42.657] [info] Server: ixwebsocket/7.5.8 macos ssl/OpenSSL OpenSSL 1.0.2q  20 Nov 2018 zlib 1.2.11
-[2019-12-19 20:46:42.657] [info] Upgrade: websocket
-[2019-12-19 20:46:42.658] [info] Publisher authenticated
-[2019-12-19 20:46:42.658] [info] Published msg 3
-[2019-12-19 20:46:42.659] [info] Published message id 3 acked
-```
-
-To use OpenSSL on macOS, compile with `make ws_openssl`. First you will have to install OpenSSL libraries, which can be done with Homebrew. Use `make ws_mbedtls` accordingly to use MbedTLS.
+[cobra](https://github.com/machinezone/cobra) is a real time messenging server. ws has sub-command to interacti with cobra.

ixbots/CMakeLists.txt

@@ -1,44 +0,0 @@
-#
-# Author: Benjamin Sergeant
-# Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
-#
-
-set (IXBOTS_SOURCES
-    ixbots/IXCobraBot.cpp
-    ixbots/IXCobraToSentryBot.cpp
-    ixbots/IXCobraToStatsdBot.cpp
-    ixbots/IXCobraToStdoutBot.cpp
-    ixbots/IXQueueManager.cpp
-    ixbots/IXStatsdClient.cpp
-)
-
-set (IXBOTS_HEADERS
-    ixbots/IXCobraBot.h
-    ixbots/IXCobraToSentryBot.h
-    ixbots/IXCobraToStatsdBot.h
-    ixbots/IXCobraToStdoutBot.h
-    ixbots/IXQueueManager.h
-    ixbots/IXStatsdClient.h
-)
-
-add_library(ixbots STATIC
-    ${IXBOTS_SOURCES}
-    ${IXBOTS_HEADERS}
-)
-
-find_package(JsonCpp)
-if (NOT JSONCPP_FOUND)
-  set(JSONCPP_INCLUDE_DIRS ../third_party/jsoncpp)
-endif()
-
-set(IXBOTS_INCLUDE_DIRS
-    .
-    ..
-    ../ixcore
-    ../ixwebsocket
-    ../ixcobra
-    ../ixsentry
-    ${JSONCPP_INCLUDE_DIRS}
-    ${SPDLOG_INCLUDE_DIRS})
-
-target_include_directories( ixbots PUBLIC ${IXBOTS_INCLUDE_DIRS} )

ixbots/ixbots/IXCobraBot.cpp

@@ -1,321 +0,0 @@
-/*
- *  IXCobraBot.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2020 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXCobraBot.h"
-
-#include "IXQueueManager.h"
-#include <ixcobra/IXCobraConnection.h>
-#include <ixcore/utils/IXCoreLogger.h>
-
-#include <algorithm>
-#include <chrono>
-#include <sstream>
-#include <thread>
-#include <vector>
-
-namespace ix
-{
-    int64_t CobraBot::run(const CobraConfig& config,
-                          const std::string& channel,
-                          const std::string& filter,
-                          const std::string& position,
-                          bool verbose,
-                          size_t maxQueueSize,
-                          bool useQueue,
-                          bool enableHeartbeat,
-                          int runtime)
-    {
-        ix::CobraConnection conn;
-        conn.configure(config);
-        conn.connect();
-
-        Json::FastWriter jsonWriter;
-        std::atomic<uint64_t> sentCount(0);
-        std::atomic<uint64_t> receivedCount(0);
-        uint64_t sentCountTotal(0);
-        uint64_t receivedCountTotal(0);
-        uint64_t sentCountPerSecs(0);
-        uint64_t receivedCountPerSecs(0);
-        std::atomic<bool> stop(false);
-        std::atomic<bool> throttled(false);
-        std::atomic<bool> fatalCobraError(false);
-
-        QueueManager queueManager(maxQueueSize);
-
-        auto timer = [&sentCount,
-                      &receivedCount,
-                      &sentCountTotal,
-                      &receivedCountTotal,
-                      &sentCountPerSecs,
-                      &receivedCountPerSecs,
-                      &stop] {
-            while (!stop)
-            {
-                //
-                // We cannot write to sentCount and receivedCount
-                // as those are used externally, so we need to introduce
-                // our own counters
-                //
-                std::stringstream ss;
-                ss << "messages received "
-                   << receivedCountPerSecs
-                   << " "
-                   << receivedCountTotal
-                   << " sent " 
-                   << sentCountPerSecs
-                   << " "
-                   << sentCountTotal;
-                CoreLogger::info(ss.str());
-
-                receivedCountPerSecs = receivedCount - receivedCountTotal;
-                sentCountPerSecs = sentCount - receivedCountTotal;
-
-                receivedCountTotal += receivedCountPerSecs;
-                sentCountTotal += sentCountPerSecs;
-
-                auto duration = std::chrono::seconds(1);
-                std::this_thread::sleep_for(duration);
-            }
-
-            CoreLogger::info("timer thread done");
-        };
-
-        std::thread t1(timer);
-
-        auto heartbeat = [&sentCount, &receivedCount, &stop, &enableHeartbeat] {
-            std::string state("na");
-
-            if (!enableHeartbeat) return;
-
-            while (!stop)
-            {
-                std::stringstream ss;
-                ss << "messages received " << receivedCount;
-                ss << "messages sent " << sentCount;
-
-                std::string currentState = ss.str();
-
-                if (currentState == state)
-                {
-                    CoreLogger::error("no messages received or sent for 1 minute, exiting");
-                    exit(1);
-                }
-                state = currentState;
-
-                auto duration = std::chrono::minutes(1);
-                std::this_thread::sleep_for(duration);
-            }
-
-            CoreLogger::info("heartbeat thread done");
-        };
-
-        std::thread t2(heartbeat);
-
-        auto sender =
-            [this, &queueManager, verbose, &sentCount, &stop, &throttled, &fatalCobraError] {
-                while (true)
-                {
-                    auto data = queueManager.pop();
-                    Json::Value msg = data.first;
-                    std::string position = data.second;
-
-                    if (stop) break;
-                    if (msg.isNull()) continue;
-
-                    if (_onBotMessageCallback &&
-                        _onBotMessageCallback(msg, position, verbose, throttled, fatalCobraError))
-                    {
-                        // That might be too noisy
-                        if (verbose)
-                        {
-                            CoreLogger::info("cobra bot: sending succesfull");
-                        }
-                        ++sentCount;
-                    }
-                    else
-                    {
-                        CoreLogger::error("cobra bot: error sending");
-                    }
-
-                    if (stop) break;
-                }
-
-                CoreLogger::info("sender thread done");
-            };
-
-        std::thread t3(sender);
-
-        std::string subscriptionPosition(position);
-
-        conn.setEventCallback([this,
-                               &conn,
-                               &channel,
-                               &filter,
-                               &subscriptionPosition,
-                               &jsonWriter,
-                               verbose,
-                               &throttled,
-                               &receivedCount,
-                               &fatalCobraError,
-                               &useQueue,
-                               &queueManager,
-                               &sentCount](const CobraEventPtr& event) {
-            if (event->type == ix::CobraEventType::Open)
-            {
-                CoreLogger::info("Subscriber connected");
-
-                for (auto&& it : event->headers)
-                {
-                    CoreLogger::info(it.first + "::" + it.second);
-                }
-            }
-            else if (event->type == ix::CobraEventType::Closed)
-            {
-                CoreLogger::info("Subscriber closed: {}" + event->errMsg);
-            }
-            else if (event->type == ix::CobraEventType::Authenticated)
-            {
-                CoreLogger::info("Subscriber authenticated");
-                CoreLogger::info("Subscribing to " + channel);
-                CoreLogger::info("Subscribing at position " + subscriptionPosition);
-                CoreLogger::info("Subscribing with filter " + filter);
-                conn.subscribe(channel,
-                               filter,
-                               subscriptionPosition,
-                               [this,
-                                &jsonWriter,
-                                verbose,
-                                &throttled,
-                                &receivedCount,
-                                &queueManager,
-                                &useQueue,
-                                &subscriptionPosition,
-                                &fatalCobraError,
-                                &sentCount](const Json::Value& msg, const std::string& position) {
-                                   if (verbose)
-                                   {
-                                       CoreLogger::info("Subscriber received message "
-                                                        + position + " -> " + jsonWriter.write(msg));
-                                   }
-
-                                   subscriptionPosition = position;
-
-                                   // If we cannot send to sentry fast enough, drop the message
-                                   if (throttled)
-                                   {
-                                       return;
-                                   }
-
-                                   ++receivedCount;
-
-                                   if (useQueue)
-                                   {
-                                       queueManager.add(msg, position);
-                                   }
-                                   else
-                                   {
-                                       if (_onBotMessageCallback &&
-                                           _onBotMessageCallback(
-                                               msg, position, verbose, throttled, fatalCobraError))
-                                       {
-                                           // That might be too noisy
-                                           if (verbose)
-                                           {
-                                               CoreLogger::info("cobra bot: sending succesfull");
-                                           }
-                                           ++sentCount;
-                                       }
-                                       else
-                                       {
-                                           CoreLogger::error("cobra bot: error sending");
-                                       }
-                                   }
-                               });
-            }
-            else if (event->type == ix::CobraEventType::Subscribed)
-            {
-                CoreLogger::info("Subscriber: subscribed to channel " + event->subscriptionId);
-            }
-            else if (event->type == ix::CobraEventType::UnSubscribed)
-            {
-                CoreLogger::info("Subscriber: unsubscribed from channel " + event->subscriptionId);
-            }
-            else if (event->type == ix::CobraEventType::Error)
-            {
-                CoreLogger::error("Subscriber: error " + event->errMsg);
-            }
-            else if (event->type == ix::CobraEventType::Published)
-            {
-                CoreLogger::error("Published message hacked: " + std::to_string(event->msgId));
-            }
-            else if (event->type == ix::CobraEventType::Pong)
-            {
-                CoreLogger::info("Received websocket pong: " + event->errMsg);
-            }
-            else if (event->type == ix::CobraEventType::HandshakeError)
-            {
-                CoreLogger::error("Subscriber: Handshake error: " + event->errMsg);
-                fatalCobraError = true;
-            }
-            else if (event->type == ix::CobraEventType::AuthenticationError)
-            {
-                CoreLogger::error("Subscriber: Authentication error: " + event->errMsg);
-                fatalCobraError = true;
-            }
-            else if (event->type == ix::CobraEventType::SubscriptionError)
-            {
-                CoreLogger::error("Subscriber: Subscription error: " + event->errMsg);
-                fatalCobraError = true;
-            }
-        });
-
-        // Run forever
-        if (runtime == -1)
-        {
-            while (true)
-            {
-                auto duration = std::chrono::seconds(1);
-                std::this_thread::sleep_for(duration);
-
-                if (fatalCobraError) break;
-            }
-        }
-        // Run for a duration, used by unittesting now
-        else
-        {
-            for (int i = 0; i < runtime; ++i)
-            {
-                auto duration = std::chrono::seconds(1);
-                std::this_thread::sleep_for(duration);
-
-                if (fatalCobraError) break;
-            }
-        }
-
-        //
-        // Cleanup.
-        // join all the bg threads and stop them.
-        //
-        conn.disconnect();
-        stop = true;
-
-        // progress thread
-        t1.join();
-
-        // heartbeat thread
-        if (t2.joinable()) t2.join();
-
-        // sentry sender thread
-        t3.join();
-
-        return fatalCobraError ? -1 : (int64_t) sentCount;
-    }
-
-    void CobraBot::setOnBotMessageCallback(const OnBotMessageCallback& callback)
-    {
-        _onBotMessageCallback = callback;
-    }
-} // namespace ix

ixbots/ixbots/IXCobraBot.h

@@ -1,43 +0,0 @@
-/*
- *  IXCobraBot.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2020 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include <atomic>
-#include <functional>
-#include <ixcobra/IXCobraConfig.h>
-#include <json/json.h>
-#include <stddef.h>
-
-namespace ix
-{
-    using OnBotMessageCallback = std::function<bool(const Json::Value&,
-                                                    const std::string&,
-                                                    const bool verbose,
-                                                    std::atomic<bool>&,
-                                                    std::atomic<bool>&)>;
-
-    class CobraBot
-    {
-    public:
-        CobraBot() = default;
-
-        int64_t run(const CobraConfig& config,
-                    const std::string& channel,
-                    const std::string& filter,
-                    const std::string& position,
-                    bool verbose,
-                    size_t maxQueueSize,
-                    bool useQueue,
-                    bool enableHeartbeat,
-                    int runtime);
-
-        void setOnBotMessageCallback(const OnBotMessageCallback& callback);
-
-    private:
-        OnBotMessageCallback _onBotMessageCallback;
-    };
-} // namespace ix

ixbots/ixbots/IXCobraToSentryBot.cpp

@@ -1,117 +0,0 @@
-/*
- *  IXCobraToSentryBot.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXCobraToSentryBot.h"
-
-#include "IXCobraBot.h"
-#include "IXQueueManager.h"
-#include <ixcobra/IXCobraConnection.h>
-#include <ixcore/utils/IXCoreLogger.h>
-
-#include <chrono>
-#include <sstream>
-#include <vector>
-
-namespace ix
-{
-    int64_t cobra_to_sentry_bot(const CobraConfig& config,
-                                const std::string& channel,
-                                const std::string& filter,
-                                const std::string& position,
-                                SentryClient& sentryClient,
-                                bool verbose,
-                                size_t maxQueueSize,
-                                bool enableHeartbeat,
-                                int runtime)
-    {
-        CobraBot bot;
-        bot.setOnBotMessageCallback([&sentryClient](const Json::Value& msg,
-                                                    const std::string& /*position*/,
-                                                    const bool verbose,
-                                                    std::atomic<bool>& throttled,
-                                                    std::atomic<bool> &
-                                                    /*fatalCobraError*/) -> bool {
-            auto ret = sentryClient.send(msg, verbose);
-            HttpResponsePtr response = ret.first;
-
-            if (!response)
-            {
-                CoreLogger::warn("Null HTTP Response");
-                return false;
-            }
-
-            if (verbose)
-            {
-                for (auto it : response->headers)
-                {
-                    CoreLogger::info(it.first + ": " + it.second);
-                }
-
-                CoreLogger::info("Upload size: " + std::to_string(response->uploadSize));
-                CoreLogger::info("Download size: " + std::to_string(response->downloadSize));
-
-                CoreLogger::info("Status: " + std::to_string(response->statusCode));
-                if (response->errorCode != HttpErrorCode::Ok)
-                {
-                    CoreLogger::info("error message: " + response->errorMsg);
-                }
-
-                if (response->headers["Content-Type"] != "application/octet-stream")
-                {
-                    CoreLogger::info("payload: " + response->payload);
-                }
-            }
-
-            bool success = response->statusCode == 200;
-
-            if (!success)
-            {
-                CoreLogger::error("Error sending data to sentry: " + std::to_string(response->statusCode));
-                CoreLogger::error("Body: " + ret.second);
-                CoreLogger::error("Response: " + response->payload);
-
-                // Error 429 Too Many Requests
-                if (response->statusCode == 429)
-                {
-                    auto retryAfter = response->headers["Retry-After"];
-                    std::stringstream ss;
-                    ss << retryAfter;
-                    int seconds;
-                    ss >> seconds;
-
-                    if (!ss.eof() || ss.fail())
-                    {
-                        seconds = 30;
-                        CoreLogger::warn("Error parsing Retry-After header. "
-                                         "Using " + retryAfter + " for the sleep duration");
-                    }
-
-                    CoreLogger::warn("Error 429 - Too Many Requests. ws will sleep "
-                                     "and retry after " + retryAfter + " seconds");
-
-                    throttled = true;
-                    auto duration = std::chrono::seconds(seconds);
-                    std::this_thread::sleep_for(duration);
-                    throttled = false;
-                }
-            }
-
-            return success;
-        });
-
-        bool useQueue = true;
-
-        return bot.run(config,
-                       channel,
-                       filter,
-                       position,
-                       verbose,
-                       maxQueueSize,
-                       useQueue,
-                       enableHeartbeat,
-                       runtime);
-    }
-} // namespace ix

ixbots/ixbots/IXCobraToSentryBot.h

@@ -1,24 +0,0 @@
-/*
- *  IXCobraToSentryBot.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019-2020 Machine Zone, Inc. All rights reserved.
- */
-#pragma once
-
-#include <cstdint>
-#include <ixcobra/IXCobraConfig.h>
-#include <ixsentry/IXSentryClient.h>
-#include <string>
-
-namespace ix
-{
-    int64_t cobra_to_sentry_bot(const CobraConfig& config,
-                                const std::string& channel,
-                                const std::string& filter,
-                                const std::string& position,
-                                SentryClient& sentryClient,
-                                bool verbose,
-                                size_t maxQueueSize,
-                                bool enableHeartbeat,
-                                int runtime);
-} // namespace ix

ixbots/ixbots/IXCobraToStatsdBot.cpp

@@ -1,158 +0,0 @@
-/*
- *  IXCobraToStatsdBot.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXCobraToStatsdBot.h"
-
-#include "IXCobraBot.h"
-#include "IXQueueManager.h"
-#include "IXStatsdClient.h"
-#include <chrono>
-#include <ixcobra/IXCobraConnection.h>
-#include <ixcore/utils/IXCoreLogger.h>
-#include <sstream>
-#include <vector>
-
-namespace ix
-{
-    // fields are command line argument that can be specified multiple times
-    std::vector<std::string> parseFields(const std::string& fields)
-    {
-        std::vector<std::string> tokens;
-
-        // Split by \n
-        std::string token;
-        std::stringstream tokenStream(fields);
-
-        while (std::getline(tokenStream, token))
-        {
-            tokens.push_back(token);
-        }
-
-        return tokens;
-    }
-
-    //
-    // Extract an attribute from a Json Value.
-    // extractAttr("foo.bar", {"foo": {"bar": "baz"}}) => baz
-    //
-    Json::Value extractAttr(const std::string& attr, const Json::Value& jsonValue)
-    {
-        // Split by .
-        std::string token;
-        std::stringstream tokenStream(attr);
-
-        Json::Value val(jsonValue);
-
-        while (std::getline(tokenStream, token, '.'))
-        {
-            val = val[token];
-        }
-
-        return val;
-    }
-
-    int64_t cobra_to_statsd_bot(const ix::CobraConfig& config,
-                                const std::string& channel,
-                                const std::string& filter,
-                                const std::string& position,
-                                StatsdClient& statsdClient,
-                                const std::string& fields,
-                                const std::string& gauge,
-                                const std::string& timer,
-                                bool verbose,
-                                size_t maxQueueSize,
-                                bool enableHeartbeat,
-                                int runtime)
-    {
-        ix::CobraConnection conn;
-        conn.configure(config);
-        conn.connect();
-
-        auto tokens = parseFields(fields);
-
-        CobraBot bot;
-        bot.setOnBotMessageCallback(
-            [&statsdClient, &tokens, &gauge, &timer](const Json::Value& msg,
-                                                     const std::string& /*position*/,
-                                                     const bool verbose,
-                                                     std::atomic<bool>& /*throttled*/,
-                                                     std::atomic<bool>& fatalCobraError) -> bool {
-                std::string id;
-                for (auto&& attr : tokens)
-                {
-                    id += ".";
-                    auto val = extractAttr(attr, msg);
-                    id += val.asString();
-                }
-
-                if (gauge.empty() && timer.empty())
-                {
-                    statsdClient.count(id, 1);
-                }
-                else
-                {
-                    std::string attrName = (!gauge.empty()) ? gauge : timer;
-                    auto val = extractAttr(attrName, msg);
-                    size_t x;
-
-                    if (val.isInt())
-                    {
-                        x = (size_t) val.asInt();
-                    }
-                    else if (val.isInt64())
-                    {
-                        x = (size_t) val.asInt64();
-                    }
-                    else if (val.isUInt())
-                    {
-                        x = (size_t) val.asUInt();
-                    }
-                    else if (val.isUInt64())
-                    {
-                        x = (size_t) val.asUInt64();
-                    }
-                    else if (val.isDouble())
-                    {
-                        x = (size_t) val.asUInt64();
-                    }
-                    else
-                    {
-                        CoreLogger::error("Gauge " + gauge + " is not a numeric type");
-                        fatalCobraError = true;
-                        return false;
-                    }
-
-                    if (verbose)
-                    {
-                        CoreLogger::info(id + " - " + attrName + " -> " + std::to_string(x));
-                    }
-
-                    if (!gauge.empty())
-                    {
-                        statsdClient.gauge(id, x);
-                    }
-                    else
-                    {
-                        statsdClient.timing(id, x);
-                    }
-                }
-
-                return true;
-            });
-
-        bool useQueue = true;
-
-        return bot.run(config,
-                       channel,
-                       filter,
-                       position,
-                       verbose,
-                       maxQueueSize,
-                       useQueue,
-                       enableHeartbeat,
-                       runtime);
-    }
-} // namespace ix

ixbots/ixbots/IXCobraToStatsdBot.h

@@ -1,28 +0,0 @@
-/*
- *  IXCobraToStatsdBot.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019-2020 Machine Zone, Inc. All rights reserved.
- */
-#pragma once
-
-#include <cstdint>
-#include <ixbots/IXStatsdClient.h>
-#include <ixcobra/IXCobraConfig.h>
-#include <stddef.h>
-#include <string>
-
-namespace ix
-{
-    int64_t cobra_to_statsd_bot(const ix::CobraConfig& config,
-                                const std::string& channel,
-                                const std::string& filter,
-                                const std::string& position,
-                                StatsdClient& statsdClient,
-                                const std::string& fields,
-                                const std::string& gauge,
-                                const std::string& timer,
-                                bool verbose,
-                                size_t maxQueueSize,
-                                bool enableHeartbeat,
-                                int runtime);
-} // namespace ix

ixbots/ixbots/IXCobraToStdoutBot.cpp

@@ -1,107 +0,0 @@
-/*
- *  IXCobraToStdoutBot.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXCobraToStdoutBot.h"
-
-#include "IXCobraBot.h"
-#include "IXQueueManager.h"
-#include <chrono>
-#include <iostream>
-#include <sstream>
-
-namespace ix
-{
-    using StreamWriterPtr = std::unique_ptr<Json::StreamWriter>;
-
-    StreamWriterPtr makeStreamWriter()
-    {
-        Json::StreamWriterBuilder builder;
-        builder["commentStyle"] = "None";
-        builder["indentation"] = ""; // will make the JSON object compact
-        std::unique_ptr<Json::StreamWriter> jsonWriter(builder.newStreamWriter());
-        return jsonWriter;
-    }
-
-    std::string timeSinceEpoch()
-    {
-        std::chrono::system_clock::time_point tp = std::chrono::system_clock::now();
-        std::chrono::system_clock::duration dtn = tp.time_since_epoch();
-
-        std::stringstream ss;
-        ss << dtn.count() * std::chrono::system_clock::period::num /
-                  std::chrono::system_clock::period::den;
-        return ss.str();
-    }
-
-    void writeToStdout(bool fluentd,
-                       const StreamWriterPtr& jsonWriter,
-                       const Json::Value& msg,
-                       const std::string& position)
-    {
-        Json::Value enveloppe;
-        if (fluentd)
-        {
-            enveloppe["producer"] = "cobra";
-            enveloppe["consumer"] = "fluentd";
-
-            Json::Value nestedMessage(msg);
-            nestedMessage["position"] = position;
-            nestedMessage["created_at"] = timeSinceEpoch();
-            enveloppe["message"] = nestedMessage;
-
-            jsonWriter->write(enveloppe, &std::cout);
-            std::cout << std::endl; // add lf and flush
-        }
-        else
-        {
-            enveloppe = msg;
-            std::cout << position << " ";
-            jsonWriter->write(enveloppe, &std::cout);
-            std::cout << std::endl;
-        }
-    }
-
-    int64_t cobra_to_stdout_bot(const CobraConfig& config,
-                                const std::string& channel,
-                                const std::string& filter,
-                                const std::string& position,
-                                bool fluentd,
-                                bool quiet,
-                                bool verbose,
-                                size_t maxQueueSize,
-                                bool enableHeartbeat,
-                                int runtime)
-    {
-        CobraBot bot;
-        auto jsonWriter = makeStreamWriter();
-
-        bot.setOnBotMessageCallback(
-            [&fluentd, &quiet, &jsonWriter](const Json::Value& msg,
-                                            const std::string& position,
-                                            const bool /*verbose*/,
-                                            std::atomic<bool>& /*throttled*/,
-                                            std::atomic<bool> &
-                                            /*fatalCobraError*/) -> bool {
-                if (!quiet)
-                {
-                    writeToStdout(fluentd, jsonWriter, msg, position);
-                }
-                return true;
-            });
-
-        bool useQueue = false;
-
-        return bot.run(config,
-                       channel,
-                       filter,
-                       position,
-                       verbose,
-                       maxQueueSize,
-                       useQueue,
-                       enableHeartbeat,
-                       runtime);
-    }
-} // namespace ix

ixbots/ixbots/IXCobraToStdoutBot.h

@@ -1,25 +0,0 @@
-/*
- *  IXCobraToStdoutBot.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019-2020 Machine Zone, Inc. All rights reserved.
- */
-#pragma once
-
-#include <cstdint>
-#include <ixcobra/IXCobraConfig.h>
-#include <stddef.h>
-#include <string>
-
-namespace ix
-{
-    int64_t cobra_to_stdout_bot(const ix::CobraConfig& config,
-                                const std::string& channel,
-                                const std::string& filter,
-                                const std::string& position,
-                                bool fluentd,
-                                bool quiet,
-                                bool verbose,
-                                size_t maxQueueSize,
-                                bool enableHeartbeat,
-                                int runtime);
-} // namespace ix

ixbots/ixbots/IXQueueManager.cpp

@@ -1,67 +0,0 @@
-/*
- *  IXQueueManager.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXQueueManager.h"
-
-#include <algorithm>
-#include <vector>
-
-namespace ix
-{
-    std::pair<Json::Value, std::string> QueueManager::pop()
-    {
-        std::unique_lock<std::mutex> lock(_mutex);
-
-        if (_queues.empty())
-        {
-            Json::Value val;
-            return std::make_pair(val, std::string());
-        }
-
-        std::vector<std::string> games;
-        for (auto it : _queues)
-        {
-            games.push_back(it.first);
-        }
-
-        std::random_shuffle(games.begin(), games.end());
-        std::string game = games[0];
-
-        auto duration = std::chrono::seconds(1);
-        _condition.wait_for(lock, duration);
-
-        if (_queues[game].empty())
-        {
-            Json::Value val;
-            return std::make_pair(val, std::string());
-        }
-
-        auto msg = _queues[game].front();
-        _queues[game].pop();
-        return msg;
-    }
-
-    void QueueManager::add(const Json::Value& msg, const std::string& position)
-    {
-        std::unique_lock<std::mutex> lock(_mutex);
-
-        std::string game;
-        if (msg.isMember("device") && msg["device"].isMember("game"))
-        {
-            game = msg["device"]["game"].asString();
-        }
-
-        if (game.empty()) return;
-
-        // if the sending is not fast enough there is no point
-        // in queuing too many events.
-        if (_queues[game].size() < _maxQueueSize)
-        {
-            _queues[game].push(std::make_pair(msg, position));
-            _condition.notify_one();
-        }
-    }
-} // namespace ix

ixbots/ixbots/IXQueueManager.h

@@ -1,35 +0,0 @@
-/*
- *  IXQueueManager.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include <condition_variable>
-#include <json/json.h>
-#include <map>
-#include <mutex>
-#include <queue>
-#include <stddef.h>
-
-namespace ix
-{
-    class QueueManager
-    {
-    public:
-        QueueManager(size_t maxQueueSize)
-            : _maxQueueSize(maxQueueSize)
-        {
-        }
-
-        std::pair<Json::Value, std::string> pop();
-        void add(const Json::Value& msg, const std::string& position);
-
-    private:
-        std::map<std::string, std::queue<std::pair<Json::Value, std::string>>> _queues;
-        std::mutex _mutex;
-        std::condition_variable _condition;
-        size_t _maxQueueSize;
-    };
-} // namespace ix

ixbots/ixbots/IXStatsdClient.cpp

@@ -1,147 +0,0 @@
-/*
- * Copyright (c) 2014, Rex
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the {organization} nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-/*
- *  IXStatsdClient.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2020 Machine Zone, Inc. All rights reserved.
- */
-
-// Adapted from statsd-client-cpp
-// test with netcat as a server: `nc -ul 8125`
-
-#include "IXStatsdClient.h"
-
-#include <iostream>
-#include <ixwebsocket/IXNetSystem.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-
-namespace ix
-{
-    StatsdClient::StatsdClient(const std::string& host, int port, const std::string& prefix)
-        : _host(host)
-        , _port(port)
-        , _prefix(prefix)
-        , _stop(false)
-    {
-        _thread = std::thread([this] {
-            while (!_stop)
-            {
-                flushQueue();
-                std::this_thread::sleep_for(std::chrono::seconds(1));
-            }
-        });
-    }
-
-    StatsdClient::~StatsdClient()
-    {
-        _stop = true;
-        if (_thread.joinable()) _thread.join();
-
-        _socket.close();
-    }
-
-    bool StatsdClient::init(std::string& errMsg)
-    {
-        return _socket.init(_host, _port, errMsg);
-    }
-
-    /* will change the original string */
-    void StatsdClient::cleanup(std::string& key)
-    {
-        size_t pos = key.find_first_of(":|@");
-        while (pos != std::string::npos)
-        {
-            key[pos] = '_';
-            pos = key.find_first_of(":|@");
-        }
-    }
-
-    int StatsdClient::dec(const std::string& key)
-    {
-        return count(key, -1);
-    }
-
-    int StatsdClient::inc(const std::string& key)
-    {
-        return count(key, 1);
-    }
-
-    int StatsdClient::count(const std::string& key, size_t value)
-    {
-        return send(key, value, "c");
-    }
-
-    int StatsdClient::gauge(const std::string& key, size_t value)
-    {
-        return send(key, value, "g");
-    }
-
-    int StatsdClient::timing(const std::string& key, size_t ms)
-    {
-        return send(key, ms, "ms");
-    }
-
-    int StatsdClient::send(std::string key, size_t value, const std::string& type)
-    {
-        cleanup(key);
-
-        char buf[256];
-        snprintf(
-            buf, sizeof(buf), "%s%s:%zd|%s\n", _prefix.c_str(), key.c_str(), value, type.c_str());
-
-        enqueue(buf);
-        return 0;
-    }
-
-    void StatsdClient::enqueue(const std::string& message)
-    {
-        std::lock_guard<std::mutex> lock(_mutex);
-        _queue.push_back(message);
-    }
-
-    void StatsdClient::flushQueue()
-    {
-        std::lock_guard<std::mutex> lock(_mutex);
-
-        while (!_queue.empty())
-        {
-            auto message = _queue.front();
-            auto ret = _socket.sendto(message);
-            if (ret != 0)
-            {
-                std::cerr << "error: " << strerror(UdpSocket::getErrno()) << std::endl;
-            }
-            _queue.pop_front();
-        }
-    }
-} // end namespace ix

ixbots/ixbots/IXStatsdClient.h

@@ -1,57 +0,0 @@
-/*
- *  IXStatsdClient.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2020 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include <atomic>
-#include <deque>
-#include <ixwebsocket/IXUdpSocket.h>
-#include <mutex>
-#include <string>
-#include <thread>
-
-namespace ix
-{
-    class StatsdClient
-    {
-    public:
-        StatsdClient(const std::string& host = "127.0.0.1",
-                     int port = 8125,
-                     const std::string& prefix = "");
-        ~StatsdClient();
-
-        bool init(std::string& errMsg);
-        int inc(const std::string& key);
-        int dec(const std::string& key);
-        int count(const std::string& key, size_t value);
-        int gauge(const std::string& key, size_t value);
-        int timing(const std::string& key, size_t ms);
-
-    private:
-        void enqueue(const std::string& message);
-
-        /* (Low Level Api) manually send a message
-         * type = "c", "g" or "ms"
-         */
-        int send(std::string key, size_t value, const std::string& type);
-
-        void cleanup(std::string& key);
-        void flushQueue();
-
-        UdpSocket _socket;
-
-        std::string _host;
-        int _port;
-        std::string _prefix;
-
-        std::atomic<bool> _stop;
-        std::thread _thread;
-        std::mutex _mutex; // for the queue
-
-        std::deque<std::string> _queue;
-    };
-
-} // end namespace ix

ixcobra/CMakeLists.txt

@@ -1,37 +0,0 @@
-#
-# Author: Benjamin Sergeant
-# Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
-#
-
-set (IXCOBRA_SOURCES
-    ixcobra/IXCobraConnection.cpp
-    ixcobra/IXCobraMetricsThreadedPublisher.cpp
-    ixcobra/IXCobraMetricsPublisher.cpp
-)
-
-set (IXCOBRA_HEADERS
-    ixcobra/IXCobraConnection.h
-    ixcobra/IXCobraMetricsThreadedPublisher.h
-    ixcobra/IXCobraMetricsPublisher.h
-    ixcobra/IXCobraConfig.h
-    ixcobra/IXCobraEventType.h
-)
-
-add_library(ixcobra STATIC
-    ${IXCOBRA_SOURCES}
-    ${IXCOBRA_HEADERS}
-)
-
-find_package(JsonCpp)
-if (NOT JSONCPP_FOUND)
-  set(JSONCPP_INCLUDE_DIRS ../third_party/jsoncpp)
-endif()
-
-set(IXCOBRA_INCLUDE_DIRS
-    .
-    ..
-    ../ixcore
-    ../ixcrypto
-    ${JSONCPP_INCLUDE_DIRS})
-
-target_include_directories( ixcobra PUBLIC ${IXCOBRA_INCLUDE_DIRS} )

ixcobra/ixcobra/IXCobraConfig.h

@@ -1,35 +0,0 @@
-/*
- *  IXCobraConfig.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2020 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include <ixwebsocket/IXSocketTLSOptions.h>
-#include <ixwebsocket/IXWebSocketPerMessageDeflateOptions.h>
-
-namespace ix
-{
-    struct CobraConfig
-    {
-        std::string appkey;
-        std::string endpoint;
-        std::string rolename;
-        std::string rolesecret;
-        WebSocketPerMessageDeflateOptions webSocketPerMessageDeflateOptions;
-        SocketTLSOptions socketTLSOptions;
-
-        CobraConfig(const std::string& a = std::string(),
-                    const std::string& e = std::string(),
-                    const std::string& r = std::string(),
-                    const std::string& s = std::string())
-            : appkey(a)
-            , endpoint(e)
-            , rolename(r)
-            , rolesecret(s)
-        {
-            ;
-        }
-    };
-} // namespace ix

ixcobra/ixcobra/IXCobraEvent.h

@@ -1,41 +0,0 @@
-/*
- *  IXCobraEvent.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2020 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include "IXCobraEventType.h"
-#include <cstdint>
-#include <ixwebsocket/IXWebSocketHttpHeaders.h>
-#include <memory>
-#include <string>
-
-namespace ix
-{
-    struct CobraEvent
-    {
-        ix::CobraEventType type;
-        const std::string& errMsg;
-        const ix::WebSocketHttpHeaders& headers;
-        const std::string& subscriptionId;
-        uint64_t msgId; // CobraConnection::MsgId
-
-        CobraEvent(ix::CobraEventType t,
-                   const std::string& e,
-                   const ix::WebSocketHttpHeaders& h,
-                   const std::string& s,
-                   uint64_t m)
-            : type(t)
-            , errMsg(e)
-            , headers(h)
-            , subscriptionId(s)
-            , msgId(m)
-        {
-            ;
-        }
-    };
-
-    using CobraEventPtr = std::unique_ptr<CobraEvent>;
-} // namespace ix

ixcobra/ixcobra/IXCobraEventType.h

@@ -1,25 +0,0 @@
-/*
- *  IXCobraEventType.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2020 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-namespace ix
-{
-    enum class CobraEventType
-    {
-        Authenticated = 0,
-        Error = 1,
-        Open = 2,
-        Closed = 3,
-        Subscribed = 4,
-        UnSubscribed = 5,
-        Published = 6,
-        Pong = 7,
-        HandshakeError = 8,
-        AuthenticationError = 9,
-        SubscriptionError = 10
-    };
-}

ixcobra/ixcobra/IXCobraMetricsThreadedPublisher.cpp

@@ -1,230 +0,0 @@
-/*
- *  IXCobraMetricsThreadedPublisher.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017 Machine Zone. All rights reserved.
- */
-
-#include "IXCobraMetricsThreadedPublisher.h"
-
-#include <algorithm>
-#include <cassert>
-#include <cmath>
-#include <iostream>
-#include <ixcore/utils/IXCoreLogger.h>
-#include <ixwebsocket/IXSetThreadName.h>
-#include <ixwebsocket/IXSocketTLSOptions.h>
-#include <sstream>
-#include <stdexcept>
-
-
-namespace ix
-{
-    CobraMetricsThreadedPublisher::CobraMetricsThreadedPublisher()
-        : _stop(false)
-    {
-        _cobra_connection.setEventCallback([](const CobraEventPtr& event) {
-            std::stringstream ss;
-
-            if (event->type == ix::CobraEventType::Open)
-            {
-                ss << "Handshake headers" << std::endl;
-
-                for (auto&& it : event->headers)
-                {
-                    ss << it.first << ": " << it.second << std::endl;
-                }
-            }
-            else if (event->type == ix::CobraEventType::Authenticated)
-            {
-                ss << "Authenticated";
-            }
-            else if (event->type == ix::CobraEventType::Error)
-            {
-                ss << "Error: " << event->errMsg;
-            }
-            else if (event->type == ix::CobraEventType::Closed)
-            {
-                ss << "Connection closed: " << event->errMsg;
-            }
-            else if (event->type == ix::CobraEventType::Subscribed)
-            {
-                ss << "Subscribed through subscription id: " << event->subscriptionId;
-            }
-            else if (event->type == ix::CobraEventType::UnSubscribed)
-            {
-                ss << "Unsubscribed through subscription id: " << event->subscriptionId;
-            }
-            else if (event->type == ix::CobraEventType::Published)
-            {
-                ss << "Published message " << event->msgId << " acked";
-            }
-            else if (event->type == ix::CobraEventType::Pong)
-            {
-                ss << "Received websocket pong";
-            }
-            else if (event->type == ix::CobraEventType::HandshakeError)
-            {
-                ss << "Handshake error: " << event->errMsg;
-            }
-            else if (event->type == ix::CobraEventType::AuthenticationError)
-            {
-                ss << "Authentication error: " << event->errMsg;
-            }
-            else if (event->type == ix::CobraEventType::SubscriptionError)
-            {
-                ss << "Subscription error: " << event->errMsg;
-            }
-
-            CoreLogger::log(ss.str().c_str());
-        });
-    }
-
-    CobraMetricsThreadedPublisher::~CobraMetricsThreadedPublisher()
-    {
-        // The background thread won't be joinable if it was never
-        // started by calling CobraMetricsThreadedPublisher::start
-        if (!_thread.joinable()) return;
-
-        _stop = true;
-        _condition.notify_one();
-        _thread.join();
-    }
-
-    void CobraMetricsThreadedPublisher::start()
-    {
-        if (_thread.joinable()) return; // we've already been started
-
-        _thread = std::thread(&CobraMetricsThreadedPublisher::run, this);
-    }
-
-    void CobraMetricsThreadedPublisher::configure(const CobraConfig& config,
-                                                  const std::string& channel)
-    {
-        CoreLogger::log(config.socketTLSOptions.getDescription().c_str());
-
-        _channel = channel;
-        _cobra_connection.configure(config);
-    }
-
-    void CobraMetricsThreadedPublisher::pushMessage(MessageKind messageKind)
-    {
-        {
-            std::unique_lock<std::mutex> lock(_queue_mutex);
-            _queue.push(messageKind);
-        }
-
-        // wake up one thread
-        _condition.notify_one();
-    }
-
-    void CobraMetricsThreadedPublisher::setPublishMode(CobraConnectionPublishMode publishMode)
-    {
-        _cobra_connection.setPublishMode(publishMode);
-    }
-
-    bool CobraMetricsThreadedPublisher::flushQueue()
-    {
-        return _cobra_connection.flushQueue();
-    }
-
-    void CobraMetricsThreadedPublisher::run()
-    {
-        setThreadName("CobraMetricsPublisher");
-
-        _cobra_connection.connect();
-
-        while (true)
-        {
-            Json::Value msg;
-            MessageKind messageKind;
-
-            {
-                std::unique_lock<std::mutex> lock(_queue_mutex);
-
-                while (!_stop && _queue.empty())
-                {
-                    _condition.wait(lock);
-                }
-                if (_stop)
-                {
-                    _cobra_connection.disconnect();
-                    return;
-                }
-
-                messageKind = _queue.front();
-                _queue.pop();
-            }
-
-            switch (messageKind)
-            {
-                case MessageKind::Suspend:
-                {
-                    _cobra_connection.suspend();
-                    continue;
-                };
-                break;
-
-                case MessageKind::Resume:
-                {
-                    _cobra_connection.resume();
-                    continue;
-                };
-                break;
-
-                case MessageKind::Message:
-                {
-                    if (_cobra_connection.getPublishMode() == CobraConnection_PublishMode_Immediate)
-                    {
-                        _cobra_connection.publishNext();
-                    }
-                };
-                break;
-            }
-        }
-    }
-
-    CobraConnection::MsgId CobraMetricsThreadedPublisher::push(const Json::Value& msg)
-    {
-        static const std::string messageIdKey("id");
-
-        //
-        // Publish to multiple channels. This let the consumer side
-        // easily subscribe to all message of a certain type, without having
-        // to do manipulations on the messages on the server side.
-        //
-        Json::Value channels;
-
-        channels.append(_channel);
-        if (msg.isMember(messageIdKey))
-        {
-            channels.append(msg[messageIdKey]);
-        }
-        auto res = _cobra_connection.prePublish(channels, msg, true);
-        auto msgId = res.first;
-
-        pushMessage(MessageKind::Message);
-
-        return msgId;
-    }
-
-    void CobraMetricsThreadedPublisher::suspend()
-    {
-        pushMessage(MessageKind::Suspend);
-    }
-
-    void CobraMetricsThreadedPublisher::resume()
-    {
-        pushMessage(MessageKind::Resume);
-    }
-
-    bool CobraMetricsThreadedPublisher::isConnected() const
-    {
-        return _cobra_connection.isConnected();
-    }
-
-    bool CobraMetricsThreadedPublisher::isAuthenticated() const
-    {
-        return _cobra_connection.isAuthenticated();
-    }
-
-} // namespace ix

ixcore/CMakeLists.txt

@@ -1,19 +0,0 @@
-#
-# Author: Benjamin Sergeant
-# Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
-#
-
-set (IXCORE_SOURCES
-    ixcore/utils/IXCoreLogger.cpp
-)
-
-set (IXCORE_HEADERS
-    ixcore/utils/IXCoreLogger.h
-)
-
-add_library(ixcore STATIC
-    ${IXCORE_SOURCES}
-    ${IXCORE_HEADERS}
-)
-
-target_include_directories( ixcore PUBLIC . )

ixcore/ixcore/utils/IXCoreLogger.cpp

@@ -1,44 +0,0 @@
-/*
- *  IXCoreLogger.cpp
- *  Author: Thomas Wells, Benjamin Sergeant
- *  Copyright (c) 2019-2020 Machine Zone, Inc. All rights reserved.
- */
-
-#include "ixcore/utils/IXCoreLogger.h"
-
-namespace ix
-{
-    // Default do a no-op logger
-    CoreLogger::LogFunc CoreLogger::_currentLogger = [](const char*, LogLevel) {};
-
-    void CoreLogger::log(const char* msg, LogLevel level)
-    {
-        _currentLogger(msg, level);
-    }
-
-    void CoreLogger::debug(const std::string& msg)
-    {
-        _currentLogger(msg.c_str(), LogLevel::Debug);
-    }
-
-    void CoreLogger::info(const std::string& msg)
-    {
-        _currentLogger(msg.c_str(), LogLevel::Info);
-    }
-
-    void CoreLogger::warn(const std::string& msg)
-    {
-        _currentLogger(msg.c_str(), LogLevel::Warning);
-    }
-
-    void CoreLogger::error(const std::string& msg)
-    {
-        _currentLogger(msg.c_str(), LogLevel::Error);
-    }
-
-    void CoreLogger::critical(const std::string& msg)
-    {
-        _currentLogger(msg.c_str(), LogLevel::Critical);
-    }
-
-} // namespace ix

ixcore/ixcore/utils/IXCoreLogger.h

@@ -1,44 +0,0 @@
-/*
- *  IXCoreLogger.h
- *  Author: Thomas Wells, Benjamin Sergeant
- *  Copyright (c) 2019-2020 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-#include <functional>
-#include <string>
-
-namespace ix
-{
-    enum class LogLevel
-    {
-        Debug = 0,
-        Info = 1,
-        Warning = 2,
-        Error = 3,
-        Critical = 4
-    };
-
-    class CoreLogger
-    {
-    public:
-        using LogFunc = std::function<void(const char*, LogLevel level)>;
-
-        static void log(const char* msg, LogLevel level = LogLevel::Debug);
-
-        static void debug(const std::string& msg);
-        static void info(const std::string& msg);
-        static void warn(const std::string& msg);
-        static void error(const std::string& msg);
-        static void critical(const std::string& msg);
-
-        static void setLogFunction(LogFunc& func)
-        {
-            _currentLogger = func;
-        }
-
-    private:
-        static LogFunc _currentLogger;
-    };
-
-} // namespace ix

ixcrypto/CMakeLists.txt

@@ -1,49 +0,0 @@
-#
-# Author: Benjamin Sergeant
-# Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
-#
-set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../CMake;${CMAKE_MODULE_PATH}")
-
-set (IXCRYPTO_SOURCES
-    ixcrypto/IXHMac.cpp
-    ixcrypto/IXBase64.cpp
-    ixcrypto/IXUuid.cpp
-    ixcrypto/IXHash.cpp
-)
-
-set (IXCRYPTO_HEADERS
-    ixcrypto/IXHMac.h
-    ixcrypto/IXBase64.h
-    ixcrypto/IXUuid.h
-    ixcrypto/IXHash.h
-)
-
-add_library(ixcrypto STATIC
-    ${IXCRYPTO_SOURCES}
-    ${IXCRYPTO_HEADERS}
-)
-
-set(IXCRYPTO_INCLUDE_DIRS
-    .
-    ../ixcore)
-
-target_include_directories( ixcrypto PUBLIC ${IXCRYPTO_INCLUDE_DIRS} )
-
-# hmac computation needs a crypto library
-
-target_compile_definitions(ixcrypto PUBLIC IXCRYPTO_USE_TLS)
-if (USE_MBED_TLS)
-    find_package(MbedTLS REQUIRED)
-    target_include_directories(ixcrypto PUBLIC ${MBEDTLS_INCLUDE_DIRS})
-    target_link_libraries(ixcrypto ${MBEDTLS_LIBRARIES})
-    target_compile_definitions(ixcrypto PUBLIC IXCRYPTO_USE_MBED_TLS)
-elseif (APPLE)
-elseif (WIN32)
-else()
-    find_package(OpenSSL REQUIRED)
-    add_definitions(${OPENSSL_DEFINITIONS})
-    message(STATUS "OpenSSL: " ${OPENSSL_VERSION})
-    include_directories(${OPENSSL_INCLUDE_DIR})
-    target_link_libraries(ixcrypto ${OPENSSL_LIBRARIES})
-    target_compile_definitions(ixcrypto PUBLIC IXCRYPTO_USE_OPEN_SSL)
-endif()

ixcrypto/ixcrypto/IXHMac.cpp

@@ -1,53 +0,0 @@
-/*
- *  IXHMac.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 Machine Zone. All rights reserved.
- */
-
-#include "IXHMac.h"
-
-#include "IXBase64.h"
-
-#if defined(IXCRYPTO_USE_MBED_TLS)
-#include <mbedtls/md.h>
-#elif defined(__APPLE__)
-#include <CommonCrypto/CommonHMAC.h>
-#elif defined(IXCRYPTO_USE_OPEN_SSL)
-#include <openssl/hmac.h>
-#else
-#include <assert.h>
-#endif
-
-namespace ix
-{
-    std::string hmac(const std::string& data, const std::string& key)
-    {
-        constexpr size_t hashSize = 16;
-        unsigned char hash[hashSize];
-
-#if defined(IXCRYPTO_USE_MBED_TLS)
-        mbedtls_md_hmac(mbedtls_md_info_from_type(MBEDTLS_MD_MD5),
-                        (unsigned char*) key.c_str(),
-                        key.size(),
-                        (unsigned char*) data.c_str(),
-                        data.size(),
-                        (unsigned char*) &hash);
-#elif defined(__APPLE__)
-        CCHmac(kCCHmacAlgMD5, key.c_str(), key.size(), data.c_str(), data.size(), &hash);
-#elif defined(IXCRYPTO_USE_OPEN_SSL)
-        HMAC(EVP_md5(),
-             key.c_str(),
-             (int) key.size(),
-             (unsigned char*) data.c_str(),
-             (int) data.size(),
-             (unsigned char*) hash,
-             nullptr);
-#else
-        assert(false && "hmac not implemented on this platform");
-#endif
-
-        std::string hashString(reinterpret_cast<char*>(hash), hashSize);
-
-        return base64_encode(hashString, (uint32_t) hashString.size());
-    }
-} // namespace ix

ixsentry/CMakeLists.txt

@@ -1,30 +0,0 @@
-#
-# Author: Benjamin Sergeant
-# Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
-#
-
-set (IXSENTRY_SOURCES
-    ixsentry/IXSentryClient.cpp
-)
-
-set (IXSENTRY_HEADERS
-    ixsentry/IXSentryClient.h
-)
-
-add_library(ixsentry STATIC
-  ${IXSENTRY_SOURCES}
-  ${IXSENTRY_HEADERS}
-)
-
-find_package(JsonCpp)
-if (NOT JSONCPP_FOUND)
-  set(JSONCPP_INCLUDE_DIRS ../third_party/jsoncpp)
-endif()
-
-set(IXSENTRY_INCLUDE_DIRS
-    .
-    ..
-    ../ixcore
-    ${JSONCPP_INCLUDE_DIRS})
-
-target_include_directories( ixsentry PUBLIC ${IXSENTRY_INCLUDE_DIRS} )

ixsentry/ixsentry/IXSentryClient.cpp

@@ -1,307 +0,0 @@
-/*
- *  IXSentryClient.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone. All rights reserved.
- */
-
-#include "IXSentryClient.h"
-
-#include <chrono>
-#include <fstream>
-#include <iostream>
-#include <ixcore/utils/IXCoreLogger.h>
-#include <ixwebsocket/IXWebSocketHttpHeaders.h>
-#include <ixwebsocket/IXWebSocketVersion.h>
-#include <sstream>
-
-
-namespace ix
-{
-    SentryClient::SentryClient(const std::string& dsn)
-        : _dsn(dsn)
-        , _validDsn(false)
-        , _luaFrameRegex("\t([^/]+):([0-9]+): in function ['<]([^/]+)['>]")
-        , _httpClient(std::make_shared<HttpClient>(true))
-    {
-        const std::regex dsnRegex("(http[s]?)://([^:]+):([^@]+)@([^/]+)/([0-9]+)");
-        std::smatch group;
-
-        if (std::regex_match(dsn, group, dsnRegex) && group.size() == 6)
-        {
-            _validDsn = true;
-
-            const auto scheme = group.str(1);
-            const auto host = group.str(4);
-            const auto project_id = group.str(5);
-            _url = scheme + "://" + host + "/api/" + project_id + "/store/";
-
-            _publicKey = group.str(2);
-            _secretKey = group.str(3);
-        }
-    }
-
-    void SentryClient::setTLSOptions(const SocketTLSOptions& tlsOptions)
-    {
-        _httpClient->setTLSOptions(tlsOptions);
-    }
-
-    int64_t SentryClient::getTimestamp()
-    {
-        const auto tp = std::chrono::system_clock::now();
-        const auto dur = tp.time_since_epoch();
-        return std::chrono::duration_cast<std::chrono::seconds>(dur).count();
-    }
-
-    std::string SentryClient::getIso8601()
-    {
-        std::time_t now;
-        std::time(&now);
-        char buf[sizeof("2011-10-08T07:07:09Z")];
-        std::strftime(buf, sizeof(buf), "%Y-%m-%dT%H:%M:%SZ", std::gmtime(&now));
-        return buf;
-    }
-
-    std::string SentryClient::computeAuthHeader()
-    {
-        std::string securityHeader("Sentry sentry_version=5");
-        securityHeader += ",sentry_client=ws/";
-        securityHeader += std::string(IX_WEBSOCKET_VERSION);
-        securityHeader += ",sentry_timestamp=" + std::to_string(SentryClient::getTimestamp());
-        securityHeader += ",sentry_key=" + _publicKey;
-        securityHeader += ",sentry_secret=" + _secretKey;
-
-        return securityHeader;
-    }
-
-    Json::Value SentryClient::parseLuaStackTrace(const std::string& stack)
-    {
-        Json::Value frames;
-
-        // Split by lines
-        std::string line;
-        std::stringstream tokenStream(stack);
-
-        std::smatch group;
-
-        while (std::getline(tokenStream, line))
-        {
-            //	MapScene.lua:2169: in function 'singleCB'
-            if (std::regex_match(line, group, _luaFrameRegex))
-            {
-                const auto fileName = group.str(1);
-                const auto linenoStr = group.str(2);
-                const auto function = group.str(3);
-
-                std::stringstream ss;
-                ss << linenoStr;
-                uint64_t lineno;
-                ss >> lineno;
-
-                Json::Value frame;
-                frame["lineno"] = Json::UInt64(lineno);
-                frame["filename"] = fileName;
-                frame["function"] = function;
-
-                frames.append(frame);
-            }
-        }
-
-        std::reverse(frames.begin(), frames.end());
-
-        return frames;
-    }
-
-    std::string parseExceptionName(const std::string& stack)
-    {
-        // Split by lines
-        std::string line;
-        std::stringstream tokenStream(stack);
-
-        // Extract the first line
-        std::getline(tokenStream, line);
-
-        return line;
-    }
-
-    std::string SentryClient::computePayload(const Json::Value& msg)
-    {
-        Json::Value payload;
-
-        //
-        // "tags": [
-        //   [
-        //     "a",
-        //     "b"
-        //   ],
-        //  ]
-        //
-        Json::Value tags(Json::arrayValue);
-
-        payload["platform"] = "python";
-        payload["sdk"]["name"] = "ws";
-        payload["sdk"]["version"] = IX_WEBSOCKET_VERSION;
-        payload["timestamp"] = SentryClient::getIso8601();
-
-        bool isNoisyTypes = msg["id"].asString() == "game_noisytypes_id";
-
-        std::string stackTraceFieldName = isNoisyTypes ? "traceback" : "stack";
-        std::string stack;
-        std::string message;
-
-        if (isNoisyTypes)
-        {
-            stack = msg["data"][stackTraceFieldName].asString();
-            message = parseExceptionName(stack);
-        }
-        else // logging
-        {
-            if (msg["data"].isMember("info"))
-            {
-                stack = msg["data"]["info"][stackTraceFieldName].asString();
-                message = msg["data"]["info"]["message"].asString();
-
-                if (msg["data"].isMember("tags"))
-                {
-                    auto members = msg["data"]["tags"].getMemberNames();
-
-                    for (auto member : members)
-                    {
-                        Json::Value tag;
-                        tag.append(member);
-                        tag.append(msg["data"]["tags"][member]);
-                        tags.append(tag);
-                    }
-                }
-
-                if (msg["data"]["info"].isMember("level_str"))
-                {
-                    // https://docs.sentry.io/enriching-error-data/context/?platform=python#setting-the-level
-                    std::string level = msg["data"]["info"]["level_str"].asString();
-                    if (level == "critical")
-                    {
-                        level = "fatal";
-                    }
-                    payload["level"] = level;
-                }
-            }
-            else
-            {
-                stack = msg["data"][stackTraceFieldName].asString();
-                message = msg["data"]["message"].asString();
-            }
-        }
-
-        Json::Value exception;
-        exception["stacktrace"]["frames"] = parseLuaStackTrace(stack);
-        exception["value"] = message;
-
-        payload["exception"].append(exception);
-
-        Json::Value extra;
-        extra["cobra_event"] = msg;
-
-        // Builtin tags
-        Json::Value gameTag;
-        gameTag.append("game");
-        gameTag.append(msg["device"]["game"]);
-        tags.append(gameTag);
-
-        Json::Value userIdTag;
-        userIdTag.append("userid");
-        userIdTag.append(msg["device"]["user_id"]);
-        tags.append(userIdTag);
-
-        Json::Value environmentTag;
-        environmentTag.append("environment");
-        environmentTag.append(msg["device"]["environment"]);
-        tags.append(environmentTag);
-
-        Json::Value clientVersionTag;
-        clientVersionTag.append("client_version");
-        clientVersionTag.append(msg["device"]["app_version"]);
-        tags.append(clientVersionTag);
-
-        payload["tags"] = tags;
-
-        return _jsonWriter.write(payload);
-    }
-
-    std::pair<HttpResponsePtr, std::string> SentryClient::send(const Json::Value& msg, bool verbose)
-    {
-        auto args = _httpClient->createRequest();
-        args->extraHeaders["X-Sentry-Auth"] = SentryClient::computeAuthHeader();
-        args->connectTimeout = 60;
-        args->transferTimeout = 5 * 60;
-        args->followRedirects = true;
-        args->verbose = verbose;
-        args->logger = [](const std::string& msg) { CoreLogger::log(msg.c_str()); };
-
-        std::string body = computePayload(msg);
-        HttpResponsePtr response = _httpClient->post(_url, body, args);
-
-        return std::make_pair(response, body);
-    }
-
-    // https://sentry.io/api/12345/minidump?sentry_key=abcdefgh");
-    std::string SentryClient::computeUrl(const std::string& project, const std::string& key)
-    {
-        std::stringstream ss;
-        ss << "https://sentry.io/api/" << project << "/minidump?sentry_key=" << key;
-
-        return ss.str();
-    }
-
-    //
-    // curl -v -X POST -F upload_file_minidump=@ws/crash.dmp
-    // 'https://sentry.io/api/123456/minidump?sentry_key=12344567890'
-    //
-    void SentryClient::uploadMinidump(const std::string& sentryMetadata,
-                                      const std::string& minidumpBytes,
-                                      const std::string& project,
-                                      const std::string& key,
-                                      bool verbose,
-                                      const OnResponseCallback& onResponseCallback)
-    {
-        std::string multipartBoundary = _httpClient->generateMultipartBoundary();
-
-        auto args = _httpClient->createRequest();
-        args->verb = HttpClient::kPost;
-        args->connectTimeout = 60;
-        args->transferTimeout = 5 * 60;
-        args->followRedirects = true;
-        args->verbose = verbose;
-        args->multipartBoundary = multipartBoundary;
-        args->logger = [](const std::string& msg) { CoreLogger::log(msg.c_str()); };
-
-        HttpFormDataParameters httpFormDataParameters;
-        httpFormDataParameters["upload_file_minidump"] = minidumpBytes;
-
-        HttpParameters httpParameters;
-        httpParameters["sentry"] = sentryMetadata;
-
-        args->url = computeUrl(project, key);
-        args->body = _httpClient->serializeHttpFormDataParameters(
-            multipartBoundary, httpFormDataParameters, httpParameters);
-
-        _httpClient->performRequest(args, onResponseCallback);
-    }
-
-    void SentryClient::uploadPayload(const Json::Value& payload,
-                                     bool verbose,
-                                     const OnResponseCallback& onResponseCallback)
-    {
-        auto args = _httpClient->createRequest();
-        args->extraHeaders["X-Sentry-Auth"] = SentryClient::computeAuthHeader();
-        args->verb = HttpClient::kPost;
-        args->connectTimeout = 60;
-        args->transferTimeout = 5 * 60;
-        args->followRedirects = true;
-        args->verbose = verbose;
-        args->logger = [](const std::string& msg) { CoreLogger::log(msg.c_str()); };
-
-        args->url = _url;
-        args->body = _jsonWriter.write(payload);
-
-        _httpClient->performRequest(args, onResponseCallback);
-    }
-} // namespace ix

ixsnake/CMakeLists.txt

@@ -1,35 +0,0 @@
-#
-# Author: Benjamin Sergeant
-# Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
-#
-
-set (IXSNAKE_SOURCES
-    ixsnake/IXSnakeServer.cpp
-    ixsnake/IXSnakeProtocol.cpp
-    ixsnake/IXAppConfig.cpp
-    ixsnake/IXRedisClient.cpp
-    ixsnake/IXRedisServer.cpp
-)
-
-set (IXSNAKE_HEADERS
-    ixsnake/IXSnakeServer.h
-    ixsnake/IXSnakeProtocol.h
-    ixsnake/IXAppConfig.h
-    ixsnake/IXRedisClient.h
-    ixsnake/IXRedisServer.h
-)
-
-add_library(ixsnake STATIC
-    ${IXSNAKE_SOURCES}
-    ${IXSNAKE_HEADERS}
-)
-
-set(IXSNAKE_INCLUDE_DIRS
-    .
-    ..
-    ../ixcore
-    ../ixcrypto
-    ../ixwebsocket
-    ../third_party)
-
-target_include_directories( ixsnake PUBLIC ${IXSNAKE_INCLUDE_DIRS} )

ixsnake/ixsnake/IXRedisServer.cpp

@@ -1,285 +0,0 @@
-/*
- *  IXRedisServer.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXRedisServer.h"
-
-#include <fstream>
-#include <ixwebsocket/IXCancellationRequest.h>
-#include <ixwebsocket/IXNetSystem.h>
-#include <ixwebsocket/IXSocket.h>
-#include <ixwebsocket/IXSocketConnect.h>
-#include <sstream>
-#include <vector>
-
-namespace ix
-{
-    RedisServer::RedisServer(
-        int port, const std::string& host, int backlog, size_t maxConnections, int addressFamily)
-        : SocketServer(port, host, backlog, maxConnections, addressFamily)
-        , _connectedClientsCount(0)
-        , _stopHandlingConnections(false)
-    {
-        ;
-    }
-
-    RedisServer::~RedisServer()
-    {
-        stop();
-    }
-
-    void RedisServer::stop()
-    {
-        stopAcceptingConnections();
-
-        _stopHandlingConnections = true;
-        while (_connectedClientsCount != 0)
-        {
-            std::this_thread::sleep_for(std::chrono::milliseconds(10));
-        }
-        _stopHandlingConnections = false;
-
-        SocketServer::stop();
-    }
-
-    void RedisServer::handleConnection(std::unique_ptr<Socket> socket,
-                                       std::shared_ptr<ConnectionState> connectionState)
-    {
-        _connectedClientsCount++;
-
-        while (!_stopHandlingConnections)
-        {
-            std::vector<std::string> tokens;
-            if (!parseRequest(socket, tokens))
-            {
-                if (_stopHandlingConnections)
-                {
-                    logError("Cancellation requested");
-                }
-                else
-                {
-                    logError("Error parsing request");
-                }
-                break;
-            }
-
-            bool success = false;
-
-            // publish
-            if (tokens[0] == "COMMAND")
-            {
-                success = handleCommand(socket, tokens);
-            }
-            else if (tokens[0] == "PUBLISH")
-            {
-                success = handlePublish(socket, tokens);
-            }
-            else if (tokens[0] == "SUBSCRIBE")
-            {
-                success = handleSubscribe(socket, tokens);
-            }
-
-            if (!success)
-            {
-                if (_stopHandlingConnections)
-                {
-                    logError("Cancellation requested");
-                }
-                else
-                {
-                    logError("Error processing request for command: " + tokens[0]);
-                }
-                break;
-            }
-        }
-
-        cleanupSubscribers(socket);
-
-        logInfo("Connection closed for connection id " + connectionState->getId());
-        connectionState->setTerminated();
-
-        _connectedClientsCount--;
-    }
-
-    void RedisServer::cleanupSubscribers(std::unique_ptr<Socket>& socket)
-    {
-        std::lock_guard<std::mutex> lock(_mutex);
-
-        for (auto&& it : _subscribers)
-        {
-            it.second.erase(socket.get());
-        }
-
-        for (auto it : _subscribers)
-        {
-            std::stringstream ss;
-            ss << "Subscription id: " << it.first << " #subscribers: " << it.second.size();
-
-            logInfo(ss.str());
-        }
-    }
-
-    size_t RedisServer::getConnectedClientsCount()
-    {
-        return _connectedClientsCount;
-    }
-
-    bool RedisServer::startsWith(const std::string& str, const std::string& start)
-    {
-        return str.compare(0, start.length(), start) == 0;
-    }
-
-    std::string RedisServer::writeString(const std::string& str)
-    {
-        std::stringstream ss;
-        ss << "$";
-        ss << str.size();
-        ss << "\r\n";
-        ss << str;
-        ss << "\r\n";
-
-        return ss.str();
-    }
-
-    bool RedisServer::parseRequest(std::unique_ptr<Socket>& socket,
-                                   std::vector<std::string>& tokens)
-    {
-        // Parse first line
-        auto cb = makeCancellationRequestWithTimeout(30, _stopHandlingConnections);
-        auto lineResult = socket->readLine(cb);
-        auto lineValid = lineResult.first;
-        auto line = lineResult.second;
-
-        if (!lineValid) return false;
-
-        std::string str = line.substr(1);
-        std::stringstream ss;
-        ss << str;
-        int count;
-        ss >> count;
-
-        for (int i = 0; i < count; ++i)
-        {
-            auto lineResult = socket->readLine(cb);
-            auto lineValid = lineResult.first;
-            auto line = lineResult.second;
-
-            if (!lineValid) return false;
-
-            int stringSize;
-            std::stringstream ss;
-            ss << line.substr(1, line.size() - 1);
-            ss >> stringSize;
-
-            auto readResult = socket->readBytes(stringSize, nullptr, nullptr);
-
-            if (!readResult.first) return false;
-
-            // read last 2 bytes (\r\n)
-            char c;
-            socket->readByte(&c, nullptr);
-            socket->readByte(&c, nullptr);
-
-            tokens.push_back(readResult.second);
-        }
-
-        return true;
-    }
-
-    bool RedisServer::handleCommand(std::unique_ptr<Socket>& socket,
-                                    const std::vector<std::string>& tokens)
-    {
-        if (tokens.size() != 1) return false;
-
-        auto cb = makeCancellationRequestWithTimeout(30, _stopHandlingConnections);
-        std::stringstream ss;
-
-        // return 2 nested arrays
-        ss << "*2\r\n";
-
-        //
-        // publish
-        //
-        ss << "*6\r\n";
-        ss << writeString("publish"); // 1
-        ss << ":3\r\n";               // 2
-        ss << "*0\r\n";               // 3
-        ss << ":1\r\n";               // 4
-        ss << ":2\r\n";               // 5
-        ss << ":1\r\n";               // 6
-
-        //
-        // subscribe
-        //
-        ss << "*6\r\n";
-        ss << writeString("subscribe"); // 1
-        ss << ":2\r\n";                 // 2
-        ss << "*0\r\n";                 // 3
-        ss << ":1\r\n";                 // 4
-        ss << ":1\r\n";                 // 5
-        ss << ":1\r\n";                 // 6
-
-        socket->writeBytes(ss.str(), cb);
-
-        return true;
-    }
-
-    bool RedisServer::handleSubscribe(std::unique_ptr<Socket>& socket,
-                                      const std::vector<std::string>& tokens)
-    {
-        if (tokens.size() != 2) return false;
-
-        auto cb = makeCancellationRequestWithTimeout(30, _stopHandlingConnections);
-        std::string channel = tokens[1];
-
-        // Respond
-        socket->writeBytes("*3\r\n", cb);
-        socket->writeBytes(writeString("subscribe"), cb);
-        socket->writeBytes(writeString(channel), cb);
-        socket->writeBytes(":1\r\n", cb);
-
-        std::lock_guard<std::mutex> lock(_mutex);
-        _subscribers[channel].insert(socket.get());
-
-        return true;
-    }
-
-    bool RedisServer::handlePublish(std::unique_ptr<Socket>& socket,
-                                    const std::vector<std::string>& tokens)
-    {
-        if (tokens.size() != 3) return false;
-
-        auto cb = makeCancellationRequestWithTimeout(30, _stopHandlingConnections);
-        std::string channel = tokens[1];
-        std::string data = tokens[2];
-
-        // now dispatch the message to subscribers (write custom method)
-        std::lock_guard<std::mutex> lock(_mutex);
-        auto it = _subscribers.find(channel);
-        if (it == _subscribers.end())
-        {
-            // return the number of clients that received the message, 0 in that case
-            socket->writeBytes(":0\r\n", cb);
-            return true;
-        }
-
-        auto subscribers = it->second;
-        for (auto jt : subscribers)
-        {
-            jt->writeBytes("*3\r\n", cb);
-            jt->writeBytes(writeString("message"), cb);
-            jt->writeBytes(writeString(channel), cb);
-            jt->writeBytes(writeString(data), cb);
-        }
-
-        // return the number of clients that received the message.
-        std::stringstream ss;
-        ss << ":" << std::to_string(subscribers.size()) << "\r\n";
-        socket->writeBytes(ss.str(), cb);
-
-        return true;
-    }
-
-} // namespace ix

ixsnake/ixsnake/IXRedisServer.h

@@ -1,64 +0,0 @@
-/*
- *  IXRedisServer.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include "IXSocket.h"
-#include "IXSocketServer.h"
-#include <functional>
-#include <map>
-#include <memory>
-#include <mutex>
-#include <set>
-#include <string>
-#include <thread>
-#include <utility> // pair
-
-namespace ix
-{
-    class RedisServer final : public SocketServer
-    {
-    public:
-        RedisServer(int port = SocketServer::kDefaultPort,
-                    const std::string& host = SocketServer::kDefaultHost,
-                    int backlog = SocketServer::kDefaultTcpBacklog,
-                    size_t maxConnections = SocketServer::kDefaultMaxConnections,
-                    int addressFamily = SocketServer::kDefaultAddressFamily);
-        virtual ~RedisServer();
-        virtual void stop() final;
-
-    private:
-        // Member variables
-        std::atomic<int> _connectedClientsCount;
-
-        // Subscribers
-        // We could store connection states in there, to add better debugging
-        // since a connection state has a readable ID
-        std::map<std::string, std::set<Socket*>> _subscribers;
-        std::mutex _mutex;
-
-        std::atomic<bool> _stopHandlingConnections;
-
-        // Methods
-        virtual void handleConnection(std::unique_ptr<Socket>,
-                                      std::shared_ptr<ConnectionState> connectionState) final;
-        virtual size_t getConnectedClientsCount() final;
-
-        bool startsWith(const std::string& str, const std::string& start);
-        std::string writeString(const std::string& str);
-
-        bool parseRequest(std::unique_ptr<Socket>& socket, std::vector<std::string>& tokens);
-
-        bool handlePublish(std::unique_ptr<Socket>& socket, const std::vector<std::string>& tokens);
-
-        bool handleSubscribe(std::unique_ptr<Socket>& socket,
-                             const std::vector<std::string>& tokens);
-
-        bool handleCommand(std::unique_ptr<Socket>& socket, const std::vector<std::string>& tokens);
-
-        void cleanupSubscribers(std::unique_ptr<Socket>& socket);
-    };
-} // namespace ix

ixsnake/ixsnake/IXSnakeConnectionState.h

@@ -1,61 +0,0 @@
-/*
- *  IXSnakeConnectionState.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include "IXRedisClient.h"
-#include <future>
-#include <ixwebsocket/IXConnectionState.h>
-#include <string>
-
-namespace snake
-{
-    class SnakeConnectionState : public ix::ConnectionState
-    {
-    public:
-        std::string getNonce()
-        {
-            return _nonce;
-        }
-
-        void setNonce(const std::string& nonce)
-        {
-            _nonce = nonce;
-        }
-
-        std::string appkey()
-        {
-            return _appkey;
-        }
-        void setAppkey(const std::string& appkey)
-        {
-            _appkey = appkey;
-        }
-
-        std::string role()
-        {
-            return _role;
-        }
-        void setRole(const std::string& role)
-        {
-            _role = role;
-        }
-
-        ix::RedisClient& redisClient()
-        {
-            return _redisClient;
-        }
-
-        std::future<void> fut;
-
-    private:
-        std::string _nonce;
-        std::string _role;
-        std::string _appkey;
-
-        ix::RedisClient _redisClient;
-    };
-} // namespace snake

ixwebsocket/IXBench.cpp

@@ -1,44 +0,0 @@
-/*
- *  IXBench.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017-2020 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXBench.h"
-
-#include <iostream>
-
-namespace ix
-{
-    Bench::Bench(const std::string& description)
-        : _description(description)
-        , _start(std::chrono::high_resolution_clock::now())
-        , _reported(false)
-    {
-        ;
-    }
-
-    Bench::~Bench()
-    {
-        if (!_reported)
-        {
-            report();
-        }
-    }
-
-    void Bench::report()
-    {
-        auto now = std::chrono::high_resolution_clock::now();
-        auto milliseconds = std::chrono::duration_cast<std::chrono::milliseconds>(now - _start);
-
-        _ms = milliseconds.count();
-        std::cerr << _description << " completed in " << _ms << "ms" << std::endl;
-
-        _reported = true;
-    }
-
-    uint64_t Bench::getDuration() const
-    {
-        return _ms;
-    }
-} // namespace ix

ixwebsocket/IXBench.h

@@ -1,28 +0,0 @@
-/*
- *  IXBench.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017-2020 Machine Zone, Inc. All rights reserved.
- */
-
-#include <chrono>
-#include <stdint.h>
-#include <string>
-
-namespace ix
-{
-    class Bench
-    {
-    public:
-        Bench(const std::string& description);
-        ~Bench();
-
-        void report();
-        uint64_t getDuration() const;
-
-    private:
-        std::string _description;
-        std::chrono::time_point<std::chrono::high_resolution_clock> _start;
-        uint64_t _ms;
-        bool _reported;
-    };
-} // namespace ix

ixwebsocket/IXCancellationRequest.cpp

@@ -10,13 +10,14 @@
 
 namespace ix
 {
-    CancellationRequest makeCancellationRequestWithTimeout(
-        int secs, std::atomic<bool>& requestInitCancellation)
+    CancellationRequest makeCancellationRequestWithTimeout(int secs,
+                                                           std::atomic<bool>& requestInitCancellation)
     {
         auto start = std::chrono::system_clock::now();
         auto timeout = std::chrono::seconds(secs);
 
-        auto isCancellationRequested = [&requestInitCancellation, start, timeout]() -> bool {
+        auto isCancellationRequested = [&requestInitCancellation, start, timeout]() -> bool
+        {
             // Was an explicit cancellation requested ?
             if (requestInitCancellation) return true;
 
@@ -29,4 +30,4 @@ namespace ix
 
         return isCancellationRequested;
     }
-} // namespace ix
+}

ixwebsocket/IXConnectionState.cpp

@@ -10,8 +10,7 @@ namespace ix
 {
     std::atomic<uint64_t> ConnectionState::_globalId(0);
 
-    ConnectionState::ConnectionState()
-        : _terminated(false)
+    ConnectionState::ConnectionState() : _terminated(false)
     {
         computeId();
     }
@@ -40,4 +39,5 @@ namespace ix
     {
         _terminated = true;
     }
-} // namespace ix
+}
+

ixwebsocket/IXDNSLookup.cpp

@@ -5,22 +5,22 @@
  */
 
 #include "IXDNSLookup.h"
-
 #include "IXNetSystem.h"
-#include <chrono>
+
 #include <string.h>
+#include <chrono>
 #include <thread>
 
 namespace ix
 {
     const int64_t DNSLookup::kDefaultWait = 1; // ms
 
-    DNSLookup::DNSLookup(const std::string& hostname, int port, int64_t wait)
-        : _hostname(hostname)
-        , _port(port)
-        , _wait(wait)
-        , _res(nullptr)
-        , _done(false)
+    DNSLookup::DNSLookup(const std::string& hostname, int port, int64_t wait) :
+        _hostname(hostname),
+        _port(port),
+        _wait(wait),
+        _res(nullptr),
+        _done(false)
     {
         ;
     }
@@ -38,7 +38,8 @@ namespace ix
         std::string sport = std::to_string(port);
 
         struct addrinfo* res;
-        int getaddrinfo_result = getaddrinfo(hostname.c_str(), sport.c_str(), &hints, &res);
+        int getaddrinfo_result = getaddrinfo(hostname.c_str(), sport.c_str(),
+                                             &hints, &res);
         if (getaddrinfo_result)
         {
             errMsg = gai_strerror(getaddrinfo_result);
@@ -55,13 +56,13 @@ namespace ix
                            : resolveUnCancellable(errMsg, isCancellationRequested);
     }
 
-    struct addrinfo* DNSLookup::resolveUnCancellable(
-        std::string& errMsg, const CancellationRequest& isCancellationRequested)
+    struct addrinfo* DNSLookup::resolveUnCancellable(std::string& errMsg,
+                                                     const CancellationRequest& isCancellationRequested)
     {
         errMsg = "no error";
 
         // Maybe a cancellation request got in before the background thread terminated ?
-        if (isCancellationRequested())
+        if (isCancellationRequested && isCancellationRequested())
         {
             errMsg = "cancellation requested";
             return nullptr;
@@ -70,8 +71,8 @@ namespace ix
         return getAddrInfo(_hostname, _port, errMsg);
     }
 
-    struct addrinfo* DNSLookup::resolveCancellable(
-        std::string& errMsg, const CancellationRequest& isCancellationRequested)
+    struct addrinfo* DNSLookup::resolveCancellable(std::string& errMsg,
+                                                   const CancellationRequest& isCancellationRequested)
     {
         errMsg = "no error";
 
@@ -93,7 +94,7 @@ namespace ix
         int port = _port;
         std::string hostname(_hostname);
 
-        // We make the background thread doing the work a shared pointer
+        // We make the background thread doing the work a shared pointer 
         // instead of a member variable, because it can keep running when
         // this object goes out of scope, in case of cancellation
         auto t = std::make_shared<std::thread>(&DNSLookup::run, this, self, hostname, port);
@@ -107,7 +108,7 @@ namespace ix
             std::this_thread::sleep_for(std::chrono::milliseconds(_wait));
 
             // Were we cancelled ?
-            if (isCancellationRequested())
+            if (isCancellationRequested && isCancellationRequested())
             {
                 errMsg = "cancellation requested";
                 return nullptr;
@@ -115,7 +116,7 @@ namespace ix
         }
 
         // Maybe a cancellation request got in before the bg terminated ?
-        if (isCancellationRequested())
+        if (isCancellationRequested && isCancellationRequested())
         {
             errMsg = "cancellation requested";
             return nullptr;
@@ -125,9 +126,7 @@ namespace ix
         return getRes();
     }
 
-    void DNSLookup::run(std::weak_ptr<DNSLookup> self,
-                        std::string hostname,
-                        int port) // thread runner
+    void DNSLookup::run(std::weak_ptr<DNSLookup> self, std::string hostname, int port) // thread runner
     {
         // We don't want to read or write into members variables of an object that could be
         // gone, so we use temporary variables (res) or we pass in by copy everything that
@@ -135,7 +134,7 @@ namespace ix
         std::string errMsg;
         struct addrinfo* res = getAddrInfo(hostname, port, errMsg);
 
-        if (auto lock = self.lock())
+        if (self.lock())
         {
             // Copy result into the member variables
             setRes(res);
@@ -168,4 +167,4 @@ namespace ix
         std::lock_guard<std::mutex> lock(_resMutex);
         return _res;
     }
-} // namespace ix
+}

ixwebsocket/IXExponentialBackoff.cpp

@@ -10,10 +10,11 @@
 
 namespace ix
 {
-    uint32_t calculateRetryWaitMilliseconds(uint32_t retry_count,
-                                            uint32_t maxWaitBetweenReconnectionRetries)
+    uint32_t calculateRetryWaitMilliseconds(
+        uint32_t retry_count,
+        uint32_t maxWaitBetweenReconnectionRetries)
     {
-        uint32_t wait_time = (retry_count < 26) ? (std::pow(2, retry_count) * 100) : 0;
+        uint32_t wait_time = std::pow(2, retry_count) * 100;
 
         if (wait_time > maxWaitBetweenReconnectionRetries || wait_time == 0)
         {
@@ -22,4 +23,4 @@ namespace ix
 
         return wait_time;
     }
-} // namespace ix
+}

ixwebsocket/IXExponentialBackoff.h

@@ -10,6 +10,7 @@
 
 namespace ix
 {
-    uint32_t calculateRetryWaitMilliseconds(uint32_t retry_count,
-                                            uint32_t maxWaitBetweenReconnectionRetries);
+    uint32_t calculateRetryWaitMilliseconds(
+        uint32_t retry_count,
+        uint32_t maxWaitBetweenReconnectionRetries);
 } // namespace ix

ixwebsocket/IXHttp.cpp

@@ -5,9 +5,9 @@
  */
 
 #include "IXHttp.h"
-
 #include "IXCancellationRequest.h"
 #include "IXSocket.h"
+
 #include <sstream>
 #include <vector>
 
@@ -27,38 +27,7 @@ namespace ix
         return out;
     }
 
-    std::pair<std::string, int> Http::parseStatusLine(const std::string& line)
-    {
-        // Request-Line   = Method SP Request-URI SP HTTP-Version CRLF
-        std::string token;
-        std::stringstream tokenStream(line);
-        std::vector<std::string> tokens;
-
-        // Split by ' '
-        while (std::getline(tokenStream, token, ' '))
-        {
-            tokens.push_back(token);
-        }
-
-        std::string httpVersion;
-        if (tokens.size() >= 1)
-        {
-            httpVersion = trim(tokens[0]);
-        }
-
-        int statusCode = -1;
-        if (tokens.size() >= 2)
-        {
-            std::stringstream ss;
-            ss << trim(tokens[1]);
-            ss >> statusCode;
-        }
-
-        return std::make_pair(httpVersion, statusCode);
-    }
-
-    std::tuple<std::string, std::string, std::string> Http::parseRequestLine(
-        const std::string& line)
+    std::tuple<std::string, std::string, std::string> Http::parseRequestLine(const std::string& line)
     {
         // Request-Line   = Method SP Request-URI SP HTTP-Version CRLF
         std::string token;
@@ -92,8 +61,7 @@ namespace ix
         return std::make_tuple(method, requestUri, httpVersion);
     }
 
-    std::tuple<bool, std::string, HttpRequestPtr> Http::parseRequest(
-        std::unique_ptr<Socket>& socket)
+    std::tuple<bool, std::string, HttpRequestPtr> Http::parseRequest(std::shared_ptr<Socket> socket)
     {
         HttpRequestPtr httpRequest;
 
@@ -116,8 +84,8 @@ namespace ix
 
         // Parse request line (GET /foo HTTP/1.1\r\n)
         auto requestLine = Http::parseRequestLine(line);
-        auto method = std::get<0>(requestLine);
-        auto uri = std::get<1>(requestLine);
+        auto method      = std::get<0>(requestLine);
+        auto uri         = std::get<1>(requestLine);
         auto httpVersion = std::get<2>(requestLine);
 
         // Retrieve and validate HTTP headers
@@ -134,7 +102,7 @@ namespace ix
         return std::make_tuple(true, "", httpRequest);
     }
 
-    bool Http::sendResponse(HttpResponsePtr response, std::unique_ptr<Socket>& socket)
+    bool Http::sendResponse(HttpResponsePtr response, std::shared_ptr<Socket> socket)
     {
         // Write the response to the socket
         std::stringstream ss;
@@ -163,6 +131,8 @@ namespace ix
             return false;
         }
 
-        return response->payload.empty() ? true : socket->writeBytes(response->payload, nullptr);
+        return response->payload.empty()
+            ? true
+            : socket->writeBytes(response->payload, nullptr);
     }
-} // namespace ix
+}

ixwebsocket/IXHttp.h

@@ -9,7 +9,6 @@
 #include "IXProgressCallback.h"
 #include "IXWebSocketHttpHeaders.h"
 #include <tuple>
-#include <unordered_map>
 
 namespace ix
 {
@@ -66,8 +65,7 @@ namespace ix
     };
 
     using HttpResponsePtr = std::shared_ptr<HttpResponse>;
-    using HttpParameters = std::unordered_map<std::string, std::string>;
-    using HttpFormDataParameters = std::unordered_map<std::string, std::string>;
+    using HttpParameters = std::map<std::string, std::string>;
     using Logger = std::function<void(const std::string&)>;
     using OnResponseCallback = std::function<void(const HttpResponsePtr&)>;
 
@@ -77,13 +75,12 @@ namespace ix
         std::string verb;
         WebSocketHttpHeaders extraHeaders;
         std::string body;
-        std::string multipartBoundary;
-        int connectTimeout = 60;
-        int transferTimeout = 1800;
-        bool followRedirects = true;
-        int maxRedirects = 5;
-        bool verbose = false;
-        bool compress = true;
+        int connectTimeout;
+        int transferTimeout;
+        bool followRedirects;
+        int maxRedirects;
+        bool verbose;
+        bool compress;
         Logger logger;
         OnProgressCallback onProgressCallback;
     };
@@ -115,10 +112,9 @@ namespace ix
     {
     public:
         static std::tuple<bool, std::string, HttpRequestPtr> parseRequest(
-            std::unique_ptr<Socket>& socket);
-        static bool sendResponse(HttpResponsePtr response, std::unique_ptr<Socket>& socket);
+            std::shared_ptr<Socket> socket);
+        static bool sendResponse(HttpResponsePtr response, std::shared_ptr<Socket> socket);
 
-        static std::pair<std::string, int> parseStatusLine(const std::string& line);
         static std::tuple<std::string, std::string, std::string> parseRequestLine(
             const std::string& line);
         static std::string trim(const std::string& str);

ixwebsocket/IXHttpClient.cpp

@@ -5,17 +5,17 @@
  */
 
 #include "IXHttpClient.h"
-
-#include "IXSocketFactory.h"
 #include "IXUrlParser.h"
 #include "IXUserAgent.h"
 #include "IXWebSocketHttpHeaders.h"
-#include <assert.h>
-#include <cstring>
-#include <iomanip>
-#include <random>
+#include "IXSocketFactory.h"
+
 #include <sstream>
+#include <iomanip>
 #include <vector>
+#include <cstring>
+
+#include <assert.h>
 #include <zlib.h>
 
 namespace ix
@@ -26,9 +26,7 @@ namespace ix
     const std::string HttpClient::kDel = "DEL";
     const std::string HttpClient::kPut = "PUT";
 
-    HttpClient::HttpClient(bool async)
-        : _async(async)
-        , _stop(false)
+    HttpClient::HttpClient(bool async) : _async(async), _stop(false)
     {
         if (!_async) return;
 
@@ -44,12 +42,8 @@ namespace ix
         _thread.join();
     }
 
-    void HttpClient::setTLSOptions(const SocketTLSOptions& tlsOptions)
-    {
-        _tlsOptions = tlsOptions;
-    }
-
-    HttpRequestArgsPtr HttpClient::createRequest(const std::string& url, const std::string& verb)
+    HttpRequestArgsPtr HttpClient::createRequest(const std::string& url,
+                                                 const std::string& verb)
     {
         auto request = std::make_shared<HttpRequestArgs>();
         request->url = url;
@@ -112,11 +106,12 @@ namespace ix
         }
     }
 
-    HttpResponsePtr HttpClient::request(const std::string& url,
-                                        const std::string& verb,
-                                        const std::string& body,
-                                        HttpRequestArgsPtr args,
-                                        int redirects)
+    HttpResponsePtr HttpClient::request(
+        const std::string& url,
+        const std::string& verb,
+        const std::string& body,
+        HttpRequestArgsPtr args,
+        int redirects)
     {
         // We only have one socket connection, so we cannot
         // make multiple requests concurrently.
@@ -136,30 +131,20 @@ namespace ix
         {
             std::stringstream ss;
             ss << "Cannot parse url: " << url;
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::UrlMalformed,
-                                                  headers,
-                                                  payload,
-                                                  ss.str(),
-                                                  uploadSize,
-                                                  downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::UrlMalformed,
+                                                  headers, payload, ss.str(),
+                                                  uploadSize, downloadSize);
         }
 
         bool tls = protocol == "https";
         std::string errorMsg;
-        _socket = createSocket(tls, -1, errorMsg, _tlsOptions);
+        _socket = createSocket(tls, errorMsg);
 
         if (!_socket)
         {
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::CannotCreateSocket,
-                                                  headers,
-                                                  payload,
-                                                  errorMsg,
-                                                  uploadSize,
-                                                  downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::CannotCreateSocket,
+                                                  headers, payload, errorMsg,
+                                                  uploadSize, downloadSize);
         }
 
         // Build request string
@@ -169,8 +154,7 @@ namespace ix
 
         if (args->compress)
         {
-            ss << "Accept-Encoding: gzip"
-               << "\r\n";
+            ss << "Accept-Encoding: gzip" << "\r\n";
         }
 
         // Append extra headers
@@ -182,8 +166,7 @@ namespace ix
         // Set a default Accept header if none is present
         if (headers.find("Accept") == headers.end())
         {
-            ss << "Accept: */*"
-               << "\r\n";
+            ss << "Accept: */*" << "\r\n";
         }
 
         // Set a default User agent if none is present
@@ -199,16 +182,7 @@ namespace ix
             // Set default Content-Type if unspecified
             if (args->extraHeaders.find("Content-Type") == args->extraHeaders.end())
             {
-                if (args->multipartBoundary.empty())
-                {
-                    ss << "Content-Type: application/x-www-form-urlencoded"
-                       << "\r\n";
-                }
-                else
-                {
-                    ss << "Content-Type: multipart/form-data; boundary=" << args->multipartBoundary
-                       << "\r\n";
-                }
+                ss << "Content-Type: application/x-www-form-urlencoded" << "\r\n";
             }
             ss << "\r\n";
             ss << body;
@@ -231,14 +205,9 @@ namespace ix
         {
             std::stringstream ss;
             ss << "Cannot connect to url: " << url << " / error : " << errMsg;
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::CannotConnect,
-                                                  headers,
-                                                  payload,
-                                                  ss.str(),
-                                                  uploadSize,
-                                                  downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::CannotConnect,
+                                                  headers, payload, ss.str(),
+                                                  uploadSize, downloadSize);
         }
 
         // Make a new cancellation object dealing with transfer timeout
@@ -252,7 +221,8 @@ namespace ix
                << "to " << host << ":" << port << std::endl
                << "request size: " << req.size() << " bytes" << std::endl
                << "=============" << std::endl
-               << req << "=============" << std::endl
+               << req
+               << "=============" << std::endl
                << std::endl;
 
             log(ss.str(), args);
@@ -261,14 +231,9 @@ namespace ix
         if (!_socket->writeBytes(req, isCancellationRequested))
         {
             std::string errorMsg("Cannot send request");
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::SendError,
-                                                  headers,
-                                                  payload,
-                                                  errorMsg,
-                                                  uploadSize,
-                                                  downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::SendError,
+                                                  headers, payload, errorMsg,
+                                                  uploadSize, downloadSize);
         }
 
         uploadSize = req.size();
@@ -280,14 +245,9 @@ namespace ix
         if (!lineValid)
         {
             std::string errorMsg("Cannot retrieve status line");
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::CannotReadStatusLine,
-                                                  headers,
-                                                  payload,
-                                                  errorMsg,
-                                                  uploadSize,
-                                                  downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::CannotReadStatusLine,
+                                                  headers, payload, errorMsg,
+                                                  uploadSize, downloadSize);
         }
 
         if (args->verbose)
@@ -300,14 +260,9 @@ namespace ix
         if (sscanf(line.c_str(), "HTTP/1.1 %d", &code) != 1)
         {
             std::string errorMsg("Cannot parse response code from status line");
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::MissingStatus,
-                                                  headers,
-                                                  payload,
-                                                  errorMsg,
-                                                  uploadSize,
-                                                  downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::MissingStatus,
+                                                  headers, payload, errorMsg,
+                                                  uploadSize, downloadSize);
         }
 
         auto result = parseHttpHeaders(_socket, isCancellationRequested);
@@ -317,14 +272,9 @@ namespace ix
         if (!headersValid)
         {
             std::string errorMsg("Cannot parse http headers");
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::HeaderParsingError,
-                                                  headers,
-                                                  payload,
-                                                  errorMsg,
-                                                  uploadSize,
-                                                  downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::HeaderParsingError,
+                                                  headers, payload, errorMsg,
+                                                  uploadSize, downloadSize);
         }
 
         // Redirect ?
@@ -333,45 +283,30 @@ namespace ix
             if (headers.find("Location") == headers.end())
             {
                 std::string errorMsg("Missing location header for redirect");
-                return std::make_shared<HttpResponse>(code,
-                                                      description,
-                                                      HttpErrorCode::MissingLocation,
-                                                      headers,
-                                                      payload,
-                                                      errorMsg,
-                                                      uploadSize,
-                                                      downloadSize);
+                return std::make_shared<HttpResponse>(code, description, HttpErrorCode::MissingLocation,
+                                                      headers, payload, errorMsg,
+                                                      uploadSize, downloadSize);
             }
 
             if (redirects >= args->maxRedirects)
             {
                 std::stringstream ss;
                 ss << "Too many redirects: " << redirects;
-                return std::make_shared<HttpResponse>(code,
-                                                      description,
-                                                      HttpErrorCode::TooManyRedirects,
-                                                      headers,
-                                                      payload,
-                                                      ss.str(),
-                                                      uploadSize,
-                                                      downloadSize);
+                return std::make_shared<HttpResponse>(code, description, HttpErrorCode::TooManyRedirects,
+                                                      headers, payload, ss.str(),
+                                                      uploadSize, downloadSize);
             }
 
             // Recurse
             std::string location = headers["Location"];
-            return request(location, verb, body, args, redirects + 1);
+            return request(location, verb, body, args, redirects+1);
         }
 
         if (verb == "HEAD")
         {
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::Ok,
-                                                  headers,
-                                                  payload,
-                                                  std::string(),
-                                                  uploadSize,
-                                                  downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::Ok,
+                                                  headers, payload, std::string(),
+                                                  uploadSize, downloadSize);
         }
 
         // Parse response:
@@ -384,19 +319,15 @@ namespace ix
 
             payload.reserve(contentLength);
 
-            auto chunkResult = _socket->readBytes(
-                contentLength, args->onProgressCallback, isCancellationRequested);
+            auto chunkResult = _socket->readBytes(contentLength,
+                                                  args->onProgressCallback,
+                                                  isCancellationRequested);
             if (!chunkResult.first)
             {
                 errorMsg = "Cannot read chunk";
-                return std::make_shared<HttpResponse>(code,
-                                                      description,
-                                                      HttpErrorCode::ChunkReadError,
-                                                      headers,
-                                                      payload,
-                                                      errorMsg,
-                                                      uploadSize,
-                                                      downloadSize);
+                return std::make_shared<HttpResponse>(code, description, HttpErrorCode::ChunkReadError,
+                                                      headers, payload, errorMsg,
+                                                      uploadSize, downloadSize);
             }
             payload += chunkResult.second;
         }
@@ -412,14 +343,9 @@ namespace ix
 
                 if (!lineResult.first)
                 {
-                    return std::make_shared<HttpResponse>(code,
-                                                          description,
-                                                          HttpErrorCode::ChunkReadError,
-                                                          headers,
-                                                          payload,
-                                                          errorMsg,
-                                                          uploadSize,
-                                                          downloadSize);
+                    return std::make_shared<HttpResponse>(code, description, HttpErrorCode::ChunkReadError,
+                                                          headers, payload, errorMsg,
+                                                          uploadSize, downloadSize);
                 }
 
                 uint64_t chunkSize;
@@ -430,26 +356,23 @@ namespace ix
                 if (args->verbose)
                 {
                     std::stringstream oss;
-                    oss << "Reading " << chunkSize << " bytes" << std::endl;
+                    oss << "Reading " << chunkSize << " bytes"
+                        << std::endl;
                     log(oss.str(), args);
                 }
 
                 payload.reserve(payload.size() + (size_t) chunkSize);
 
                 // Read a chunk
-                auto chunkResult = _socket->readBytes(
-                    (size_t) chunkSize, args->onProgressCallback, isCancellationRequested);
+                auto chunkResult = _socket->readBytes((size_t) chunkSize,
+                                                      args->onProgressCallback,
+                                                      isCancellationRequested);
                 if (!chunkResult.first)
                 {
                     errorMsg = "Cannot read chunk";
-                    return std::make_shared<HttpResponse>(code,
-                                                          description,
-                                                          HttpErrorCode::ChunkReadError,
-                                                          headers,
-                                                          payload,
-                                                          errorMsg,
-                                                          uploadSize,
-                                                          downloadSize);
+                    return std::make_shared<HttpResponse>(code, description, HttpErrorCode::ChunkReadError,
+                                                          headers, payload, errorMsg,
+                                                          uploadSize, downloadSize);
                 }
                 payload += chunkResult.second;
 
@@ -458,14 +381,9 @@ namespace ix
 
                 if (!lineResult.first)
                 {
-                    return std::make_shared<HttpResponse>(code,
-                                                          description,
-                                                          HttpErrorCode::ChunkReadError,
-                                                          headers,
-                                                          payload,
-                                                          errorMsg,
-                                                          uploadSize,
-                                                          downloadSize);
+                    return std::make_shared<HttpResponse>(code, description, HttpErrorCode::ChunkReadError,
+                                                          headers, payload, errorMsg,
+                                                          uploadSize, downloadSize);
                 }
 
                 if (chunkSize == 0) break;
@@ -478,14 +396,9 @@ namespace ix
         else
         {
             std::string errorMsg("Cannot read http body");
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::CannotReadBody,
-                                                  headers,
-                                                  payload,
-                                                  errorMsg,
-                                                  uploadSize,
-                                                  downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::CannotReadBody,
+                                                  headers, payload, errorMsg,
+                                                  uploadSize, downloadSize);
         }
 
         downloadSize = payload.size();
@@ -497,39 +410,32 @@ namespace ix
             if (!gzipInflate(payload, decompressedPayload))
             {
                 std::string errorMsg("Error decompressing payload");
-                return std::make_shared<HttpResponse>(code,
-                                                      description,
-                                                      HttpErrorCode::Gzip,
-                                                      headers,
-                                                      payload,
-                                                      errorMsg,
-                                                      uploadSize,
-                                                      downloadSize);
+                return std::make_shared<HttpResponse>(code, description, HttpErrorCode::Gzip,
+                                                      headers, payload, errorMsg,
+                                                      uploadSize, downloadSize);
             }
             payload = decompressedPayload;
         }
 
-        return std::make_shared<HttpResponse>(code,
-                                              description,
-                                              HttpErrorCode::Ok,
-                                              headers,
-                                              payload,
-                                              std::string(),
-                                              uploadSize,
-                                              downloadSize);
+        return std::make_shared<HttpResponse>(code, description, HttpErrorCode::Ok,
+                                              headers, payload, std::string(),
+                                              uploadSize, downloadSize);
     }
 
-    HttpResponsePtr HttpClient::get(const std::string& url, HttpRequestArgsPtr args)
+    HttpResponsePtr HttpClient::get(const std::string& url,
+                                    HttpRequestArgsPtr args)
     {
         return request(url, kGet, std::string(), args);
     }
 
-    HttpResponsePtr HttpClient::head(const std::string& url, HttpRequestArgsPtr args)
+    HttpResponsePtr HttpClient::head(const std::string& url,
+                                     HttpRequestArgsPtr args)
     {
         return request(url, kHead, std::string(), args);
     }
 
-    HttpResponsePtr HttpClient::del(const std::string& url, HttpRequestArgsPtr args)
+    HttpResponsePtr HttpClient::del(const std::string& url,
+                                    HttpRequestArgsPtr args)
     {
         return request(url, kDel, std::string(), args);
     }
@@ -568,7 +474,8 @@ namespace ix
         escaped.fill('0');
         escaped << std::hex;
 
-        for (std::string::const_iterator i = value.begin(), n = value.end(); i != n; ++i)
+        for (std::string::const_iterator i = value.begin(), n = value.end();
+             i != n; ++i)
         {
             std::string::value_type c = (*i);
 
@@ -596,64 +503,21 @@ namespace ix
 
         for (auto&& it : httpParameters)
         {
-            ss << urlEncode(it.first) << "=" << urlEncode(it.second);
+            ss << urlEncode(it.first)
+               << "="
+               << urlEncode(it.second);
 
-            if (i++ < (count - 1))
+            if (i++ < (count-1))
             {
-                ss << "&";
+               ss << "&";
             }
         }
         return ss.str();
     }
 
-    std::string HttpClient::serializeHttpFormDataParameters(
-        const std::string& multipartBoundary,
-        const HttpFormDataParameters& httpFormDataParameters,
-        const HttpParameters& httpParameters)
-    {
-        //
-        // --AaB03x
-        // Content-Disposition: form-data; name="submit-name"
-
-        // Larry
-        // --AaB03x
-        // Content-Disposition: form-data; name="foo.txt"; filename="file1.txt"
-        // Content-Type: text/plain
-
-        // ... contents of file1.txt ...
-        // --AaB03x--
-        //
-        std::stringstream ss;
-
-        for (auto&& it : httpFormDataParameters)
-        {
-            ss << "--" << multipartBoundary << "\r\n"
-               << "Content-Disposition:"
-               << " form-data; name=\"" << it.first << "\";"
-               << " filename=\"" << it.first << "\""
-               << "\r\n"
-               << "Content-Type: application/octet-stream"
-               << "\r\n"
-               << "\r\n"
-               << it.second << "\r\n";
-        }
-
-        for (auto&& it : httpParameters)
-        {
-            ss << "--" << multipartBoundary << "\r\n"
-               << "Content-Disposition:"
-               << " form-data; name=\"" << it.first << "\";"
-               << "\r\n"
-               << "\r\n"
-               << it.second << "\r\n";
-        }
-
-        ss << "--" << multipartBoundary << "--\r\n";
-
-        return ss.str();
-    }
-
-    bool HttpClient::gzipInflate(const std::string& in, std::string& out)
+    bool HttpClient::gzipInflate(
+        const std::string& in,
+        std::string& out)
     {
         z_stream inflateState;
         std::memset(&inflateState, 0, sizeof(inflateState));
@@ -664,13 +528,13 @@ namespace ix
         inflateState.avail_in = 0;
         inflateState.next_in = Z_NULL;
 
-        if (inflateInit2(&inflateState, 16 + MAX_WBITS) != Z_OK)
+        if (inflateInit2(&inflateState, 16+MAX_WBITS) != Z_OK)
         {
             return false;
         }
 
         inflateState.avail_in = (uInt) in.size();
-        inflateState.next_in = (unsigned char*) (const_cast<char*>(in.data()));
+        inflateState.next_in = (unsigned char *)(const_cast<char *>(in.data()));
 
         const int kBufferSize = 1 << 14;
 
@@ -690,31 +554,22 @@ namespace ix
                 return false;
             }
 
-            out.append(reinterpret_cast<char*>(compressBuffer.get()),
-                       kBufferSize - inflateState.avail_out);
+            out.append(
+                reinterpret_cast<char *>(compressBuffer.get()),
+                kBufferSize - inflateState.avail_out
+            );
         } while (inflateState.avail_out == 0);
 
         inflateEnd(&inflateState);
         return true;
     }
 
-    void HttpClient::log(const std::string& msg, HttpRequestArgsPtr args)
+    void HttpClient::log(const std::string& msg,
+                         HttpRequestArgsPtr args)
     {
         if (args->logger)
         {
             args->logger(msg);
         }
     }
-
-    std::string HttpClient::generateMultipartBoundary()
-    {
-        std::string str("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz");
-
-        static std::random_device rd;
-        static std::mt19937 generator(rd());
-
-        std::shuffle(str.begin(), str.end(), generator);
-
-        return str;
-    }
-} // namespace ix
+}

ixwebsocket/IXHttpClient.h

@@ -8,7 +8,6 @@
 
 #include "IXHttp.h"
 #include "IXSocket.h"
-#include "IXSocketTLSOptions.h"
 #include "IXWebSocketHttpHeaders.h"
 #include <algorithm>
 #include <atomic>
@@ -59,18 +58,8 @@ namespace ix
         bool performRequest(HttpRequestArgsPtr request,
                             const OnResponseCallback& onResponseCallback);
 
-        // TLS
-        void setTLSOptions(const SocketTLSOptions& tlsOptions);
-
         std::string serializeHttpParameters(const HttpParameters& httpParameters);
 
-        std::string serializeHttpFormDataParameters(
-            const std::string& multipartBoundary,
-            const HttpFormDataParameters& httpFormDataParameters,
-            const HttpParameters& httpParameters = HttpParameters());
-
-        std::string generateMultipartBoundary();
-
         std::string urlEncode(const std::string& value);
 
         const static std::string kPost;
@@ -95,9 +84,7 @@ namespace ix
         std::atomic<bool> _stop;
         std::thread _thread;
 
-        std::unique_ptr<Socket> _socket;
+        std::shared_ptr<Socket> _socket;
         std::mutex _mutex; // to protect accessing the _socket (only one socket per client)
-
-        SocketTLSOptions _tlsOptions;
     };
 } // namespace ix

ixwebsocket/IXHttpServer.cpp

@@ -5,12 +5,13 @@
  */
 
 #include "IXHttpServer.h"
-
-#include "IXNetSystem.h"
 #include "IXSocketConnect.h"
-#include "IXUserAgent.h"
-#include <fstream>
+#include "IXSocketFactory.h"
+#include "IXNetSystem.h"
+
+#include <iostream>
 #include <sstream>
+#include <fstream>
 #include <vector>
 
 namespace
@@ -27,7 +28,7 @@ namespace
         file.seekg(0, file.beg);
 
         memblock.resize((size_t) size);
-        file.read((char*) &memblock.front(), static_cast<std::streamsize>(size));
+        file.read((char*)&memblock.front(), static_cast<std::streamsize>(size));
 
         return std::make_pair(true, memblock);
     }
@@ -38,14 +39,15 @@ namespace
         auto vec = res.second;
         return std::make_pair(res.first, std::string(vec.begin(), vec.end()));
     }
-} // namespace
+}
 
 namespace ix
 {
-    HttpServer::HttpServer(
-        int port, const std::string& host, int backlog, size_t maxConnections, int addressFamily)
-        : SocketServer(port, host, backlog, maxConnections, addressFamily)
-        , _connectedClientsCount(0)
+    HttpServer::HttpServer(int port,
+                           const std::string& host,
+                           int backlog,
+                           size_t maxConnections) : SocketServer(port, host, backlog, maxConnections),
+        _connectedClientsCount(0)
     {
         setDefaultConnectionCallback();
     }
@@ -69,11 +71,18 @@ namespace ix
         _onConnectionCallback = callback;
     }
 
-    void HttpServer::handleConnection(std::unique_ptr<Socket> socket,
-                                      std::shared_ptr<ConnectionState> connectionState)
+    void HttpServer::handleConnection(
+        int fd,
+        std::shared_ptr<ConnectionState> connectionState)
     {
         _connectedClientsCount++;
 
+        std::string errorMsg;
+        auto socket = createSocket(fd, errorMsg);
+
+        // Set the socket to non blocking mode + other tweaks
+        SocketConnect::configure(fd);
+
         auto ret = Http::parseRequest(socket);
         // FIXME: handle errors in parseRequest
 
@@ -99,33 +108,39 @@ namespace ix
     {
         setOnConnectionCallback(
             [this](HttpRequestPtr request,
-                   std::shared_ptr<ConnectionState> /*connectionState*/) -> HttpResponsePtr {
+                   std::shared_ptr<ConnectionState> /*connectionState*/) -> HttpResponsePtr
+            {
                 std::string uri(request->uri);
                 if (uri.empty() || uri == "/")
                 {
                     uri = "/index.html";
                 }
 
-                WebSocketHttpHeaders headers;
-                headers["Server"] = userAgent();
-
                 std::string path("." + uri);
                 auto res = readAsString(path);
                 bool found = res.first;
                 if (!found)
                 {
-                    return std::make_shared<HttpResponse>(
-                        404, "Not Found", HttpErrorCode::Ok, WebSocketHttpHeaders(), std::string());
+                    return std::make_shared<HttpResponse>(404, "Not Found",
+                                                          HttpErrorCode::Ok,
+                                                          WebSocketHttpHeaders(),
+                                                          std::string());
                 }
 
                 std::string content = res.second;
 
                 // Log request
                 std::stringstream ss;
-                ss << request->method << " " << request->headers["User-Agent"] << " "
-                   << request->uri << " " << content.size();
+                ss << request->method
+                   << " "
+                   << request->headers["User-Agent"]
+                   << " "
+                   << request->uri
+                   << " "
+                   << content.size();
                 logInfo(ss.str());
 
+                WebSocketHttpHeaders headers;
                 // FIXME: check extensions to set the content type
                 // headers["Content-Type"] = "application/octet-stream";
                 headers["Accept-Ranges"] = "none";
@@ -135,39 +150,11 @@ namespace ix
                     headers[it.first] = it.second;
                 }
 
-                return std::make_shared<HttpResponse>(
-                    200, "OK", HttpErrorCode::Ok, headers, content);
-            });
+                return std::make_shared<HttpResponse>(200, "OK",
+                                                      HttpErrorCode::Ok,
+                                                      headers,
+                                                      content);
+            }
+        );
     }
-
-    void HttpServer::makeRedirectServer(const std::string& redirectUrl)
-    {
-        //
-        // See https://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections
-        //
-        setOnConnectionCallback(
-            [this,
-             redirectUrl](HttpRequestPtr request,
-                          std::shared_ptr<ConnectionState> /*connectionState*/) -> HttpResponsePtr {
-                WebSocketHttpHeaders headers;
-                headers["Server"] = userAgent();
-
-                // Log request
-                std::stringstream ss;
-                ss << request->method << " " << request->headers["User-Agent"] << " "
-                   << request->uri;
-                logInfo(ss.str());
-
-                if (request->method == "POST")
-                {
-                    return std::make_shared<HttpResponse>(
-                        200, "OK", HttpErrorCode::Ok, headers, std::string());
-                }
-
-                headers["Location"] = redirectUrl;
-
-                return std::make_shared<HttpResponse>(
-                    301, "OK", HttpErrorCode::Ok, headers, std::string());
-            });
-    }
-} // namespace ix
+}

ixwebsocket/IXHttpServer.h

@@ -28,22 +28,19 @@ namespace ix
         HttpServer(int port = SocketServer::kDefaultPort,
                    const std::string& host = SocketServer::kDefaultHost,
                    int backlog = SocketServer::kDefaultTcpBacklog,
-                   size_t maxConnections = SocketServer::kDefaultMaxConnections,
-                   int addressFamily = SocketServer::kDefaultAddressFamily);
+                   size_t maxConnections = SocketServer::kDefaultMaxConnections);
         virtual ~HttpServer();
         virtual void stop() final;
 
         void setOnConnectionCallback(const OnConnectionCallback& callback);
 
-        void makeRedirectServer(const std::string& redirectUrl);
-
     private:
         // Member variables
         OnConnectionCallback _onConnectionCallback;
         std::atomic<int> _connectedClientsCount;
 
         // Methods
-        virtual void handleConnection(std::unique_ptr<Socket>,
+        virtual void handleConnection(int fd,
                                       std::shared_ptr<ConnectionState> connectionState) final;
         virtual size_t getConnectedClientsCount() final;
 

ixwebsocket/IXNetSystem.cpp

@@ -34,7 +34,10 @@ namespace ix
         return true;
 #endif
     }
+}
 
+// This function should be in the global namespace
+#ifdef _WIN32
     //
     // That function could 'return WSAPoll(pfd, nfds, timeout);'
     // but WSAPoll is said to have weird behaviors on the internet
@@ -42,9 +45,8 @@ namespace ix
     //
     // So we make it a select wrapper
     //
-    int poll(struct pollfd* fds, nfds_t nfds, int timeout)
+    int poll(struct pollfd *fds, nfds_t nfds, int timeout)
     {
-#ifdef _WIN32
         int maxfd = 0;
         fd_set readfds, writefds, errorfds;
         FD_ZERO(&readfds);
@@ -53,7 +55,7 @@ namespace ix
 
         for (nfds_t i = 0; i < nfds; ++i)
         {
-            struct pollfd* fd = &fds[i];
+            struct pollfd *fd = &fds[i];
 
             if (fd->fd > maxfd)
             {
@@ -77,16 +79,17 @@ namespace ix
         tv.tv_sec = timeout / 1000;
         tv.tv_usec = (timeout % 1000) * 1000;
 
-        int ret = select(maxfd + 1, &readfds, &writefds, &errorfds, timeout != -1 ? &tv : NULL);
+        int ret = select(maxfd + 1, &readfds, &writefds, &errorfds,
+                         timeout != -1 ? &tv : NULL);
 
-        if (ret < 0)
+        if (ret < 0) 
         {
             return ret;
         }
 
         for (nfds_t i = 0; i < nfds; ++i)
         {
-            struct pollfd* fd = &fds[i];
+            struct pollfd *fd = &fds[i];
             fd->revents = 0;
 
             if (FD_ISSET(fd->fd, &readfds))
@@ -104,9 +107,5 @@ namespace ix
         }
 
         return ret;
-#else
-        return ::poll(fds, nfds, timeout);
-#endif
     }
-
-} // namespace ix
+#endif

ixwebsocket/IXNetSystem.h

@@ -13,15 +13,15 @@
 #include <io.h>
 #include <ws2def.h>
 
-// Define our own poll on Windows, as a wrapper on top of select
+// Define our own poll on Windows
 typedef unsigned long int nfds_t;
 
+int poll(struct pollfd* fds, nfds_t nfds, int timeout);
+
 #else
 #include <arpa/inet.h>
 #include <errno.h>
 #include <netdb.h>
-#include <netinet/in.h>
-#include <netinet/ip.h>
 #include <netinet/tcp.h>
 #include <poll.h>
 #include <sys/select.h>
@@ -35,6 +35,4 @@ namespace ix
 {
     bool initNetSystem();
     bool uninitNetSystem();
-
-    int poll(struct pollfd* fds, nfds_t nfds, int timeout);
 } // namespace ix

ixwebsocket/IXSelectInterrupt.cpp

@@ -42,4 +42,5 @@ namespace ix
     {
         return -1;
     }
-} // namespace ix
+}
+

ixwebsocket/IXSelectInterruptEventFd.cpp

@@ -0,0 +1,116 @@
+/*
+ *  IXSelectInterruptEventFd.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+//
+// On Linux we use eventd to wake up select.
+//
+
+//
+// Linux/Android has a special type of virtual files. select(2) will react
+// when reading/writing to those files, unlike closing sockets.
+//
+// https://linux.die.net/man/2/eventfd
+// http://www.sourcexr.com/articles/2013/10/26/lightweight-inter-process-signaling-with-eventfd
+//
+// eventfd was added in Linux kernel 2.x, and our oldest Android (Kitkat 4.4)
+// is on Kernel 3.x
+//
+// cf Android/Kernel table here
+// https://android.stackexchange.com/questions/51651/which-android-runs-which-linux-kernel
+//
+// On macOS we use UNIX pipes to wake up select.
+//
+
+#include "IXSelectInterruptEventFd.h"
+
+#include <sys/eventfd.h>
+
+#include <unistd.h> // for write
+#include <string.h> // for strerror
+#include <fcntl.h>
+#include <errno.h>
+#include <assert.h>
+#include <sstream>
+
+namespace ix
+{
+    SelectInterruptEventFd::SelectInterruptEventFd()
+    {
+        _eventfd = -1;
+    }
+
+    SelectInterruptEventFd::~SelectInterruptEventFd()
+    {
+        ::close(_eventfd);
+    }
+
+    bool SelectInterruptEventFd::init(std::string& errorMsg)
+    {
+        // calling init twice is a programming error
+        assert(_eventfd == -1);
+
+        _eventfd = eventfd(0, 0);
+        if (_eventfd < 0)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptEventFd::init() failed in eventfd()"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+
+            _eventfd = -1;
+            return false;
+        }
+
+        if (fcntl(_eventfd, F_SETFL, O_NONBLOCK) == -1)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptEventFd::init() failed in fcntl() call"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+
+            _eventfd = -1;
+            return false;
+        }
+
+        return true;
+    }
+
+    bool SelectInterruptEventFd::notify(uint64_t value)
+    {
+        int fd = _eventfd;
+
+        if (fd == -1) return false;
+
+        // we should write 8 bytes for an uint64_t
+        return write(fd, &value, sizeof(value)) == 8;
+    }
+
+    // TODO: return max uint64_t for errors ?
+    uint64_t SelectInterruptEventFd::read()
+    {
+        int fd = _eventfd;
+
+        uint64_t value = 0;
+        ::read(fd, &value, sizeof(value));
+        return value;
+    }
+
+    bool SelectInterruptEventFd::clear()
+    {
+        if (_eventfd == -1) return false;
+
+        // 0 is a special value ; select will not wake up
+        uint64_t value = 0;
+
+        // we should write 8 bytes for an uint64_t
+        return write(_eventfd, &value, sizeof(value)) == 8;
+    }
+
+    int SelectInterruptEventFd::getFd() const
+    {
+        return _eventfd;
+    }
+}

ixwebsocket/IXSelectInterruptEventFd.h

@@ -0,0 +1,31 @@
+/*
+ *  IXSelectInterruptEventFd.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include "IXSelectInterrupt.h"
+#include <stdint.h>
+#include <string>
+
+namespace ix
+{
+    class SelectInterruptEventFd final : public SelectInterrupt
+    {
+    public:
+        SelectInterruptEventFd();
+        virtual ~SelectInterruptEventFd();
+
+        bool init(std::string& errorMsg) final;
+
+        bool notify(uint64_t value) final;
+        bool clear() final;
+        uint64_t read() final;
+        int getFd() const final;
+
+    private:
+        int _eventfd;
+    };
+} // namespace ix

ixwebsocket/IXSelectInterruptFactory.cpp

@@ -7,19 +7,19 @@
 #include "IXSelectInterruptFactory.h"
 
 #if defined(__linux__) || defined(__APPLE__)
-#include "IXSelectInterruptPipe.h"
+# include <ixwebsocket/IXSelectInterruptPipe.h>
 #else
-#include "IXSelectInterrupt.h"
+# include <ixwebsocket/IXSelectInterrupt.h>
 #endif
 
 namespace ix
 {
-    SelectInterruptPtr createSelectInterrupt()
+    std::shared_ptr<SelectInterrupt> createSelectInterrupt()
     {
 #if defined(__linux__) || defined(__APPLE__)
-        return std::make_unique<SelectInterruptPipe>();
+        return std::make_shared<SelectInterruptPipe>();
 #else
-        return std::make_unique<SelectInterrupt>();
+        return std::make_shared<SelectInterrupt>();
 #endif
     }
-} // namespace ix
+}

ixwebsocket/IXSelectInterruptFactory.h

@@ -11,6 +11,5 @@
 namespace ix
 {
     class SelectInterrupt;
-    using SelectInterruptPtr = std::unique_ptr<SelectInterrupt>;
-    SelectInterruptPtr createSelectInterrupt();
+    std::shared_ptr<SelectInterrupt> createSelectInterrupt();
 } // namespace ix

ixwebsocket/IXSelectInterruptPipe.cpp

@@ -10,12 +10,12 @@
 
 #include "IXSelectInterruptPipe.h"
 
-#include <assert.h>
-#include <errno.h>
-#include <fcntl.h>
-#include <sstream>
-#include <string.h> // for strerror
 #include <unistd.h> // for write
+#include <string.h> // for strerror
+#include <fcntl.h>
+#include <errno.h>
+#include <assert.h>
+#include <sstream>
 
 namespace ix
 {
@@ -143,4 +143,4 @@ namespace ix
 
         return _fildes[kPipeReadIndex];
     }
-} // namespace ix
+}

ixwebsocket/IXSocket.cpp

@@ -5,20 +5,21 @@
  */
 
 #include "IXSocket.h"
-
+#include "IXSocketConnect.h"
 #include "IXNetSystem.h"
 #include "IXSelectInterrupt.h"
 #include "IXSelectInterruptFactory.h"
-#include "IXSocketConnect.h"
-#include <algorithm>
-#include <assert.h>
-#include <fcntl.h>
-#include <stdint.h>
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <assert.h>
+#include <stdint.h>
+#include <fcntl.h>
 #include <sys/types.h>
 
+#include <algorithm>
+
 #ifdef min
 #undef min
 #endif
@@ -31,9 +32,9 @@ namespace ix
     const uint64_t Socket::kCloseRequest = 2;
     constexpr size_t Socket::kChunkSize;
 
-    Socket::Socket(int fd)
-        : _sockfd(fd)
-        , _selectInterrupt(createSelectInterrupt())
+    Socket::Socket(int fd) :
+        _sockfd(fd),
+        _selectInterrupt(createSelectInterrupt())
     {
         ;
     }
@@ -46,25 +47,22 @@ namespace ix
     PollResultType Socket::poll(bool readyToRead,
                                 int timeoutMs,
                                 int sockfd,
-                                const SelectInterruptPtr& selectInterrupt)
+                                std::shared_ptr<SelectInterrupt> selectInterrupt)
     {
         //
-        // We used to use ::select to poll but on Android 9 we get large fds out of
-        // ::connect which crash in FD_SET as they are larger than FD_SETSIZE. Switching
-        // to ::poll does fix that.
+        // We used to use ::select to poll but on Android 9 we get large fds out of ::connect
+        // which crash in FD_SET as they are larger than FD_SETSIZE.
+        // Switching to ::poll does fix that.
         //
-        // However poll isn't as portable as select and has bugs on Windows, so we
-        // have a shim to fallback to select on those platforms. See
-        // https://github.com/mpv-player/mpv/pull/5203/files for such a select wrapper.
+        // However poll isn't as portable as select and has bugs on Windows, so we should write a 
+        // shim to fallback to select on those platforms.
+        // See https://github.com/mpv-player/mpv/pull/5203/files for such a select wrapper.
         //
         nfds_t nfds = 1;
         struct pollfd fds[2];
-        memset(fds, 0, sizeof(fds));
 
         fds[0].fd = sockfd;
         fds[0].events = (readyToRead) ? POLLIN : POLLOUT;
-
-        // this is ignored by poll, but our select based poll wrapper on Windows needs it
         fds[0].events |= POLLERR;
 
         // File descriptor used to interrupt select when needed
@@ -81,7 +79,7 @@ namespace ix
             }
         }
 
-        int ret = ix::poll(fds, nfds, timeoutMs);
+        int ret = ::poll(fds, nfds, timeoutMs);
 
         PollResultType pollResult = PollResultType::ReadyForRead;
         if (ret < 0)
@@ -125,7 +123,8 @@ namespace ix
 
             // getsockopt() puts the errno value for connect into optval so 0
             // means no-error.
-            if (getsockopt(sockfd, SOL_SOCKET, SO_ERROR, &optval, &optlen) == -1 || optval != 0)
+            if (getsockopt(sockfd, SOL_SOCKET, SO_ERROR, &optval, &optlen) == -1 ||
+                optval != 0)
             {
                 pollResult = PollResultType::Error;
 
@@ -135,11 +134,6 @@ namespace ix
             }
 #endif
         }
-        else if (sockfd != -1 && (fds[0].revents & POLLERR || fds[0].revents & POLLHUP ||
-                                  fds[0].revents & POLLNVAL))
-        {
-            pollResult = PollResultType::Error;
-        }
 
         return pollResult;
     }
@@ -172,16 +166,6 @@ namespace ix
         return _selectInterrupt->notify(wakeUpCode);
     }
 
-    bool Socket::accept(std::string& errMsg)
-    {
-        if (_sockfd == -1)
-        {
-            errMsg = "Socket is uninitialized";
-            return false;
-        }
-        return true;
-    }
-
     bool Socket::connect(const std::string& host,
                          int port,
                          std::string& errMsg,
@@ -217,7 +201,7 @@ namespace ix
 
     ssize_t Socket::send(const std::string& buffer)
     {
-        return send((char*) &buffer[0], buffer.size());
+        return send((char*)&buffer[0], buffer.size());
     }
 
     ssize_t Socket::recv(void* buffer, size_t length)
@@ -279,7 +263,7 @@ namespace ix
         {
             if (isCancellationRequested && isCancellationRequested()) return false;
 
-            ssize_t ret = send((char*) &str[offset], len);
+            ssize_t ret = send((char*)&str[offset], len);
 
             // We wrote some bytes, as needed, all good.
             if (ret > 0)
@@ -308,7 +292,8 @@ namespace ix
         }
     }
 
-    bool Socket::readByte(void* buffer, const CancellationRequest& isCancellationRequested)
+    bool Socket::readByte(void* buffer,
+                          const CancellationRequest& isCancellationRequested)
     {
         while (true)
         {
@@ -347,7 +332,7 @@ namespace ix
         std::string line;
         line.reserve(64);
 
-        for (int i = 0; i < 2 || (line[i - 2] != '\r' && line[i - 1] != '\n'); ++i)
+        for (int i = 0; i < 2 || (line[i-2] != '\r' && line[i-1] != '\n'); ++i)
         {
             if (!readByte(&c, isCancellationRequested))
             {
@@ -376,21 +361,22 @@ namespace ix
         {
             if (isCancellationRequested && isCancellationRequested())
             {
-                const std::string errorMsg("Cancellation Requested");
-                return std::make_pair(false, errorMsg);
+                return std::make_pair(false, std::string());
             }
 
             size_t size = std::min(kChunkSize, length - output.size());
-            ssize_t ret = recv((char*) &_readBuffer[0], size);
+            ssize_t ret = recv((char*)&_readBuffer[0], size);
 
-            if (ret > 0)
+            if (ret <= 0 && !Socket::isWaitNeeded())
             {
-                output.insert(output.end(), _readBuffer.begin(), _readBuffer.begin() + ret);
+                // Error
+                return std::make_pair(false, std::string());
             }
-            else if (ret <= 0 && !Socket::isWaitNeeded())
+            else
             {
-                const std::string errorMsg("Recv Error");
-                return std::make_pair(false, errorMsg);
+                output.insert(output.end(),
+                              _readBuffer.begin(),
+                              _readBuffer.begin() + ret);
             }
 
             if (onProgressCallback) onProgressCallback((int) output.size(), (int) length);
@@ -399,11 +385,11 @@ namespace ix
             // This way we are not busy looping
             if (isReadyToRead(1) == PollResultType::Error)
             {
-                const std::string errorMsg("Poll Error");
-                return std::make_pair(false, errorMsg);
+                return std::make_pair(false, std::string());
             }
         }
 
-        return std::make_pair(true, std::string(output.begin(), output.end()));
+        return std::make_pair(true, std::string(output.begin(),
+                                                output.end()));
     }
-} // namespace ix
+}

ixwebsocket/IXSocket.h

@@ -38,7 +38,6 @@ typedef SSIZE_T ssize_t;
 namespace ix
 {
     class SelectInterrupt;
-    using SelectInterruptPtr = std::unique_ptr<SelectInterrupt>;
 
     enum class PollResultType
     {
@@ -65,16 +64,14 @@ namespace ix
         PollResultType isReadyToRead(int timeoutMs);
 
         // Virtual methods
-        virtual bool accept(std::string& errMsg);
-
-        virtual bool connect(const std::string& host,
+        virtual bool connect(const std::string& url,
                              int port,
                              std::string& errMsg,
                              const CancellationRequest& isCancellationRequested);
         virtual void close();
 
         virtual ssize_t send(char* buffer, size_t length);
-        ssize_t send(const std::string& buffer);
+        virtual ssize_t send(const std::string& buffer);
         virtual ssize_t recv(void* buffer, size_t length);
 
         // Blocking and cancellable versions, working with socket that can be set
@@ -94,7 +91,7 @@ namespace ix
         static PollResultType poll(bool readyToRead,
                                    int timeoutMs,
                                    int sockfd,
-                                   const SelectInterruptPtr& selectInterrupt);
+                                   std::shared_ptr<SelectInterrupt> selectInterrupt = nullptr);
 
 
         // Used as special codes for pipe communication
@@ -113,6 +110,6 @@ namespace ix
         std::vector<uint8_t> _readBuffer;
         static constexpr size_t kChunkSize = 1 << 15;
 
-        SelectInterruptPtr _selectInterrupt;
+        std::shared_ptr<SelectInterrupt> _selectInterrupt;
     };
 } // namespace ix

ixwebsocket/IXSocketAppleSSL.cpp

@@ -1,20 +1,16 @@
 /*
  *  IXSocketAppleSSL.cpp
  *  Author: Benjamin Sergeant
- *  Copyright (c) 2017-2020 Machine Zone, Inc. All rights reserved.
+ *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
  *
  *  Adapted from Satori SDK Apple SSL code.
  */
-#ifdef IXWEBSOCKET_USE_SECURE_TRANSPORT
-
 #include "IXSocketAppleSSL.h"
-
 #include "IXSocketConnect.h"
-#include <errno.h>
+
 #include <fcntl.h>
 #include <netdb.h>
 #include <netinet/tcp.h>
-#include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -22,16 +18,131 @@
 #include <sys/time.h>
 #include <sys/types.h>
 #include <unistd.h>
+#include <stdint.h>
+
+#include <errno.h>
 #define socketerrno errno
 
 #include <Security/SecureTransport.h>
 
+namespace {
+
+OSStatus read_from_socket(SSLConnectionRef connection, void *data, size_t *len)
+{
+    int fd = (int) (long) connection;
+    if (fd < 0)
+        return errSSLInternal;
+
+    assert(data != nullptr);
+    assert(len != nullptr);
+
+    size_t requested_sz = *len;
+
+    ssize_t status = read(fd, data, requested_sz);
+
+    if (status > 0)
+    {
+        *len = (size_t) status;
+        if (requested_sz > *len)
+            return errSSLWouldBlock;
+        else
+            return noErr;
+    }
+    else if (0 == status)
+    {
+        *len = 0;
+        return errSSLClosedGraceful;
+    }
+    else
+    {
+        *len = 0;
+        switch (errno) {
+            case ENOENT:
+                return errSSLClosedGraceful;
+
+            case EAGAIN:
+                return errSSLWouldBlock;
+
+            case ECONNRESET:
+                return errSSLClosedAbort;
+
+            default:
+                return errSecIO;
+        }
+    }
+}
+
+OSStatus write_to_socket(SSLConnectionRef connection, const void *data, size_t *len)
+{
+    int fd = (int) (long) connection;
+    if (fd < 0)
+        return errSSLInternal;
+
+    assert(data != nullptr);
+    assert(len != nullptr);
+
+    size_t to_write_sz = *len;
+    ssize_t status = write(fd, data, to_write_sz);
+
+    if (status > 0)
+    {
+        *len = (size_t) status;
+        if (to_write_sz > *len)
+            return errSSLWouldBlock;
+        else
+            return noErr;
+    }
+    else if (0 == status)
+    {
+        *len = 0;
+        return errSSLClosedGraceful;
+    }
+    else
+    {
+        *len = 0;
+        if (EAGAIN == errno)
+        {
+            return errSSLWouldBlock;
+        }
+        else
+        {
+            return errSecIO;
+        }
+    }
+}
+
+std::string getSSLErrorDescription(OSStatus status)
+{
+    std::string errMsg("Unknown SSL error.");
+
+    CFErrorRef error = CFErrorCreate(kCFAllocatorDefault, kCFErrorDomainOSStatus, status, NULL);
+    if (error)
+    {
+        CFStringRef message = CFErrorCopyDescription(error);
+        if (message)
+        {
+            char localBuffer[128];
+            Boolean success;
+            success = CFStringGetCString(message, localBuffer, 128,
+                                         CFStringGetSystemEncoding());
+            if (success)
+            {
+                errMsg = localBuffer;
+            }
+            CFRelease(message);
+        }
+        CFRelease(error);
+    }
+
+    return errMsg;
+}
+
+} // anonymous namespace
+
 namespace ix
 {
-    SocketAppleSSL::SocketAppleSSL(const SocketTLSOptions& tlsOptions, int fd)
-        : Socket(fd)
-        , _sslContext(nullptr)
-        , _tlsOptions(tlsOptions)
+    SocketAppleSSL::SocketAppleSSL(int fd) : Socket(fd),
+        _sslContext(nullptr)
     {
         ;
     }
@@ -41,151 +152,6 @@ namespace ix
         SocketAppleSSL::close();
     }
 
-    std::string SocketAppleSSL::getSSLErrorDescription(OSStatus status)
-    {
-        std::string errMsg("Unknown SSL error.");
-
-        CFErrorRef error = CFErrorCreate(kCFAllocatorDefault, kCFErrorDomainOSStatus, status, NULL);
-        if (error)
-        {
-            CFStringRef message = CFErrorCopyDescription(error);
-            if (message)
-            {
-                char localBuffer[128];
-                Boolean success;
-                success = CFStringGetCString(message, localBuffer, 128, kCFStringEncodingUTF8);
-                if (success)
-                {
-                    errMsg = localBuffer;
-                }
-                CFRelease(message);
-            }
-            CFRelease(error);
-        }
-
-        return errMsg;
-    }
-
-    OSStatus SocketAppleSSL::readFromSocket(SSLConnectionRef connection, void* data, size_t* len)
-    {
-        int fd = (int) (long) connection;
-        if (fd < 0) return errSSLInternal;
-
-        assert(data != nullptr);
-        assert(len != nullptr);
-
-        size_t requested_sz = *len;
-
-        ssize_t status = read(fd, data, requested_sz);
-
-        if (status > 0)
-        {
-            *len = (size_t) status;
-            if (requested_sz > *len)
-            {
-                return errSSLWouldBlock;
-            }
-            else
-            {
-                return noErr;
-            }
-        }
-        else if (status == 0)
-        {
-            *len = 0;
-            return errSSLClosedGraceful;
-        }
-        else
-        {
-            *len = 0;
-            switch (errno)
-            {
-                case ENOENT: return errSSLClosedGraceful;
-
-                case EAGAIN: return errSSLWouldBlock; // EWOULDBLOCK is a define for EAGAIN on osx
-                case EINPROGRESS: return errSSLWouldBlock;
-
-                case ECONNRESET: return errSSLClosedAbort;
-
-                default: return errSecIO;
-            }
-        }
-    }
-
-    OSStatus SocketAppleSSL::writeToSocket(SSLConnectionRef connection,
-                                           const void* data,
-                                           size_t* len)
-    {
-        int fd = (int) (long) connection;
-        if (fd < 0) return errSSLInternal;
-
-        assert(data != nullptr);
-        assert(len != nullptr);
-
-        size_t to_write_sz = *len;
-        ssize_t status = write(fd, data, to_write_sz);
-
-        if (status > 0)
-        {
-            *len = (size_t) status;
-            if (to_write_sz > *len)
-            {
-                return errSSLWouldBlock;
-            }
-            else
-            {
-                return noErr;
-            }
-        }
-        else if (status == 0)
-        {
-            *len = 0;
-            return errSSLClosedGraceful;
-        }
-        else
-        {
-            *len = 0;
-            switch (errno)
-            {
-                case ENOENT: return errSSLClosedGraceful;
-
-                case EAGAIN: return errSSLWouldBlock; // EWOULDBLOCK is a define for EAGAIN on osx
-                case EINPROGRESS: return errSSLWouldBlock;
-
-                case ECONNRESET: return errSSLClosedAbort;
-
-                default: return errSecIO;
-            }
-        }
-    }
-
-
-    bool SocketAppleSSL::accept(std::string& errMsg)
-    {
-        errMsg = "TLS not supported yet in server mode with apple ssl backend";
-        return false;
-    }
-
-    OSStatus SocketAppleSSL::tlsHandShake(std::string& errMsg,
-                                          const CancellationRequest& isCancellationRequested)
-    {
-        OSStatus status;
-
-        do
-        {
-            status = SSLHandshake(_sslContext);
-
-            // Interrupt the handshake
-            if (isCancellationRequested())
-            {
-                errMsg = "Cancellation requested";
-                return errSSLInternal;
-            }
-        } while (status == errSSLWouldBlock || status == errSSLServerAuthCompleted);
-
-        return status;
-    }
-
     // No wait support
     bool SocketAppleSSL::connect(const std::string& host,
                                  int port,
@@ -201,32 +167,18 @@ namespace ix
 
             _sslContext = SSLCreateContext(kCFAllocatorDefault, kSSLClientSide, kSSLStreamType);
 
-            SSLSetIOFuncs(
-                _sslContext, SocketAppleSSL::readFromSocket, SocketAppleSSL::writeToSocket);
-            SSLSetConnection(_sslContext, (SSLConnectionRef)(long) _sockfd);
+            SSLSetIOFuncs(_sslContext, read_from_socket, write_to_socket);
+            SSLSetConnection(_sslContext, (SSLConnectionRef) (long) _sockfd);
             SSLSetProtocolVersionMin(_sslContext, kTLSProtocol12);
             SSLSetPeerDomainName(_sslContext, host.c_str(), host.size());
 
-            if (_tlsOptions.isPeerVerifyDisabled())
-            {
-                Boolean option(1);
-                SSLSetSessionOption(_sslContext, kSSLSessionOptionBreakOnServerAuth, option);
-
-                status = tlsHandShake(errMsg, isCancellationRequested);
-
-                if (status == errSSLServerAuthCompleted)
-                {
-                    // proceed with the handshake
-                    status = tlsHandShake(errMsg, isCancellationRequested);
-                }
-            }
-            else
-            {
-                status = tlsHandShake(errMsg, isCancellationRequested);
-            }
+            do {
+                status = SSLHandshake(_sslContext);
+            } while (errSSLWouldBlock == status ||
+                     errSSLServerAuthCompleted == status);
         }
 
-        if (status != noErr)
+        if (noErr != status)
         {
             errMsg = getSSLErrorDescription(status);
             close();
@@ -251,48 +203,44 @@ namespace ix
 
     ssize_t SocketAppleSSL::send(char* buf, size_t nbyte)
     {
-        OSStatus status = errSSLWouldBlock;
-        while (status == errSSLWouldBlock)
-        {
+        ssize_t ret = 0;
+        OSStatus status;
+        do {
             size_t processed = 0;
             std::lock_guard<std::mutex> lock(_mutex);
             status = SSLWrite(_sslContext, buf, nbyte, &processed);
+            ret += processed;
+            buf += processed;
+            nbyte -= processed;
+        } while (nbyte > 0 && errSSLWouldBlock == status);
 
-            if (processed > 0) return (ssize_t) processed;
+        if (ret == 0 && errSSLClosedAbort != status)
+            ret = -1;
+        return ret;
+    }
 
-            // The connection was reset, inform the caller that this
-            // Socket should close
-            if (status == errSSLClosedGraceful || status == errSSLClosedNoNotify ||
-                status == errSSLClosedAbort)
-            {
-                errno = ECONNRESET;
-                return -1;
-            }
-
-            if (status == errSSLWouldBlock)
-            {
-                errno = EWOULDBLOCK;
-                return -1;
-            }
-        }
-        return -1;
+    ssize_t SocketAppleSSL::send(const std::string& buffer)
+    {
+        return send((char*)&buffer[0], buffer.size());
     }
 
     // No wait support
     ssize_t SocketAppleSSL::recv(void* buf, size_t nbyte)
     {
         OSStatus status = errSSLWouldBlock;
-        while (status == errSSLWouldBlock)
+        while (errSSLWouldBlock == status)
         {
             size_t processed = 0;
             std::lock_guard<std::mutex> lock(_mutex);
             status = SSLRead(_sslContext, buf, nbyte, &processed);
 
-            if (processed > 0) return (ssize_t) processed;
+            if (processed > 0)
+                return (ssize_t) processed;
 
             // The connection was reset, inform the caller that this
             // Socket should close
-            if (status == errSSLClosedGraceful || status == errSSLClosedNoNotify ||
+            if (status == errSSLClosedGraceful ||
+                status == errSSLClosedNoNotify ||
                 status == errSSLClosedAbort)
             {
                 errno = ECONNRESET;
@@ -308,6 +256,4 @@ namespace ix
         return -1;
     }
 
-} // namespace ix
-
-#endif // IXWEBSOCKET_USE_SECURE_TRANSPORT
+}

ixwebsocket/IXSocketAppleSSL.h

@@ -1,15 +1,13 @@
 /*
  *  IXSocketAppleSSL.h
  *  Author: Benjamin Sergeant
- *  Copyright (c) 2017-2020 Machine Zone, Inc. All rights reserved.
+ *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
  */
-#ifdef IXWEBSOCKET_USE_SECURE_TRANSPORT
 
 #pragma once
 
 #include "IXCancellationRequest.h"
 #include "IXSocket.h"
-#include "IXSocketTLSOptions.h"
 #include <Security/SecureTransport.h>
 #include <Security/Security.h>
 #include <mutex>
@@ -19,11 +17,9 @@ namespace ix
     class SocketAppleSSL final : public Socket
     {
     public:
-        SocketAppleSSL(const SocketTLSOptions& tlsOptions, int fd = -1);
+        SocketAppleSSL(int fd = -1);
         ~SocketAppleSSL();
 
-        virtual bool accept(std::string& errMsg) final;
-
         virtual bool connect(const std::string& host,
                              int port,
                              std::string& errMsg,
@@ -31,22 +27,12 @@ namespace ix
         virtual void close() final;
 
         virtual ssize_t send(char* buffer, size_t length) final;
+        virtual ssize_t send(const std::string& buffer) final;
         virtual ssize_t recv(void* buffer, size_t length) final;
 
     private:
-        static std::string getSSLErrorDescription(OSStatus status);
-        static OSStatus writeToSocket(SSLConnectionRef connection, const void* data, size_t* len);
-        static OSStatus readFromSocket(SSLConnectionRef connection, void* data, size_t* len);
-
-        OSStatus tlsHandShake(std::string& errMsg,
-                              const CancellationRequest& isCancellationRequested);
-
         SSLContextRef _sslContext;
         mutable std::mutex _mutex; // AppleSSL routines are not thread-safe
-
-        SocketTLSOptions _tlsOptions;
     };
 
 } // namespace ix
-
-#endif // IXWEBSOCKET_USE_SECURE_TRANSPORT

ixwebsocket/IXSocketConnect.cpp

@@ -5,36 +5,36 @@
  */
 
 #include "IXSocketConnect.h"
-
 #include "IXDNSLookup.h"
 #include "IXNetSystem.h"
-#include "IXSelectInterrupt.h"
 #include "IXSocket.h"
-#include <fcntl.h>
+
 #include <string.h>
+#include <fcntl.h>
 #include <sys/types.h>
 
 // Android needs extra headers for TCP_NODELAY and IPPROTO_TCP
 #ifdef ANDROID
-#include <linux/in.h>
-#include <linux/tcp.h>
+# include <linux/in.h>
+# include <linux/tcp.h>
 #endif
 
 namespace ix
 {
     //
     // This function can be cancelled every 50 ms
-    // This is important so that we don't block the main UI thread when shutting down a
-    // connection which is already trying to reconnect, and can be blocked waiting for
-    // ::connect to respond.
+    // This is important so that we don't block the main UI thread when shutting down a connection which is
+    // already trying to reconnect, and can be blocked waiting for ::connect to respond.
     //
-    int SocketConnect::connectToAddress(const struct addrinfo* address,
+    int SocketConnect::connectToAddress(const struct addrinfo *address,
                                         std::string& errMsg,
                                         const CancellationRequest& isCancellationRequested)
     {
         errMsg = "no error";
 
-        int fd = socket(address->ai_family, address->ai_socktype, address->ai_protocol);
+        int fd = socket(address->ai_family,
+                        address->ai_socktype,
+                        address->ai_protocol);
         if (fd < 0)
         {
             errMsg = "Cannot create a socket";
@@ -65,8 +65,7 @@ namespace ix
 
             int timeoutMs = 10;
             bool readyToRead = false;
-            auto selectInterrupt = std::make_unique<SelectInterrupt>();
-            PollResultType pollResult = Socket::poll(readyToRead, timeoutMs, fd, selectInterrupt);
+            PollResultType pollResult = Socket::poll(readyToRead, timeoutMs, fd);
 
             if (pollResult == PollResultType::Timeout)
             {
@@ -75,7 +74,8 @@ namespace ix
             else if (pollResult == PollResultType::Error)
             {
                 Socket::closeSocket(fd);
-                errMsg = std::string("Connect error: ") + strerror(Socket::getErrno());
+                errMsg = std::string("Connect error: ") +
+                            strerror(Socket::getErrno());
                 return -1;
             }
             else if (pollResult == PollResultType::ReadyForWrite)
@@ -85,7 +85,8 @@ namespace ix
             else
             {
                 Socket::closeSocket(fd);
-                errMsg = std::string("Connect error: ") + strerror(Socket::getErrno());
+                errMsg = std::string("Connect error: ") +
+                            strerror(Socket::getErrno());
                 return -1;
             }
         }
@@ -104,7 +105,7 @@ namespace ix
         // First do DNS resolution
         //
         auto dnsLookup = std::make_shared<DNSLookup>(hostname, port);
-        struct addrinfo* res = dnsLookup->resolve(errMsg, isCancellationRequested);
+        struct addrinfo *res = dnsLookup->resolve(errMsg, isCancellationRequested);
         if (res == nullptr)
         {
             return -1;
@@ -113,7 +114,7 @@ namespace ix
         int sockfd = -1;
 
         // iterate through the records to find a working peer
-        struct addrinfo* address;
+        struct addrinfo *address;
         for (address = res; address != nullptr; address = address->ai_next)
         {
             //
@@ -148,7 +149,8 @@ namespace ix
         // 3. (apple) prevent SIGPIPE from being emitted when the remote end disconnect
 #ifdef SO_NOSIGPIPE
         int value = 1;
-        setsockopt(sockfd, SOL_SOCKET, SO_NOSIGPIPE, (void*) &value, sizeof(value));
+        setsockopt(sockfd, SOL_SOCKET, SO_NOSIGPIPE,
+                   (void *)&value, sizeof(value));
 #endif
     }
-} // namespace ix
+}

ixwebsocket/IXSocketFactory.cpp

@@ -8,45 +8,46 @@
 
 #ifdef IXWEBSOCKET_USE_TLS
 
-#ifdef IXWEBSOCKET_USE_MBED_TLS
-#include "IXSocketMbedTLS.h"
-#elif defined(IXWEBSOCKET_USE_OPEN_SSL)
-#include "IXSocketOpenSSL.h"
-#elif __APPLE__
-#include "IXSocketAppleSSL.h"
-#endif
+# ifdef IXWEBSOCKET_USE_MBED_TLS
+#  include <ixwebsocket/IXSocketMbedTLS.h>
+# elif __APPLE__
+#  include <ixwebsocket/IXSocketAppleSSL.h>
+# elif defined(_WIN32)
+#  include <ixwebsocket/IXSocketSChannel.h>
+# elif defined(IXWEBSOCKET_USE_OPEN_SSL)
+#  include <ixwebsocket/IXSocketOpenSSL.h>
+# endif
 
 #else
 
-#include "IXSocket.h"
+#include <ixwebsocket/IXSocket.h>
 
 #endif
 
 namespace ix
 {
-    std::unique_ptr<Socket> createSocket(bool tls,
-                                         int fd,
-                                         std::string& errorMsg,
-                                         const SocketTLSOptions& tlsOptions)
+    std::shared_ptr<Socket> createSocket(bool tls,
+                                         std::string& errorMsg)
     {
-        (void) tlsOptions;
         errorMsg.clear();
-        std::unique_ptr<Socket> socket;
+        std::shared_ptr<Socket> socket;
 
         if (!tls)
         {
-            socket = std::make_unique<Socket>(fd);
+            socket = std::make_shared<Socket>();
         }
         else
         {
 #ifdef IXWEBSOCKET_USE_TLS
-#if defined(IXWEBSOCKET_USE_MBED_TLS)
-            socket = std::make_unique<SocketMbedTLS>(tlsOptions, fd);
-#elif defined(IXWEBSOCKET_USE_OPEN_SSL)
-            socket = std::make_unique<SocketOpenSSL>(tlsOptions, fd);
-#elif defined(__APPLE__)
-            socket = std::make_unique<SocketAppleSSL>(tlsOptions, fd);
-#endif
+# if defined(IXWEBSOCKET_USE_MBED_TLS)
+            socket = std::make_shared<SocketMbedTLS>();
+# elif defined(__APPLE__)
+            socket = std::make_shared<SocketAppleSSL>();
+# elif defined(_WIN32)
+            socket = std::make_shared<SocketSChannel>();
+# else
+            socket = std::make_shared<SocketOpenSSL>();
+# endif
 #else
             errorMsg = "TLS support is not enabled on this platform.";
             return nullptr;
@@ -60,4 +61,18 @@ namespace ix
 
         return socket;
     }
-} // namespace ix
+
+    std::shared_ptr<Socket> createSocket(int fd,
+                                         std::string& errorMsg)
+    {
+        errorMsg.clear();
+
+        std::shared_ptr<Socket> socket = std::make_shared<Socket>(fd);
+        if (!socket->init(errorMsg))
+        {
+            socket.reset();
+        }
+
+        return socket;
+    }
+}

ixwebsocket/IXSocketFactory.h

@@ -7,15 +7,13 @@
 
 #pragma once
 
-#include "IXSocketTLSOptions.h"
 #include <memory>
 #include <string>
 
 namespace ix
 {
     class Socket;
-    std::unique_ptr<Socket> createSocket(bool tls,
-                                         int fd,
-                                         std::string& errorMsg,
-                                         const SocketTLSOptions& tlsOptions);
+    std::shared_ptr<Socket> createSocket(bool tls, std::string& errorMsg);
+
+    std::shared_ptr<Socket> createSocket(int fd, std::string& errorMsg);
 } // namespace ix

ixwebsocket/IXSocketMbedTLS.cpp

@@ -1,59 +1,42 @@
 /*
  *  IXSocketMbedTLS.cpp
- *  Author: Benjamin Sergeant, Max Weisel
- *  Copyright (c) 2019-2020 Machine Zone, Inc. All rights reserved.
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
  *
  *  Some code taken from
  *  https://github.com/rottor12/WsClientLib/blob/master/lib/src/WsClientLib.cpp
  *  and mini_client.c example from mbedtls
  */
-#ifdef IXWEBSOCKET_USE_MBED_TLS
 
 #include "IXSocketMbedTLS.h"
-
+#include "IXSocketConnect.h"
 #include "IXNetSystem.h"
 #include "IXSocket.h"
-#include "IXSocketConnect.h"
+
 #include <string.h>
 
 namespace ix
 {
-    SocketMbedTLS::SocketMbedTLS(const SocketTLSOptions& tlsOptions, int fd)
-        : Socket(fd)
-        , _tlsOptions(tlsOptions)
-    {
-        initMBedTLS();
-    }
-
     SocketMbedTLS::~SocketMbedTLS()
     {
-        SocketMbedTLS::close();
+        close();
     }
 
-    void SocketMbedTLS::initMBedTLS()
+    bool SocketMbedTLS::init(const std::string& host, std::string& errMsg)
     {
         std::lock_guard<std::mutex> lock(_mutex);
 
         mbedtls_ssl_init(&_ssl);
         mbedtls_ssl_config_init(&_conf);
         mbedtls_ctr_drbg_init(&_ctr_drbg);
+
+        const char *pers = "IXSocketMbedTLS";
+
         mbedtls_entropy_init(&_entropy);
-        mbedtls_x509_crt_init(&_cacert);
-        mbedtls_x509_crt_init(&_cert);
-        mbedtls_pk_init(&_pkey);
-    }
-
-    bool SocketMbedTLS::init(const std::string& host, bool isClient, std::string& errMsg)
-    {
-        initMBedTLS();
-        std::lock_guard<std::mutex> lock(_mutex);
-
-        const char* pers = "IXSocketMbedTLS";
-
         if (mbedtls_ctr_drbg_seed(&_ctr_drbg,
                                   mbedtls_entropy_func,
                                   &_entropy,
-                                  (const unsigned char*) pers,
+                                  (const unsigned char *) pers,
                                   strlen(pers)) != 0)
         {
             errMsg = "Setting entropy seed failed";
@@ -61,9 +44,9 @@ namespace ix
         }
 
         if (mbedtls_ssl_config_defaults(&_conf,
-                                        (isClient) ? MBEDTLS_SSL_IS_CLIENT : MBEDTLS_SSL_IS_SERVER,
+                                        MBEDTLS_SSL_IS_CLIENT,
                                         MBEDTLS_SSL_TRANSPORT_STREAM,
-                                        MBEDTLS_SSL_PRESET_DEFAULT) != 0)
+                                        MBEDTLS_SSL_PRESET_DEFAULT ) != 0)
         {
             errMsg = "Setting config default failed";
             return false;
@@ -71,63 +54,8 @@ namespace ix
 
         mbedtls_ssl_conf_rng(&_conf, mbedtls_ctr_drbg_random, &_ctr_drbg);
 
-        if (_tlsOptions.hasCertAndKey())
-        {
-            if (mbedtls_x509_crt_parse_file(&_cert, _tlsOptions.certFile.c_str()) < 0)
-            {
-                errMsg = "Cannot parse cert file '" + _tlsOptions.certFile + "'";
-                return false;
-            }
-            if (mbedtls_pk_parse_keyfile(&_pkey, _tlsOptions.keyFile.c_str(), "") < 0)
-            {
-                errMsg = "Cannot parse key file '" + _tlsOptions.keyFile + "'";
-                return false;
-            }
-            if (mbedtls_ssl_conf_own_cert(&_conf, &_cert, &_pkey) < 0)
-            {
-                errMsg = "Problem configuring cert '" + _tlsOptions.certFile + "'";
-                return false;
-            }
-        }
-
-        if (_tlsOptions.isPeerVerifyDisabled())
-        {
-            mbedtls_ssl_conf_authmode(&_conf, MBEDTLS_SSL_VERIFY_NONE);
-        }
-        else
-        {
-            mbedtls_ssl_conf_authmode(&_conf, MBEDTLS_SSL_VERIFY_REQUIRED);
-
-            // FIXME: should we call mbedtls_ssl_conf_verify ?
-
-            if (_tlsOptions.isUsingSystemDefaults())
-            {
-                ; // FIXME
-            }
-            else
-            {
-                if (_tlsOptions.isUsingInMemoryCAs())
-                {
-                    const char* buffer = _tlsOptions.caFile.c_str();
-                    size_t bufferSize =
-                        _tlsOptions.caFile.size() + 1; // Needs to include null terminating
-                                                       // character otherwise mbedtls will fail.
-                    if (mbedtls_x509_crt_parse(
-                            &_cacert, (const unsigned char*) buffer, bufferSize) < 0)
-                    {
-                        errMsg = "Cannot parse CA from memory.";
-                        return false;
-                    }
-                }
-                else if (mbedtls_x509_crt_parse_file(&_cacert, _tlsOptions.caFile.c_str()) < 0)
-                {
-                    errMsg = "Cannot parse CA file '" + _tlsOptions.caFile + "'";
-                    return false;
-                }
-            }
-
-            mbedtls_ssl_conf_ca_chain(&_conf, &_cacert, NULL);
-        }
+        // FIXME: cert verification is disabled
+        mbedtls_ssl_conf_authmode(&_conf, MBEDTLS_SSL_VERIFY_NONE);
 
         if (mbedtls_ssl_setup(&_ssl, &_conf) != 0)
         {
@@ -135,7 +63,7 @@ namespace ix
             return false;
         }
 
-        if (!host.empty() && mbedtls_ssl_set_hostname(&_ssl, host.c_str()) != 0)
+        if (mbedtls_ssl_set_hostname(&_ssl, host.c_str()) != 0)
         {
             errMsg = "SNI setup failed";
             return false;
@@ -144,50 +72,6 @@ namespace ix
         return true;
     }
 
-    bool SocketMbedTLS::accept(std::string& errMsg)
-    {
-        bool isClient = false;
-        bool initialized = init(std::string(), isClient, errMsg);
-        if (!initialized)
-        {
-            close();
-            return false;
-        }
-
-        mbedtls_ssl_set_bio(&_ssl, &_sockfd, mbedtls_net_send, mbedtls_net_recv, NULL);
-
-        int res;
-        do
-        {
-            std::lock_guard<std::mutex> lock(_mutex);
-            res = mbedtls_ssl_handshake(&_ssl);
-        } while (res == MBEDTLS_ERR_SSL_WANT_READ || res == MBEDTLS_ERR_SSL_WANT_WRITE);
-
-        if (res != 0)
-        {
-            char buf[256];
-            mbedtls_strerror(res, buf, sizeof(buf));
-
-            errMsg = "error in handshake : ";
-            errMsg += buf;
-
-            if (res == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED)
-            {
-                char verifyBuf[512];
-                uint32_t flags = mbedtls_ssl_get_verify_result(&_ssl);
-
-                mbedtls_x509_crt_verify_info(verifyBuf, sizeof(verifyBuf), "  ! ", flags);
-                errMsg += " : ";
-                errMsg += verifyBuf;
-            }
-
-            close();
-            return false;
-        }
-
-        return true;
-    }
-
     bool SocketMbedTLS::connect(const std::string& host,
                                 int port,
                                 std::string& errMsg,
@@ -199,9 +83,7 @@ namespace ix
             if (_sockfd == -1) return false;
         }
 
-        bool isClient = true;
-        bool initialized = init(host, isClient, errMsg);
-        if (!initialized)
+        if (!init(host, errMsg))
         {
             close();
             return false;
@@ -212,18 +94,10 @@ namespace ix
         int res;
         do
         {
-            {
-                std::lock_guard<std::mutex> lock(_mutex);
-                res = mbedtls_ssl_handshake(&_ssl);
-            }
-
-            if (isCancellationRequested())
-            {
-                errMsg = "Cancellation requested";
-                close();
-                return false;
-            }
-        } while (res == MBEDTLS_ERR_SSL_WANT_READ || res == MBEDTLS_ERR_SSL_WANT_WRITE);
+            std::lock_guard<std::mutex> lock(_mutex);
+            res = mbedtls_ssl_handshake(&_ssl);
+        }
+        while (res == MBEDTLS_ERR_SSL_WANT_READ || res == MBEDTLS_ERR_SSL_WANT_WRITE);
 
         if (res != 0)
         {
@@ -248,31 +122,36 @@ namespace ix
         mbedtls_ssl_config_free(&_conf);
         mbedtls_ctr_drbg_free(&_ctr_drbg);
         mbedtls_entropy_free(&_entropy);
-        mbedtls_x509_crt_free(&_cacert);
-        mbedtls_x509_crt_free(&_cert);
 
         Socket::close();
     }
 
     ssize_t SocketMbedTLS::send(char* buf, size_t nbyte)
     {
-        std::lock_guard<std::mutex> lock(_mutex);
+        ssize_t sent = 0;
 
-        ssize_t res = mbedtls_ssl_write(&_ssl, (unsigned char*) buf, nbyte);
+        while (nbyte > 0)
+        {
+            std::lock_guard<std::mutex> lock(_mutex);
 
-        if (res > 0)
-        {
-            return res;
-        }
-        else if (res == MBEDTLS_ERR_SSL_WANT_READ || res == MBEDTLS_ERR_SSL_WANT_WRITE)
-        {
-            errno = EWOULDBLOCK;
-            return -1;
-        }
-        else
-        {
-            return -1;
+            ssize_t res = mbedtls_ssl_write(&_ssl, (unsigned char*) buf, nbyte);
+
+            if (res > 0) {
+                nbyte -= res;
+                sent += res;
+            } else if (res == MBEDTLS_ERR_SSL_WANT_READ || res == MBEDTLS_ERR_SSL_WANT_WRITE) {
+                errno = EWOULDBLOCK;
+                return -1;
+            } else {
+                return -1;
+            }
         }
+        return sent;
+    }
+
+    ssize_t SocketMbedTLS::send(const std::string& buffer)
+    {
+        return send((char*)&buffer[0], buffer.size());
     }
 
     ssize_t SocketMbedTLS::recv(void* buf, size_t nbyte)
@@ -296,6 +175,4 @@ namespace ix
         }
     }
 
-} // namespace ix
-
-#endif // IXWEBSOCKET_USE_MBED_TLS
+}

ixwebsocket/IXSocketMbedTLS.h

@@ -1,22 +1,18 @@
 /*
  *  IXSocketMbedTLS.h
  *  Author: Benjamin Sergeant
- *  Copyright (c) 2019-2020 Machine Zone, Inc. All rights reserved.
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
  */
-#ifdef IXWEBSOCKET_USE_MBED_TLS
 
 #pragma once
 
 #include "IXSocket.h"
-#include "IXSocketTLSOptions.h"
 #include <mbedtls/ctr_drbg.h>
 #include <mbedtls/debug.h>
 #include <mbedtls/entropy.h>
 #include <mbedtls/error.h>
 #include <mbedtls/net.h>
 #include <mbedtls/platform.h>
-#include <mbedtls/x509.h>
-#include <mbedtls/x509_crt.h>
 #include <mutex>
 
 namespace ix
@@ -24,11 +20,9 @@ namespace ix
     class SocketMbedTLS final : public Socket
     {
     public:
-        SocketMbedTLS(const SocketTLSOptions& tlsOptions, int fd = -1);
+        SocketMbedTLS() = default;
         ~SocketMbedTLS();
 
-        virtual bool accept(std::string& errMsg) final;
-
         virtual bool connect(const std::string& host,
                              int port,
                              std::string& errMsg,
@@ -36,6 +30,7 @@ namespace ix
         virtual void close() final;
 
         virtual ssize_t send(char* buffer, size_t length) final;
+        virtual ssize_t send(const std::string& buffer) final;
         virtual ssize_t recv(void* buffer, size_t length) final;
 
     private:
@@ -43,17 +38,10 @@ namespace ix
         mbedtls_ssl_config _conf;
         mbedtls_entropy_context _entropy;
         mbedtls_ctr_drbg_context _ctr_drbg;
-        mbedtls_x509_crt _cacert;
-        mbedtls_x509_crt _cert;
-        mbedtls_pk_context _pkey;
 
         std::mutex _mutex;
-        SocketTLSOptions _tlsOptions;
 
-        bool init(const std::string& host, bool isClient, std::string& errMsg);
-        void initMBedTLS();
+        bool init(const std::string& host, std::string& errMsg);
     };
 
 } // namespace ix
-
-#endif // IXWEBSOCKET_USE_MBED_TLS

ixwebsocket/IXSocketOpenSSL.cpp

@@ -1,96 +1,30 @@
 /*
  *  IXSocketOpenSSL.cpp
- *  Author: Benjamin Sergeant, Matt DeBoer, Max Weisel
- *  Copyright (c) 2017-2020 Machine Zone, Inc. All rights reserved.
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
  *
  *  Adapted from Satori SDK OpenSSL code.
  */
-#ifdef IXWEBSOCKET_USE_OPEN_SSL
 
 #include "IXSocketOpenSSL.h"
-
 #include "IXSocketConnect.h"
+
 #include <cassert>
-#include <errno.h>
-#ifdef _WIN32
-#include <Shlwapi.h>
-#else
-#include <fnmatch.h>
-#endif
-#if OPENSSL_VERSION_NUMBER < 0x10100000L
+
 #include <openssl/x509v3.h>
-#endif
+
+#include <fnmatch.h>
+#include <errno.h>
 #define socketerrno errno
 
-#ifdef _WIN32
-namespace
-{
-    bool loadWindowsSystemCertificates(SSL_CTX* ssl, std::string& errorMsg)
-    {
-        DWORD flags = CERT_STORE_READONLY_FLAG | CERT_STORE_OPEN_EXISTING_FLAG |
-                      CERT_SYSTEM_STORE_CURRENT_USER;
-        HCERTSTORE systemStore = CertOpenStore(CERT_STORE_PROV_SYSTEM, 0, 0, flags, L"Root");
-
-        if (!systemStore)
-        {
-            errorMsg = "CertOpenStore failed with ";
-            errorMsg += std::to_string(GetLastError());
-            return false;
-        }
-
-        PCCERT_CONTEXT certificateIterator = NULL;
-        X509_STORE* opensslStore = SSL_CTX_get_cert_store(ssl);
-
-        int certificateCount = 0;
-        while (certificateIterator = CertEnumCertificatesInStore(systemStore, certificateIterator))
-        {
-            X509* x509 = d2i_X509(NULL,
-                                  (const unsigned char**) &certificateIterator->pbCertEncoded,
-                                  certificateIterator->cbCertEncoded);
-
-            if (x509)
-            {
-                if (X509_STORE_add_cert(opensslStore, x509) == 1)
-                {
-                    ++certificateCount;
-                }
-
-                X509_free(x509);
-            }
-        }
-
-        CertFreeCertificateContext(certificateIterator);
-        CertCloseStore(systemStore, 0);
-
-        if (certificateCount == 0)
-        {
-            errorMsg = "No certificates found";
-            return false;
-        }
-
-        return true;
-    }
-} // namespace
-#endif
-
 namespace ix
 {
-    const std::string kDefaultCiphers =
-        "ECDHE-ECDSA-AES128-GCM-SHA256 ECDHE-ECDSA-AES256-GCM-SHA384 ECDHE-ECDSA-AES128-SHA "
-        "ECDHE-ECDSA-AES256-SHA ECDHE-ECDSA-AES128-SHA256 ECDHE-ECDSA-AES256-SHA384 "
-        "ECDHE-RSA-AES128-GCM-SHA256 ECDHE-RSA-AES256-GCM-SHA384 ECDHE-RSA-AES128-SHA "
-        "ECDHE-RSA-AES256-SHA ECDHE-RSA-AES128-SHA256 ECDHE-RSA-AES256-SHA384 "
-        "DHE-RSA-AES128-GCM-SHA256 DHE-RSA-AES256-GCM-SHA384 DHE-RSA-AES128-SHA "
-        "DHE-RSA-AES256-SHA DHE-RSA-AES128-SHA256 DHE-RSA-AES256-SHA256 AES128-SHA";
-
     std::atomic<bool> SocketOpenSSL::_openSSLInitializationSuccessful(false);
     std::once_flag SocketOpenSSL::_openSSLInitFlag;
 
-    SocketOpenSSL::SocketOpenSSL(const SocketTLSOptions& tlsOptions, int fd)
-        : Socket(fd)
-        , _ssl_connection(nullptr)
-        , _ssl_context(nullptr)
-        , _tlsOptions(tlsOptions)
+    SocketOpenSSL::SocketOpenSSL(int fd) : Socket(fd),
+        _ssl_connection(nullptr),
+        _ssl_context(nullptr)
     {
         std::call_once(_openSSLInitFlag, &SocketOpenSSL::openSSLInitialize, this);
     }
@@ -180,98 +114,32 @@ namespace ix
         SSL_CTX* ctx = SSL_CTX_new(_ssl_method);
         if (ctx)
         {
-            SSL_CTX_set_mode(ctx,
-                             SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
+            // To skip verification, pass in SSL_VERIFY_NONE
+            SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER,
+                               [](int preverify, X509_STORE_CTX*) -> int
+                               {
+                                   return preverify;
+                               });
 
-            int options = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_CIPHER_SERVER_PREFERENCE;
-
-#ifdef SSL_OP_NO_TLSv1_3
-            // (partially?) work around hang in openssl 1.1.1b, by disabling TLS V1.3
-            // https://github.com/openssl/openssl/issues/7967
-            options |= SSL_OP_NO_TLSv1_3;
-#endif
-            SSL_CTX_set_options(ctx, options);
+            SSL_CTX_set_verify_depth(ctx, 4);
+            SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3);
         }
         return ctx;
     }
 
-    bool SocketOpenSSL::openSSLAddCARootsFromString(const std::string roots)
-    {
-        // Create certificate store
-        X509_STORE* certificate_store = SSL_CTX_get_cert_store(_ssl_context);
-        if (certificate_store == nullptr) return false;
-
-        // Configure to allow intermediate certs
-        X509_STORE_set_flags(certificate_store,
-                             X509_V_FLAG_TRUSTED_FIRST | X509_V_FLAG_PARTIAL_CHAIN);
-
-        // Create a new buffer and populate it with the roots
-        BIO* buffer = BIO_new_mem_buf((void*) roots.c_str(), static_cast<int>(roots.length()));
-        if (buffer == nullptr) return false;
-
-        // Read each root in the buffer and add to the certificate store
-        bool success = true;
-        size_t number_of_roots = 0;
-
-        while (true)
-        {
-            // Read the next root in the buffer
-            X509* root = PEM_read_bio_X509_AUX(buffer, nullptr, nullptr, (void*) "");
-            if (root == nullptr)
-            {
-                // No more certs left in the buffer, we're done.
-                ERR_clear_error();
-                break;
-            }
-
-            // Try adding the root to the certificate store
-            ERR_clear_error();
-            if (!X509_STORE_add_cert(certificate_store, root))
-            {
-                // Failed to add. If the error is unrelated to the x509 lib or the cert already
-                // exists, we're safe to continue.
-                unsigned long error = ERR_get_error();
-                if (ERR_GET_LIB(error) != ERR_LIB_X509 ||
-                    ERR_GET_REASON(error) != X509_R_CERT_ALREADY_IN_HASH_TABLE)
-                {
-                    // Failed. Clean up and bail.
-                    success = false;
-                    X509_free(root);
-                    break;
-                }
-            }
-
-            // Clean up and loop
-            X509_free(root);
-            number_of_roots++;
-        }
-
-        // Clean up buffer
-        BIO_free(buffer);
-
-        // Make sure we loaded at least one certificate.
-        if (number_of_roots == 0) success = false;
-
-        return success;
-    }
-
     /**
      * Check whether a hostname matches a pattern
      */
-    bool SocketOpenSSL::checkHost(const std::string& host, const char* pattern)
+    bool SocketOpenSSL::checkHost(const std::string& host, const char *pattern)
     {
-#ifdef _WIN32
-        return PathMatchSpecA(host.c_str(), pattern);
-#else
         return fnmatch(pattern, host.c_str(), 0) != FNM_NOMATCH;
-#endif
     }
 
-    bool SocketOpenSSL::openSSLCheckServerCert(SSL* ssl,
+    bool SocketOpenSSL::openSSLCheckServerCert(SSL *ssl,
                                                const std::string& hostname,
                                                std::string& errMsg)
     {
-        X509* server_cert = SSL_get_peer_certificate(ssl);
+        X509 *server_cert = SSL_get_peer_certificate(ssl);
         if (server_cert == nullptr)
         {
             errMsg = "OpenSSL failed - peer didn't present a X509 certificate.";
@@ -281,17 +149,18 @@ namespace ix
 #if OPENSSL_VERSION_NUMBER < 0x10100000L
         // Check server name
         bool hostname_verifies_ok = false;
-        STACK_OF(GENERAL_NAME)* san_names = (STACK_OF(GENERAL_NAME)*) X509_get_ext_d2i(
-            (X509*) server_cert, NID_subject_alt_name, NULL, NULL);
+        STACK_OF(GENERAL_NAME) *san_names =
+            (STACK_OF(GENERAL_NAME)*) X509_get_ext_d2i((X509 *)server_cert,
+                                                       NID_subject_alt_name, NULL, NULL);
         if (san_names)
         {
-            for (int i = 0; i < sk_GENERAL_NAME_num(san_names); i++)
+            for (int i=0; i<sk_GENERAL_NAME_num(san_names); i++)
             {
-                const GENERAL_NAME* sk_name = sk_GENERAL_NAME_value(san_names, i);
+                const GENERAL_NAME *sk_name = sk_GENERAL_NAME_value(san_names, i);
                 if (sk_name->type == GEN_DNS)
                 {
-                    char* name = (char*) ASN1_STRING_data(sk_name->d.dNSName);
-                    if ((size_t) ASN1_STRING_length(sk_name->d.dNSName) == strlen(name) &&
+                    char *name = (char *)ASN1_STRING_data(sk_name->d.dNSName);
+                    if ((size_t)ASN1_STRING_length(sk_name->d.dNSName) == strlen(name) &&
                         checkHost(hostname, name))
                     {
                         hostname_verifies_ok = true;
@@ -304,20 +173,20 @@ namespace ix
 
         if (!hostname_verifies_ok)
         {
-            int cn_pos = X509_NAME_get_index_by_NID(
-                X509_get_subject_name((X509*) server_cert), NID_commonName, -1);
+            int cn_pos = X509_NAME_get_index_by_NID(X509_get_subject_name((X509 *)server_cert),
+                                                    NID_commonName, -1);
             if (cn_pos)
             {
-                X509_NAME_ENTRY* cn_entry =
-                    X509_NAME_get_entry(X509_get_subject_name((X509*) server_cert), cn_pos);
+                X509_NAME_ENTRY *cn_entry = X509_NAME_get_entry(
+                    X509_get_subject_name((X509 *)server_cert), cn_pos);
 
                 if (cn_entry)
                 {
-                    ASN1_STRING* cn_asn1 = X509_NAME_ENTRY_get_data(cn_entry);
-                    char* cn = (char*) ASN1_STRING_data(cn_asn1);
+                    ASN1_STRING *cn_asn1 = X509_NAME_ENTRY_get_data(cn_entry);
+                    char *cn = (char *)ASN1_STRING_data(cn_asn1);
 
-                    if ((size_t) ASN1_STRING_length(cn_asn1) == strlen(cn) &&
-                        checkHost(hostname, cn))
+                    if ((size_t)ASN1_STRING_length(cn_asn1) == strlen(cn) &&
+                       checkHost(hostname, cn))
                     {
                         hostname_verifies_ok = true;
                     }
@@ -336,9 +205,7 @@ namespace ix
         return true;
     }
 
-    bool SocketOpenSSL::openSSLClientHandshake(const std::string& host,
-                                               std::string& errMsg,
-                                               const CancellationRequest& isCancellationRequested)
+    bool SocketOpenSSL::openSSLHandshake(const std::string& host, std::string& errMsg)
     {
         while (true)
         {
@@ -347,12 +214,6 @@ namespace ix
                 return false;
             }
 
-            if (isCancellationRequested())
-            {
-                errMsg = "Cancellation requested";
-                return false;
-            }
-
             ERR_clear_error();
             int connect_result = SSL_connect(_ssl_connection);
             if (connect_result == 1)
@@ -379,302 +240,6 @@ namespace ix
         }
     }
 
-    bool SocketOpenSSL::openSSLServerHandshake(std::string& errMsg)
-    {
-        while (true)
-        {
-            if (_ssl_connection == nullptr || _ssl_context == nullptr)
-            {
-                return false;
-            }
-
-            ERR_clear_error();
-            int accept_result = SSL_accept(_ssl_connection);
-            if (accept_result == 1)
-            {
-                return true;
-            }
-            int reason = SSL_get_error(_ssl_connection, accept_result);
-
-            bool rc = false;
-            if (reason == SSL_ERROR_WANT_READ || reason == SSL_ERROR_WANT_WRITE)
-            {
-                rc = true;
-            }
-            else
-            {
-                errMsg = getSSLError(accept_result);
-                rc = false;
-            }
-
-            if (!rc)
-            {
-                return false;
-            }
-        }
-    }
-
-    bool SocketOpenSSL::handleTLSOptions(std::string& errMsg)
-    {
-        ERR_clear_error();
-        if (_tlsOptions.hasCertAndKey())
-        {
-            if (SSL_CTX_use_certificate_chain_file(_ssl_context, _tlsOptions.certFile.c_str()) != 1)
-            {
-                auto sslErr = ERR_get_error();
-                errMsg = "OpenSSL failed - SSL_CTX_use_certificate_chain_file(\"" +
-                         _tlsOptions.certFile + "\") failed: ";
-                errMsg += ERR_error_string(sslErr, nullptr);
-            }
-            else if (SSL_CTX_use_PrivateKey_file(
-                         _ssl_context, _tlsOptions.keyFile.c_str(), SSL_FILETYPE_PEM) != 1)
-            {
-                auto sslErr = ERR_get_error();
-                errMsg = "OpenSSL failed - SSL_CTX_use_PrivateKey_file(\"" + _tlsOptions.keyFile +
-                         "\") failed: ";
-                errMsg += ERR_error_string(sslErr, nullptr);
-            }
-            else if (!SSL_CTX_check_private_key(_ssl_context))
-            {
-                auto sslErr = ERR_get_error();
-                errMsg = "OpenSSL failed - cert/key mismatch(\"" + _tlsOptions.certFile + ", " +
-                         _tlsOptions.keyFile + "\")";
-                errMsg += ERR_error_string(sslErr, nullptr);
-            }
-        }
-
-        ERR_clear_error();
-        if (!_tlsOptions.isPeerVerifyDisabled())
-        {
-            if (_tlsOptions.isUsingSystemDefaults())
-            {
-#ifdef _WIN32
-                if (!loadWindowsSystemCertificates(_ssl_context, errMsg))
-                {
-                    return false;
-                }
-#else
-                if (SSL_CTX_set_default_verify_paths(_ssl_context) == 0)
-                {
-                    auto sslErr = ERR_get_error();
-                    errMsg = "OpenSSL failed - SSL_CTX_default_verify_paths loading failed: ";
-                    errMsg += ERR_error_string(sslErr, nullptr);
-                    return false;
-                }
-#endif
-            }
-            else
-            {
-                if (_tlsOptions.isUsingInMemoryCAs())
-                {
-                    // Load from memory
-                    openSSLAddCARootsFromString(_tlsOptions.caFile);
-                }
-                else
-                {
-                    if (SSL_CTX_load_verify_locations(
-                            _ssl_context, _tlsOptions.caFile.c_str(), NULL) != 1)
-                    {
-                        auto sslErr = ERR_get_error();
-                        errMsg = "OpenSSL failed - SSL_CTX_load_verify_locations(\"" +
-                                 _tlsOptions.caFile + "\") failed: ";
-                        errMsg += ERR_error_string(sslErr, nullptr);
-                        return false;
-                    }
-
-                    SSL_CTX_set_verify(
-                        _ssl_context, SSL_VERIFY_PEER, [](int preverify, X509_STORE_CTX*) -> int {
-                            return preverify;
-                        });
-                    SSL_CTX_set_verify_depth(_ssl_context, 4);
-                }
-            }
-        }
-        else
-        {
-            SSL_CTX_set_verify(_ssl_context, SSL_VERIFY_NONE, nullptr);
-        }
-
-        if (_tlsOptions.isUsingDefaultCiphers())
-        {
-            if (SSL_CTX_set_cipher_list(_ssl_context, kDefaultCiphers.c_str()) != 1)
-            {
-                auto sslErr = ERR_get_error();
-                errMsg = "OpenSSL failed - SSL_CTX_set_cipher_list(\"" + kDefaultCiphers +
-                         "\") failed: ";
-                errMsg += ERR_error_string(sslErr, nullptr);
-                return false;
-            }
-        }
-        else if (SSL_CTX_set_cipher_list(_ssl_context, _tlsOptions.ciphers.c_str()) != 1)
-        {
-            auto sslErr = ERR_get_error();
-            errMsg = "OpenSSL failed - SSL_CTX_set_cipher_list(\"" + _tlsOptions.ciphers +
-                     "\") failed: ";
-            errMsg += ERR_error_string(sslErr, nullptr);
-            return false;
-        }
-
-        return true;
-    }
-
-    bool SocketOpenSSL::accept(std::string& errMsg)
-    {
-        bool handshakeSuccessful = false;
-        {
-            std::lock_guard<std::mutex> lock(_mutex);
-
-            if (!_openSSLInitializationSuccessful)
-            {
-                errMsg = "OPENSSL_init_ssl failure";
-                return false;
-            }
-
-            if (_sockfd == -1)
-            {
-                return false;
-            }
-
-            {
-                const SSL_METHOD* method = SSLv23_server_method();
-                if (method == nullptr)
-                {
-                    errMsg = "SSLv23_server_method failure";
-                    _ssl_context = nullptr;
-                }
-                else
-                {
-                    _ssl_method = method;
-
-                    _ssl_context = SSL_CTX_new(_ssl_method);
-                    if (_ssl_context)
-                    {
-                        SSL_CTX_set_mode(_ssl_context, SSL_MODE_ENABLE_PARTIAL_WRITE);
-                        SSL_CTX_set_mode(_ssl_context, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
-                        SSL_CTX_set_options(_ssl_context,
-                                            SSL_OP_ALL | SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3);
-                    }
-                }
-            }
-
-            if (_ssl_context == nullptr)
-            {
-                return false;
-            }
-
-            ERR_clear_error();
-            if (_tlsOptions.hasCertAndKey())
-            {
-                if (SSL_CTX_use_certificate_chain_file(_ssl_context,
-                                                       _tlsOptions.certFile.c_str()) != 1)
-                {
-                    auto sslErr = ERR_get_error();
-                    errMsg = "OpenSSL failed - SSL_CTX_use_certificate_chain_file(\"" +
-                             _tlsOptions.certFile + "\") failed: ";
-                    errMsg += ERR_error_string(sslErr, nullptr);
-                }
-                else if (SSL_CTX_use_PrivateKey_file(
-                             _ssl_context, _tlsOptions.keyFile.c_str(), SSL_FILETYPE_PEM) != 1)
-                {
-                    auto sslErr = ERR_get_error();
-                    errMsg = "OpenSSL failed - SSL_CTX_use_PrivateKey_file(\"" +
-                             _tlsOptions.keyFile + "\") failed: ";
-                    errMsg += ERR_error_string(sslErr, nullptr);
-                }
-            }
-
-
-            ERR_clear_error();
-            if (!_tlsOptions.isPeerVerifyDisabled())
-            {
-                if (_tlsOptions.isUsingSystemDefaults())
-                {
-                    if (SSL_CTX_set_default_verify_paths(_ssl_context) == 0)
-                    {
-                        auto sslErr = ERR_get_error();
-                        errMsg = "OpenSSL failed - SSL_CTX_default_verify_paths loading failed: ";
-                        errMsg += ERR_error_string(sslErr, nullptr);
-                    }
-                }
-                else
-                {
-                    if (_tlsOptions.isUsingInMemoryCAs())
-                    {
-                        // Load from memory
-                        openSSLAddCARootsFromString(_tlsOptions.caFile);
-                    }
-                    else
-                    {
-                        const char* root_ca_file = _tlsOptions.caFile.c_str();
-                        STACK_OF(X509_NAME) * rootCAs;
-                        rootCAs = SSL_load_client_CA_file(root_ca_file);
-                        if (rootCAs == NULL)
-                        {
-                            auto sslErr = ERR_get_error();
-                            errMsg = "OpenSSL failed - SSL_load_client_CA_file('" +
-                                     _tlsOptions.caFile + "') failed: ";
-                            errMsg += ERR_error_string(sslErr, nullptr);
-                        }
-                        else
-                        {
-                            SSL_CTX_set_client_CA_list(_ssl_context, rootCAs);
-                            if (SSL_CTX_load_verify_locations(
-                                    _ssl_context, root_ca_file, nullptr) != 1)
-                            {
-                                auto sslErr = ERR_get_error();
-                                errMsg = "OpenSSL failed - SSL_CTX_load_verify_locations(\"" +
-                                         _tlsOptions.caFile + "\") failed: ";
-                                errMsg += ERR_error_string(sslErr, nullptr);
-                            }
-                        }
-                    }
-                }
-
-                SSL_CTX_set_verify(
-                    _ssl_context, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT, nullptr);
-                SSL_CTX_set_verify_depth(_ssl_context, 4);
-            }
-            else
-            {
-                SSL_CTX_set_verify(_ssl_context, SSL_VERIFY_NONE, nullptr);
-            }
-            if (_tlsOptions.isUsingDefaultCiphers())
-            {
-                if (SSL_CTX_set_cipher_list(_ssl_context, kDefaultCiphers.c_str()) != 1)
-                {
-                    return false;
-                }
-            }
-            else if (SSL_CTX_set_cipher_list(_ssl_context, _tlsOptions.ciphers.c_str()) != 1)
-            {
-                return false;
-            }
-
-            _ssl_connection = SSL_new(_ssl_context);
-            if (_ssl_connection == nullptr)
-            {
-                errMsg = "OpenSSL failed to connect";
-                SSL_CTX_free(_ssl_context);
-                _ssl_context = nullptr;
-                return false;
-            }
-
-            SSL_set_ecdh_auto(_ssl_connection, 1);
-
-            SSL_set_fd(_ssl_connection, _sockfd);
-
-            handshakeSuccessful = openSSLServerHandshake(errMsg);
-        }
-
-        if (!handshakeSuccessful)
-        {
-            close();
-            return false;
-        }
-
-        return true;
-    }
-
     bool SocketOpenSSL::connect(const std::string& host,
                                 int port,
                                 std::string& errMsg,
@@ -699,9 +264,13 @@ namespace ix
                 return false;
             }
 
-            if (!handleTLSOptions(errMsg))
+            ERR_clear_error();
+            int cert_load_result = SSL_CTX_set_default_verify_paths(_ssl_context);
+            if (cert_load_result == 0)
             {
-                return false;
+                unsigned long ssl_err = ERR_get_error();
+                errMsg = "OpenSSL failed - SSL_CTX_default_verify_paths loading failed: ";
+                errMsg += ERR_error_string(ssl_err, nullptr);
             }
 
             _ssl_connection = SSL_new(_ssl_context);
@@ -720,12 +289,13 @@ namespace ix
 #if OPENSSL_VERSION_NUMBER >= 0x10002000L
             // Support for server name verification
             // (The docs say that this should work from 1.0.2, and is the default from
-            // 1.1.0, but it does not. To be on the safe side, the manual test
-            // below is enabled for all versions prior to 1.1.0.)
-            X509_VERIFY_PARAM* param = SSL_get0_param(_ssl_connection);
+            // 1.1.0, but it does not. To be on the safe side, the manual test below is
+            // enabled for all versions prior to 1.1.0.)
+            X509_VERIFY_PARAM *param = SSL_get0_param(_ssl_connection);
             X509_VERIFY_PARAM_set1_host(param, host.c_str(), 0);
 #endif
-            handshakeSuccessful = openSSLClientHandshake(host, errMsg, isCancellationRequested);
+
+            handshakeSuccessful = openSSLHandshake(host, errMsg);
         }
 
         if (!handshakeSuccessful)
@@ -757,30 +327,37 @@ namespace ix
 
     ssize_t SocketOpenSSL::send(char* buf, size_t nbyte)
     {
-        std::lock_guard<std::mutex> lock(_mutex);
+        ssize_t sent = 0;
 
-        if (_ssl_connection == nullptr || _ssl_context == nullptr)
+        while (nbyte > 0)
         {
-            return 0;
-        }
+            std::lock_guard<std::mutex> lock(_mutex);
 
-        ERR_clear_error();
-        ssize_t write_result = SSL_write(_ssl_connection, buf, (int) nbyte);
-        int reason = SSL_get_error(_ssl_connection, (int) write_result);
+            if (_ssl_connection == nullptr || _ssl_context == nullptr)
+            {
+                return 0;
+            }
 
-        if (reason == SSL_ERROR_NONE)
-        {
-            return write_result;
-        }
-        else if (reason == SSL_ERROR_WANT_READ || reason == SSL_ERROR_WANT_WRITE)
-        {
-            errno = EWOULDBLOCK;
-            return -1;
-        }
-        else
-        {
-            return -1;
+            ERR_clear_error();
+            ssize_t write_result = SSL_write(_ssl_connection, buf + sent, (int) nbyte);
+            int reason = SSL_get_error(_ssl_connection, (int) write_result);
+
+            if (reason == SSL_ERROR_NONE) {
+                nbyte -= write_result;
+                sent += write_result;
+            } else if (reason == SSL_ERROR_WANT_READ || reason == SSL_ERROR_WANT_WRITE) {
+                errno = EWOULDBLOCK;
+                return -1;
+            } else {
+                return -1;
+            }
         }
+        return sent;
+    }
+
+    ssize_t SocketOpenSSL::send(const std::string& buffer)
+    {
+        return send((char*)&buffer[0], buffer.size());
     }
 
     ssize_t SocketOpenSSL::recv(void* buf, size_t nbyte)
@@ -812,6 +389,4 @@ namespace ix
         }
     }
 
-} // namespace ix
-
-#endif // IXWEBSOCKET_USE_OPEN_SSL
+}

ixwebsocket/IXSocketOpenSSL.h

@@ -1,15 +1,13 @@
 /*
  *  IXSocketOpenSSL.h
- *  Author: Benjamin Sergeant, Matt DeBoer
- *  Copyright (c) 2017-2020 Machine Zone, Inc. All rights reserved.
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
  */
-#ifdef IXWEBSOCKET_USE_OPEN_SSL
 
 #pragma once
 
 #include "IXCancellationRequest.h"
 #include "IXSocket.h"
-#include "IXSocketTLSOptions.h"
 #include <mutex>
 #include <openssl/bio.h>
 #include <openssl/conf.h>
@@ -22,11 +20,9 @@ namespace ix
     class SocketOpenSSL final : public Socket
     {
     public:
-        SocketOpenSSL(const SocketTLSOptions& tlsOptions, int fd = -1);
+        SocketOpenSSL(int fd = -1);
         ~SocketOpenSSL();
 
-        virtual bool accept(std::string& errMsg) final;
-
         virtual bool connect(const std::string& host,
                              int port,
                              std::string& errMsg,
@@ -34,26 +30,20 @@ namespace ix
         virtual void close() final;
 
         virtual ssize_t send(char* buffer, size_t length) final;
+        virtual ssize_t send(const std::string& buffer) final;
         virtual ssize_t recv(void* buffer, size_t length) final;
 
     private:
         void openSSLInitialize();
         std::string getSSLError(int ret);
         SSL_CTX* openSSLCreateContext(std::string& errMsg);
-        bool openSSLAddCARootsFromString(const std::string roots);
-        bool openSSLClientHandshake(const std::string& hostname,
-                                    std::string& errMsg,
-                                    const CancellationRequest& isCancellationRequested);
+        bool openSSLHandshake(const std::string& hostname, std::string& errMsg);
         bool openSSLCheckServerCert(SSL* ssl, const std::string& hostname, std::string& errMsg);
         bool checkHost(const std::string& host, const char* pattern);
-        bool handleTLSOptions(std::string& errMsg);
-        bool openSSLServerHandshake(std::string& errMsg);
 
         SSL* _ssl_connection;
         SSL_CTX* _ssl_context;
         const SSL_METHOD* _ssl_method;
-        SocketTLSOptions _tlsOptions;
-
         mutable std::mutex _mutex; // OpenSSL routines are not thread-safe
 
         static std::once_flag _openSSLInitFlag;
@@ -61,5 +51,3 @@ namespace ix
     };
 
 } // namespace ix
-
-#endif // IXWEBSOCKET_USE_OPEN_SSL

ixwebsocket/IXSocketSChannel.cpp

@@ -0,0 +1,106 @@
+/*
+ *  IXSocketSChannel.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
+ *
+ *  See https://docs.microsoft.com/en-us/windows/desktop/WinSock/using-secure-socket-extensions
+ *
+ *  https://github.com/pauldotknopf/WindowsSDK7-Samples/blob/master/netds/winsock/securesocket/stcpclient/tcpclient.c
+ *
+ *  This is the right example to look at:
+ *  https://www.codeproject.com/Articles/1000189/A-Working-TCP-Client-and-Server-With-SSL
+ */
+#include "IXSocketSChannel.h"
+
+#ifdef _WIN32
+# include <basetsd.h>
+# include <WinSock2.h>
+# include <ws2def.h>
+# include <WS2tcpip.h>
+# include <schannel.h>
+# include <io.h>
+
+#define WIN32_LEAN_AND_MEAN
+
+#ifndef UNICODE
+#define UNICODE
+#endif
+
+#include <windows.h>
+#include <winsock2.h>
+#include <mstcpip.h>
+#include <ws2tcpip.h>
+#include <rpc.h>
+#include <ntdsapi.h>
+#include <stdio.h>
+#include <tchar.h>
+
+#define RECV_DATA_BUF_SIZE 256
+
+// Link with ws2_32.lib
+#pragma comment(lib, "Ws2_32.lib")
+
+// link with fwpuclnt.lib for Winsock secure socket extensions
+#pragma comment(lib, "fwpuclnt.lib")
+
+// link with ntdsapi.lib for DsMakeSpn function
+#pragma comment(lib, "ntdsapi.lib")
+
+// The following function assumes that Winsock
+// has already been initialized
+
+
+
+
+
+
+#else
+# error("This file should only be built on Windows")
+#endif
+
+namespace ix
+{
+    SocketSChannel::SocketSChannel()
+    {
+        ;
+    }
+
+    SocketSChannel::~SocketSChannel()
+    {
+
+    }
+
+    bool SocketSChannel::connect(const std::string& host,
+                                 int port,
+                                 std::string& errMsg)
+    {
+        return Socket::connect(host, port, errMsg, nullptr);
+    }
+
+
+    void SocketSChannel::secureSocket()
+    {
+        // there will be a lot to do here ...
+    }
+
+    void SocketSChannel::close()
+    {
+        Socket::close();
+    }
+
+    ssize_t SocketSChannel::send(char* buf, size_t nbyte)
+    {
+        return Socket::send(buf, nbyte);
+    }
+
+    ssize_t SocketSChannel::send(const std::string& buffer)
+    {
+        return Socket::send(buffer);
+    }
+
+    ssize_t SocketSChannel::recv(void* buf, size_t nbyte)
+    {
+        return Socket::recv(buf, nbyte);
+    }
+
+}

ixwebsocket/IXSocketSChannel.h

@@ -0,0 +1,32 @@
+/*
+ *  IXSocketSChannel.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include "IXSocket.h"
+
+namespace ix
+{
+    class SocketSChannel final : public Socket
+    {
+    public:
+        SocketSChannel();
+        ~SocketSChannel();
+
+        virtual bool connect(const std::string& host, int port, std::string& errMsg) final;
+        virtual void close() final;
+
+        // The important override
+        virtual void secureSocket() final;
+
+        virtual ssize_t send(char* buffer, size_t length) final;
+        virtual ssize_t send(const std::string& buffer) final;
+        virtual ssize_t recv(void* buffer, size_t length) final;
+
+    private:
+    };
+
+} // namespace ix

ixwebsocket/IXSocketServer.cpp

@@ -5,17 +5,14 @@
  */
 
 #include "IXSocketServer.h"
-
-#include "IXNetSystem.h"
-#include "IXSelectInterrupt.h"
-#include "IXSetThreadName.h"
 #include "IXSocket.h"
 #include "IXSocketConnect.h"
-#include "IXSocketFactory.h"
-#include <assert.h>
+#include "IXNetSystem.h"
+
+#include <iostream>
 #include <sstream>
-#include <stdio.h>
 #include <string.h>
+#include <assert.h>
 
 namespace ix
 {
@@ -23,20 +20,21 @@ namespace ix
     const std::string SocketServer::kDefaultHost("127.0.0.1");
     const int SocketServer::kDefaultTcpBacklog(5);
     const size_t SocketServer::kDefaultMaxConnections(32);
-    const int SocketServer::kDefaultAddressFamily(AF_INET);
 
-    SocketServer::SocketServer(
-        int port, const std::string& host, int backlog, size_t maxConnections, int addressFamily)
-        : _port(port)
-        , _host(host)
-        , _backlog(backlog)
-        , _maxConnections(maxConnections)
-        , _addressFamily(addressFamily)
-        , _serverFd(-1)
-        , _stop(false)
-        , _stopGc(false)
-        , _connectionStateFactory(&ConnectionState::createConnectionState)
+    SocketServer::SocketServer(int port,
+                               const std::string& host,
+                               int backlog,
+                               size_t maxConnections) :
+        _port(port),
+        _host(host),
+        _backlog(backlog),
+        _maxConnections(maxConnections),
+        _serverFd(-1),
+        _stop(false),
+        _stopGc(false),
+        _connectionStateFactory(&ConnectionState::createConnectionState)
     {
+
     }
 
     SocketServer::~SocketServer()
@@ -47,102 +45,65 @@ namespace ix
     void SocketServer::logError(const std::string& str)
     {
         std::lock_guard<std::mutex> lock(_logMutex);
-        fprintf(stderr, "%s\n", str.c_str());
+        std::cerr << str << std::endl;
     }
 
     void SocketServer::logInfo(const std::string& str)
     {
         std::lock_guard<std::mutex> lock(_logMutex);
-        fprintf(stdout, "%s\n", str.c_str());
+        std::cout << str << std::endl;
     }
 
     std::pair<bool, std::string> SocketServer::listen()
     {
-        if (_addressFamily != AF_INET && _addressFamily != AF_INET6)
-        {
-            std::string errMsg("SocketServer::listen() AF_INET and AF_INET6 are currently "
-                               "the only supported address families");
-            return std::make_pair(false, errMsg);
-        }
+        struct sockaddr_in server; // server address information
 
         // Get a socket for accepting connections.
-        if ((_serverFd = socket(_addressFamily, SOCK_STREAM, 0)) < 0)
+        if ((_serverFd = socket(AF_INET, SOCK_STREAM, 0)) < 0)
         {
             std::stringstream ss;
-            ss << "SocketServer::listen() error creating socket): " << strerror(Socket::getErrno());
+            ss << "SocketServer::listen() error creating socket): "
+               << strerror(Socket::getErrno());
 
             return std::make_pair(false, ss.str());
         }
 
         // Make that socket reusable. (allow restarting this server at will)
         int enable = 1;
-        if (setsockopt(_serverFd, SOL_SOCKET, SO_REUSEADDR, (char*) &enable, sizeof(enable)) < 0)
+        if (setsockopt(_serverFd, SOL_SOCKET, SO_REUSEADDR,
+                       (char*) &enable, sizeof(enable)) < 0)
         {
             std::stringstream ss;
             ss << "SocketServer::listen() error calling setsockopt(SO_REUSEADDR) "
-               << "at address " << _host << ":" << _port << " : " << strerror(Socket::getErrno());
+               << "at address " << _host << ":" << _port
+               << " : " << strerror(Socket::getErrno());
 
             Socket::closeSocket(_serverFd);
             return std::make_pair(false, ss.str());
         }
 
-        if (_addressFamily == AF_INET)
+        // Bind the socket to the server address.
+        server.sin_family = AF_INET;
+        server.sin_port   = htons(_port);
+
+        // Using INADDR_ANY trigger a pop-up box as binding to any address is detected
+        // by the osx firewall. We need to codesign the binary with a self-signed cert
+        // to allow that, but this is a bit of a pain. (this is what node or python would do).
+        //
+        // Using INADDR_LOOPBACK also does not work ... while it should.
+        // We default to 127.0.0.1 (localhost)
+        //
+        server.sin_addr.s_addr = inet_addr(_host.c_str());
+
+        if (bind(_serverFd, (struct sockaddr *)&server, sizeof(server)) < 0)
         {
-            struct sockaddr_in server;
-            server.sin_family = _addressFamily;
-            server.sin_port = htons(_port);
+            std::stringstream ss;
+            ss << "SocketServer::listen() error calling bind "
+               << "at address " << _host << ":" << _port
+               << " : " << strerror(Socket::getErrno());
 
-            if (inet_pton(_addressFamily, _host.c_str(), &server.sin_addr.s_addr) <= 0)
-            {
-                std::stringstream ss;
-                ss << "SocketServer::listen() error calling inet_pton "
-                   << "at address " << _host << ":" << _port << " : "
-                   << strerror(Socket::getErrno());
-
-                Socket::closeSocket(_serverFd);
-                return std::make_pair(false, ss.str());
-            }
-
-            // Bind the socket to the server address.
-            if (bind(_serverFd, (struct sockaddr*) &server, sizeof(server)) < 0)
-            {
-                std::stringstream ss;
-                ss << "SocketServer::listen() error calling bind "
-                   << "at address " << _host << ":" << _port << " : "
-                   << strerror(Socket::getErrno());
-
-                Socket::closeSocket(_serverFd);
-                return std::make_pair(false, ss.str());
-            }
-        }
-        else // AF_INET6
-        {
-            struct sockaddr_in6 server;
-            server.sin6_family = _addressFamily;
-            server.sin6_port = htons(_port);
-
-            if (inet_pton(_addressFamily, _host.c_str(), &server.sin6_addr) <= 0)
-            {
-                std::stringstream ss;
-                ss << "SocketServer::listen() error calling inet_pton "
-                   << "at address " << _host << ":" << _port << " : "
-                   << strerror(Socket::getErrno());
-
-                Socket::closeSocket(_serverFd);
-                return std::make_pair(false, ss.str());
-            }
-
-            // Bind the socket to the server address.
-            if (bind(_serverFd, (struct sockaddr*) &server, sizeof(server)) < 0)
-            {
-                std::stringstream ss;
-                ss << "SocketServer::listen() error calling bind "
-                   << "at address " << _host << ":" << _port << " : "
-                   << strerror(Socket::getErrno());
-
-                Socket::closeSocket(_serverFd);
-                return std::make_pair(false, ss.str());
-            }
+            Socket::closeSocket(_serverFd);
+            return std::make_pair(false, ss.str());
         }
 
         //
@@ -152,7 +113,8 @@ namespace ix
         {
             std::stringstream ss;
             ss << "SocketServer::listen() error calling listen "
-               << "at address " << _host << ":" << _port << " : " << strerror(Socket::getErrno());
+               << "at address " << _host << ":" << _port
+               << " : " << strerror(Socket::getErrno());
 
             Socket::closeSocket(_serverFd);
             return std::make_pair(false, ss.str());
@@ -163,8 +125,6 @@ namespace ix
 
     void SocketServer::start()
     {
-        _stop = false;
-
         if (!_thread.joinable())
         {
             _thread = std::thread(&SocketServer::run, this);
@@ -226,7 +186,7 @@ namespace ix
     {
         std::lock_guard<std::mutex> lock(_connectionsThreadsMutex);
         auto it = _connectionsThreads.begin();
-        auto itEnd = _connectionsThreads.end();
+        auto itEnd  = _connectionsThreads.end();
 
         while (it != itEnd)
         {
@@ -249,8 +209,6 @@ namespace ix
         // Set the socket to non blocking mode, so that accept calls are not blocking
         SocketConnect::configure(_serverFd);
 
-        setThreadName("SocketServer::listen");
-
         for (;;)
         {
             if (_stop) return;
@@ -258,14 +216,13 @@ namespace ix
             // Use poll to check whether a new connection is in progress
             int timeoutMs = 10;
             bool readyToRead = true;
-            auto selectInterrupt = std::make_unique<SelectInterrupt>();
-            PollResultType pollResult =
-                Socket::poll(readyToRead, timeoutMs, _serverFd, selectInterrupt);
+            PollResultType pollResult = Socket::poll(readyToRead, timeoutMs, _serverFd);
 
             if (pollResult == PollResultType::Error)
             {
                 std::stringstream ss;
-                ss << "SocketServer::run() error in select: " << strerror(Socket::getErrno());
+                ss << "SocketServer::run() error in select: "
+                   << strerror(Socket::getErrno());
                 logError(ss.str());
                 continue;
             }
@@ -281,15 +238,15 @@ namespace ix
             socklen_t addressLen = sizeof(client);
             memset(&client, 0, sizeof(client));
 
-            if ((clientFd = accept(_serverFd, (struct sockaddr*) &client, &addressLen)) < 0)
+            if ((clientFd = accept(_serverFd, (struct sockaddr *)&client, &addressLen)) < 0)
             {
                 if (!Socket::isWaitNeeded())
                 {
                     // FIXME: that error should be propagated
                     int err = Socket::getErrno();
                     std::stringstream ss;
-                    ss << "SocketServer::run() error accepting connection: " << err << ", "
-                       << strerror(err);
+                    ss << "SocketServer::run() error accepting connection: "
+                       << err << ", " << strerror(err);
                     logError(ss.str());
                 }
                 continue;
@@ -298,7 +255,8 @@ namespace ix
             if (getConnectedClientsCount() >= _maxConnections)
             {
                 std::stringstream ss;
-                ss << "SocketServer::run() reached max connections = " << _maxConnections << ". "
+                ss << "SocketServer::run() reached max connections = "
+                   << _maxConnections << ". "
                    << "Not accepting connection";
                 logError(ss.str());
 
@@ -315,34 +273,14 @@ namespace ix
 
             if (_stop) return;
 
-            // create socket
-            std::string errorMsg;
-            bool tls = _socketTLSOptions.tls;
-            auto socket = createSocket(tls, clientFd, errorMsg, _socketTLSOptions);
-
-            if (socket == nullptr)
-            {
-                logError("SocketServer::run() cannot create socket: " + errorMsg);
-                Socket::closeSocket(clientFd);
-                continue;
-            }
-
-            // Set the socket to non blocking mode + other tweaks
-            SocketConnect::configure(clientFd);
-
-            if (!socket->accept(errorMsg))
-            {
-                logError("SocketServer::run() tls accept failed: " + errorMsg);
-                Socket::closeSocket(clientFd);
-                continue;
-            }
-
             // Launch the handleConnection work asynchronously in its own thread.
             std::lock_guard<std::mutex> lock(_connectionsThreadsMutex);
             _connectionsThreads.push_back(std::make_pair(
-                connectionState,
-                std::thread(
-                    &SocketServer::handleConnection, this, std::move(socket), connectionState)));
+                    connectionState,
+                    std::thread(&SocketServer::handleConnection,
+                                this,
+                                clientFd,
+                                connectionState)));
         }
     }
 
@@ -354,8 +292,6 @@ namespace ix
 
     void SocketServer::runGC()
     {
-        setThreadName("SocketServer::GC");
-
         for (;;)
         {
             // Garbage collection to shutdown/join threads for closed connections.
@@ -372,9 +308,5 @@ namespace ix
             std::this_thread::sleep_for(std::chrono::milliseconds(10));
         }
     }
+}
 
-    void SocketServer::setTLSOptions(const SocketTLSOptions& socketTLSOptions)
-    {
-        _socketTLSOptions = socketTLSOptions;
-    }
-} // namespace ix

ixwebsocket/IXSocketServer.h

@@ -7,7 +7,6 @@
 #pragma once
 
 #include "IXConnectionState.h"
-#include "IXSocketTLSOptions.h"
 #include <atomic>
 #include <condition_variable>
 #include <functional>
@@ -21,8 +20,6 @@
 
 namespace ix
 {
-    class Socket;
-
     class SocketServer
     {
     public:
@@ -36,8 +33,7 @@ namespace ix
         SocketServer(int port = SocketServer::kDefaultPort,
                      const std::string& host = SocketServer::kDefaultHost,
                      int backlog = SocketServer::kDefaultTcpBacklog,
-                     size_t maxConnections = SocketServer::kDefaultMaxConnections,
-                     int addressFamily = SocketServer::kDefaultAddressFamily);
+                     size_t maxConnections = SocketServer::kDefaultMaxConnections);
         virtual ~SocketServer();
         virtual void stop();
 
@@ -50,14 +46,11 @@ namespace ix
         const static std::string kDefaultHost;
         const static int kDefaultTcpBacklog;
         const static size_t kDefaultMaxConnections;
-        const static int kDefaultAddressFamily;
 
         void start();
         std::pair<bool, std::string> listen();
         void wait();
 
-        void setTLSOptions(const SocketTLSOptions& socketTLSOptions);
-
     protected:
         // Logging
         void logError(const std::string& str);
@@ -71,16 +64,14 @@ namespace ix
         std::string _host;
         int _backlog;
         size_t _maxConnections;
-        int _addressFamily;
 
         // socket for accepting connections
         int _serverFd;
 
-        std::atomic<bool> _stop;
-
         std::mutex _logMutex;
 
         // background thread to wait for incoming connections
+        std::atomic<bool> _stop;
         std::thread _thread;
         void run();
 
@@ -101,14 +92,11 @@ namespace ix
         // the factory to create ConnectionState objects
         ConnectionStateFactory _connectionStateFactory;
 
-        virtual void handleConnection(std::unique_ptr<Socket>,
-                                      std::shared_ptr<ConnectionState> connectionState) = 0;
+        virtual void handleConnection(int fd, std::shared_ptr<ConnectionState> connectionState) = 0;
         virtual size_t getConnectedClientsCount() = 0;
 
         // Returns true if all connection threads are joined
         void closeTerminatedThreads();
         size_t getConnectionsThreadsCount();
-
-        SocketTLSOptions _socketTLSOptions;
     };
 } // namespace ix

ixwebsocket/IXSocketTLSOptions.cpp

@@ -1,93 +0,0 @@
-/*
- *  IXSocketTLSOptions.h
- *  Author: Matt DeBoer
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXSocketTLSOptions.h"
-
-#include <assert.h>
-#include <fstream>
-#include <sstream>
-
-namespace ix
-{
-    const char* kTLSCAFileUseSystemDefaults = "SYSTEM";
-    const char* kTLSCAFileDisableVerify = "NONE";
-    const char* kTLSCiphersUseDefault = "DEFAULT";
-    const char* kTLSInMemoryMarker = "-----BEGIN CERTIFICATE-----";
-
-    bool SocketTLSOptions::isValid() const
-    {
-        if (!_validated)
-        {
-            if (!certFile.empty() && !std::ifstream(certFile))
-            {
-                _errMsg = "certFile not found: " + certFile;
-                return false;
-            }
-            if (!keyFile.empty() && !std::ifstream(keyFile))
-            {
-                _errMsg = "keyFile not found: " + keyFile;
-                return false;
-            }
-            if (!caFile.empty() && caFile != kTLSCAFileDisableVerify &&
-                caFile != kTLSCAFileUseSystemDefaults && !std::ifstream(caFile))
-            {
-                _errMsg = "caFile not found: " + caFile;
-                return false;
-            }
-
-            if (certFile.empty() != keyFile.empty())
-            {
-                _errMsg = "certFile and keyFile must be both present, or both absent";
-                return false;
-            }
-
-            _validated = true;
-        }
-        return true;
-    }
-
-    bool SocketTLSOptions::hasCertAndKey() const
-    {
-        return !certFile.empty() && !keyFile.empty();
-    }
-
-    bool SocketTLSOptions::isUsingSystemDefaults() const
-    {
-        return caFile == kTLSCAFileUseSystemDefaults;
-    }
-
-    bool SocketTLSOptions::isUsingInMemoryCAs() const
-    {
-        return caFile.find(kTLSInMemoryMarker) != std::string::npos;
-    }
-
-    bool SocketTLSOptions::isPeerVerifyDisabled() const
-    {
-        return caFile == kTLSCAFileDisableVerify;
-    }
-
-    bool SocketTLSOptions::isUsingDefaultCiphers() const
-    {
-        return ciphers.empty() || ciphers == kTLSCiphersUseDefault;
-    }
-
-    const std::string& SocketTLSOptions::getErrorMsg() const
-    {
-        return _errMsg;
-    }
-
-    std::string SocketTLSOptions::getDescription() const
-    {
-        std::stringstream ss;
-        ss << "TLS Options:" << std::endl;
-        ss << "  certFile = " << certFile << std::endl;
-        ss << "  keyFile  = " << keyFile << std::endl;
-        ss << "  caFile   = " << caFile << std::endl;
-        ss << "  ciphers  = " << ciphers << std::endl;
-        ss << "  ciphers  = " << ciphers << std::endl;
-        return ss.str();
-    }
-} // namespace ix

ixwebsocket/IXSocketTLSOptions.h

@@ -1,54 +0,0 @@
-/*
- *  IXSocketTLSOptions.h
- *  Author: Matt DeBoer
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include <string>
-
-namespace ix
-{
-    struct SocketTLSOptions
-    {
-    public:
-        // check validity of the object
-        bool isValid() const;
-
-        // the certificate presented to peers
-        std::string certFile;
-
-        // the key used for signing/encryption
-        std::string keyFile;
-
-        // the ca certificate (or certificate bundle) file containing
-        // certificates to be trusted by peers; use 'SYSTEM' to
-        // leverage the system defaults, use 'NONE' to disable peer verification
-        std::string caFile = "SYSTEM";
-
-        // list of ciphers (rsa, etc...)
-        std::string ciphers = "DEFAULT";
-
-        // whether tls is enabled, used for server code
-        bool tls = false;
-
-        bool hasCertAndKey() const;
-
-        bool isUsingSystemDefaults() const;
-
-        bool isUsingInMemoryCAs() const;
-
-        bool isPeerVerifyDisabled() const;
-
-        bool isUsingDefaultCiphers() const;
-
-        const std::string& getErrorMsg() const;
-
-        std::string getDescription() const;
-
-    private:
-        mutable std::string _errMsg;
-        mutable bool _validated = false;
-    };
-} // namespace ix

ixwebsocket/IXUdpSocket.cpp

@@ -1,96 +0,0 @@
-/*
- *  IXUdpSocket.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2020 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXUdpSocket.h"
-
-#include "IXNetSystem.h"
-#include <cstring>
-#include <sstream>
-
-namespace ix
-{
-    UdpSocket::UdpSocket(int fd)
-        : _sockfd(fd)
-    {
-        ;
-    }
-
-    UdpSocket::~UdpSocket()
-    {
-        close();
-    }
-
-    void UdpSocket::close()
-    {
-        if (_sockfd == -1) return;
-
-        closeSocket(_sockfd);
-        _sockfd = -1;
-    }
-
-    int UdpSocket::getErrno()
-    {
-        int err;
-
-#ifdef _WIN32
-        err = WSAGetLastError();
-#else
-        err = errno;
-#endif
-
-        return err;
-    }
-
-    void UdpSocket::closeSocket(int fd)
-    {
-#ifdef _WIN32
-        closesocket(fd);
-#else
-        ::close(fd);
-#endif
-    }
-
-    bool UdpSocket::init(const std::string& host, int port, std::string& errMsg)
-    {
-        _sockfd = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
-        if (_sockfd < 0)
-        {
-            errMsg = "Could not create socket";
-            return false;
-        }
-
-        memset(&_server, 0, sizeof(_server));
-        _server.sin_family = AF_INET;
-        _server.sin_port = htons(port);
-
-        // DNS resolution.
-        struct addrinfo hints, *result = nullptr;
-        memset(&hints, 0, sizeof(hints));
-        hints.ai_family = AF_INET;
-        hints.ai_socktype = SOCK_DGRAM;
-
-        int ret = getaddrinfo(host.c_str(), nullptr, &hints, &result);
-        if (ret != 0)
-        {
-            errMsg = strerror(UdpSocket::getErrno());
-            freeaddrinfo(result);
-            close();
-            return false;
-        }
-
-        struct sockaddr_in* host_addr = (struct sockaddr_in*) result->ai_addr;
-        memcpy(&_server.sin_addr, &host_addr->sin_addr, sizeof(struct in_addr));
-        freeaddrinfo(result);
-
-        return true;
-    }
-
-    ssize_t UdpSocket::sendto(const std::string& buffer)
-    {
-        return (ssize_t)::sendto(
-            _sockfd, buffer.data(), buffer.size(), 0, (struct sockaddr*) &_server, sizeof(_server));
-    }
-} // namespace ix

ixwebsocket/IXUdpSocket.h

@@ -1,40 +0,0 @@
-/*
- *  IXUdpSocket.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2020 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include <atomic>
-#include <memory>
-#include <string>
-
-#ifdef _WIN32
-#include <BaseTsd.h>
-typedef SSIZE_T ssize_t;
-#endif
-
-#include "IXNetSystem.h"
-
-namespace ix
-{
-    class UdpSocket
-    {
-    public:
-        UdpSocket(int fd = -1);
-        ~UdpSocket();
-
-        // Virtual methods
-        bool init(const std::string& host, int port, std::string& errMsg);
-        ssize_t sendto(const std::string& buffer);
-        void close();
-
-        static int getErrno();
-        static void closeSocket(int fd);
-
-    private:
-        std::atomic<int> _sockfd;
-        struct sockaddr_in _server;
-    };
-} // namespace ix

ixwebsocket/IXUrlParser.cpp

@@ -1,338 +1,11 @@
 /*
- * Lightweight URL & URI parser (RFC 1738, RFC 3986)
- * https://github.com/corporateshark/LUrlParser
- *
- * The MIT License (MIT)
- *
- * Copyright (C) 2015 Sergey Kosarevsky (sk@linderdaum.com)
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- *
  *  IXUrlParser.cpp
  *  Author: Benjamin Sergeant
  *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
  */
 
 #include "IXUrlParser.h"
-
-#include <algorithm>
-#include <cstring>
-
-namespace
-{
-    enum LUrlParserError
-    {
-        LUrlParserError_Ok = 0,
-        LUrlParserError_Uninitialized = 1,
-        LUrlParserError_NoUrlCharacter = 2,
-        LUrlParserError_InvalidSchemeName = 3,
-        LUrlParserError_NoDoubleSlash = 4,
-        LUrlParserError_NoAtSign = 5,
-        LUrlParserError_UnexpectedEndOfLine = 6,
-        LUrlParserError_NoSlash = 7,
-    };
-
-    class clParseURL
-    {
-    public:
-        LUrlParserError m_ErrorCode;
-        std::string m_Scheme;
-        std::string m_Host;
-        std::string m_Port;
-        std::string m_Path;
-        std::string m_Query;
-        std::string m_Fragment;
-        std::string m_UserName;
-        std::string m_Password;
-
-        clParseURL()
-            : m_ErrorCode(LUrlParserError_Uninitialized)
-        {
-        }
-
-        /// return 'true' if the parsing was successful
-        bool IsValid() const
-        {
-            return m_ErrorCode == LUrlParserError_Ok;
-        }
-
-        /// helper to convert the port number to int, return 'true' if the port is valid (within the
-        /// 0..65535 range)
-        bool GetPort(int* OutPort) const;
-
-        /// parse the URL
-        static clParseURL ParseURL(const std::string& URL);
-
-    private:
-        explicit clParseURL(LUrlParserError ErrorCode)
-            : m_ErrorCode(ErrorCode)
-        {
-        }
-    };
-
-    static bool IsSchemeValid(const std::string& SchemeName)
-    {
-        for (auto c : SchemeName)
-        {
-            if (!isalpha(c) && c != '+' && c != '-' && c != '.') return false;
-        }
-
-        return true;
-    }
-
-    bool clParseURL::GetPort(int* OutPort) const
-    {
-        if (!IsValid())
-        {
-            return false;
-        }
-
-        int Port = atoi(m_Port.c_str());
-
-        if (Port <= 0 || Port > 65535)
-        {
-            return false;
-        }
-
-        if (OutPort)
-        {
-            *OutPort = Port;
-        }
-
-        return true;
-    }
-
-    // based on RFC 1738 and RFC 3986
-    clParseURL clParseURL::ParseURL(const std::string& URL)
-    {
-        clParseURL Result;
-
-        const char* CurrentString = URL.c_str();
-
-        /*
-         *	<scheme>:<scheme-specific-part>
-         *	<scheme> := [a-z\+\-\.]+
-         *	For resiliency, programs interpreting URLs should treat upper case letters as
-         *equivalent to lower case in scheme names
-         */
-
-        // try to read scheme
-        {
-            const char* LocalString = strchr(CurrentString, ':');
-
-            if (!LocalString)
-            {
-                return clParseURL(LUrlParserError_NoUrlCharacter);
-            }
-
-            // save the scheme name
-            Result.m_Scheme = std::string(CurrentString, LocalString - CurrentString);
-
-            if (!IsSchemeValid(Result.m_Scheme))
-            {
-                return clParseURL(LUrlParserError_InvalidSchemeName);
-            }
-
-            // scheme should be lowercase
-            std::transform(
-                Result.m_Scheme.begin(), Result.m_Scheme.end(), Result.m_Scheme.begin(), ::tolower);
-
-            // skip ':'
-            CurrentString = LocalString + 1;
-        }
-
-        /*
-         *	//<user>:<password>@<host>:<port>/<url-path>
-         *	any ":", "@" and "/" must be normalized
-         */
-
-        // skip "//"
-        if (*CurrentString++ != '/') return clParseURL(LUrlParserError_NoDoubleSlash);
-        if (*CurrentString++ != '/') return clParseURL(LUrlParserError_NoDoubleSlash);
-
-        // check if the user name and password are specified
-        bool bHasUserName = false;
-
-        const char* LocalString = CurrentString;
-
-        while (*LocalString)
-        {
-            if (*LocalString == '@')
-            {
-                // user name and password are specified
-                bHasUserName = true;
-                break;
-            }
-            else if (*LocalString == '/')
-            {
-                // end of <host>:<port> specification
-                bHasUserName = false;
-                break;
-            }
-
-            LocalString++;
-        }
-
-        // user name and password
-        LocalString = CurrentString;
-
-        if (bHasUserName)
-        {
-            // read user name
-            while (*LocalString && *LocalString != ':' && *LocalString != '@')
-                LocalString++;
-
-            Result.m_UserName = std::string(CurrentString, LocalString - CurrentString);
-
-            // proceed with the current pointer
-            CurrentString = LocalString;
-
-            if (*CurrentString == ':')
-            {
-                // skip ':'
-                CurrentString++;
-
-                // read password
-                LocalString = CurrentString;
-
-                while (*LocalString && *LocalString != '@')
-                    LocalString++;
-
-                Result.m_Password = std::string(CurrentString, LocalString - CurrentString);
-
-                CurrentString = LocalString;
-            }
-
-            // skip '@'
-            if (*CurrentString != '@')
-            {
-                return clParseURL(LUrlParserError_NoAtSign);
-            }
-
-            CurrentString++;
-        }
-
-        bool bHasBracket = (*CurrentString == '[');
-
-        // go ahead, read the host name
-        LocalString = CurrentString;
-
-        while (*LocalString)
-        {
-            if (bHasBracket && *LocalString == ']')
-            {
-                // end of IPv6 address
-                LocalString++;
-                break;
-            }
-            else if (!bHasBracket && (*LocalString == ':' || *LocalString == '/'))
-            {
-                // port number is specified
-                break;
-            }
-
-            LocalString++;
-        }
-
-        Result.m_Host = std::string(CurrentString, LocalString - CurrentString);
-
-        CurrentString = LocalString;
-
-        // is port number specified?
-        if (*CurrentString == ':')
-        {
-            CurrentString++;
-
-            // read port number
-            LocalString = CurrentString;
-
-            while (*LocalString && *LocalString != '/')
-                LocalString++;
-
-            Result.m_Port = std::string(CurrentString, LocalString - CurrentString);
-
-            CurrentString = LocalString;
-        }
-
-        // end of string
-        if (!*CurrentString)
-        {
-            Result.m_ErrorCode = LUrlParserError_Ok;
-
-            return Result;
-        }
-
-        // skip '/'
-        if (*CurrentString != '/')
-        {
-            return clParseURL(LUrlParserError_NoSlash);
-        }
-
-        CurrentString++;
-
-        // parse the path
-        LocalString = CurrentString;
-
-        while (*LocalString && *LocalString != '#' && *LocalString != '?')
-            LocalString++;
-
-        Result.m_Path = std::string(CurrentString, LocalString - CurrentString);
-
-        CurrentString = LocalString;
-
-        // check for query
-        if (*CurrentString == '?')
-        {
-            // skip '?'
-            CurrentString++;
-
-            // read query
-            LocalString = CurrentString;
-
-            while (*LocalString && *LocalString != '#')
-                LocalString++;
-
-            Result.m_Query = std::string(CurrentString, LocalString - CurrentString);
-
-            CurrentString = LocalString;
-        }
-
-        // check for fragment
-        if (*CurrentString == '#')
-        {
-            // skip '#'
-            CurrentString++;
-
-            // read fragment
-            LocalString = CurrentString;
-
-            while (*LocalString)
-                LocalString++;
-
-            Result.m_Fragment = std::string(CurrentString, LocalString - CurrentString);
-        }
-
-        Result.m_ErrorCode = LUrlParserError_Ok;
-
-        return Result;
-    }
-} // namespace
+#include "LUrlParser.h"
 
 namespace ix
 {
@@ -343,7 +16,7 @@ namespace ix
                           std::string& query,
                           int& port)
     {
-        clParseURL res = clParseURL::ParseURL(url);
+        LUrlParser::clParseURL res = LUrlParser::clParseURL::ParseURL(url);
 
         if (!res.IsValid())
         {
@@ -351,9 +24,9 @@ namespace ix
         }
 
         protocol = res.m_Scheme;
-        host = res.m_Host;
-        path = res.m_Path;
-        query = res.m_Query;
+        host     = res.m_Host;
+        path     = res.m_Path;
+        query    = res.m_Query;
 
         if (!res.GetPort(&port))
         {
@@ -391,4 +64,4 @@ namespace ix
         return true;
     }
 
-} // namespace ix
+}