Higher level network refactor (#33)

* Cleanup on ProtocolPacket, merge FluxPacket with ProtocolPacket

* Renaming COUNTID -> COUNTER

* add ClientStatus class, add timeout handling in ClientSideNetUdp

* IpAddress: add todo for hostname

* Socket: add setDontFragment()

* Socket: add retrieveCurrentAdapterMTU() and getAdaptersInfo()

* SocketUdp: add retrieveAdapterMTUForDestination()

* Socket: fix "_win32" instead of "_WIN32"

* server: add NetCommand, add NetMTUCommand in order to retrieve MTU via custom path discovery

* deps/.gitignore: add wsl/ folder

* add linux version for retrieveCurrentAdapterMTU() and getAdaptersInfo()

* Socket: add missing include, fix bad construct

* ClientSideNetUdp::sendTo: fix missing id usage

* socket: try fix mac

* try fixing mac

* Packet: add ERR_TRANSMIT, cleaning extra namespaces

* move net::Error class to a new file

* add Compressor class, add CompressorLZ4

* add CompressorLZ4HC, refactor PacketLZ4/PacketLZ4HC with Compressor, TODO: remove throw

* Packet: onSend() now return a bool to indicate an error

* move C_compressor.hpp out of network/

* move CompressorLZ4/HC class in new file

* Drop the PacketBZ2, add CompressorBZ2 class

* Packet: made _g_data, _g_readPos and _g_valid private

* Packet: rename _g_sendPos -> _g_transmitPos, _g_lastData -> _g_transmitCache, _g_lastDataValidity -> _g_transmitCacheValid

* Packet: onReceive() use std::span

* Packet: remove buffer argument on onSend()

* Packet: remove _defaultReserveSize static variable

* Client: use deque, add pushForcedFrontPacket()

* Identity: add default values

* PacketLZ4 : add missing argument

* add PacketDefragmentation class, move threadReception/threadTransmission from ClientSideNetUdp to .cpp file

* move PacketDefragmentation to C_protocol

* ClientList: general cleaning, clean namespaces

* ClientList: use fge::AccessLock

* ClientList: add PacketDefragmentation class for every client

* ServerSideNetUdp: move out of template threadReception and threadTransmission

* ProtocolPacket: add isFragmented() method

* ServerNetFluxUdp::process: support defragmentation

* Server: fix missing refClient set

* apply commits to clientServerLifeSimulator_004/server/main.cpp

* TransmissionPacket: add enable_shared_from_this, add fragment() method

* PacketDefragmentation: correctly move code to correct file, use vector instead of map, add fragmentation to ServerSideNetUdp

* merging TransmissionPacket class to ProtocolPacket class

* Client: add mtu

* add do not fragment flag on ProtocolPacket

* CMakeLists.txt: add OpenSSL package and link to it

* add DTLS handshake, still WIP, add new connect command

* ClientStatus: use a time_point for the timeout

* Client: add getLastPacketElapsedTime() / getLastPacketLatency(), add _mtuFinalizedFlag

* NetCommand: add CommandQueue, complete NetConnectCommand (still WIP)

* ClientList: Data: use CommandQueue, add _mtuFutur

* Server: continue to work on client/server communication

* Server: handle MTU_DISCOVERED state, set cipher list, key/certificate

* add CryptGenerateKeyAndCertificate()

* Fix client/server examples

* fix server handling end of crypt handshake

* modify the way the timeout is handled in NetCommand, also did a cleaning pass

* encryption from server, decryption from client, now working WIP

* fix examples

* ProtocolPacket: add haveCorrectHeader() and unmarkForEncryption()

* encryption from client to server

* ServerSideNetUdp::threadReception: now handle packet encryption as it now have identity/client association

* move crypt function to own files

* correctly destroy cryptinfo

* ClientStatus: remove USER_HANDLED state, add isInEncryptedState() method

* Protocol: remove FGE_NET_HEADER_LOCAL_REORDERED_FLAG, add FGE_NET_HEADER_COMPRESSED_FLAG

* ProtocolPacket: add compress() and decompress()

* ProtocolPacket: fix some bits mask issues

* Compressor: reorder some code

* Client: pushPacket: use isInEncryptedState() method

* NetConnectCommand: fix broken promise

* Add compression/decompression, client is still not compressing WIP

* enable compression on client

* remove LIFESIM_CLIENT_PORT and use FGE_ANYPORT

* rename NET_INTERNAL_ID_FRAGMENTED_PACKET, add NET_INTERNAL_ID_RETURN_PACKET

* Add code for the return packet

* Identity: add toString() helper

* made return packet usable by adding handling of the packet in server/client

* clientServerLifeSimulator_004: modify examples by adding the return packet internally

* ProtocolPacket: add lastReorderedCounter used on reordered packet

* Scene: pack() now reset client stat

* update clientServerLifeSimulator_004

* async connect

* add NET_INTERNAL_ID_DISCONNECT, for clean disconnection handling (client only in this commit)

* removing skey

* add custom versioning string during handshake

* Add server disconnection notice to client

* add _onTransmitReturnPacket event

* Client: add status check helper, disallow packets when disconnected, add disconnect() helper

* NetConnectCommand: add timeout on WAITING_SERVER_FINAL_MTU

* Fixing, allow sending packet when disconnected client

* increase FGE_NET_MTU_TIMEOUT_MS to 500ms

* NetCommand: make sure to steal unique_ptr owner on onReceive() if packet is for the command

* ClientSideNetUdp: add option to set return packet rate

* don't throw in disconnect()

* fix iteration in processClients()

* rework FluxProcessResults: this fix a packets process lag

* ChainedArguments: remove newChain(), simplify a bit the way rules must be implemented

* Add RStringRange and RStringMustEqual helper

* add fge_debug.hpp with macro FGE_DEBUG_PRINT

* NetCommand: handling of the timeout is now global

* add the PacketCache class, in order to retransmit packets that wasn't received by the client WIP

* AccessLock: add DataLockPair alias helper for std::pair

* Client: avoid data race for getPacketCache()

* NetCommand: fix missing setCurrentPacketCounter

* fix PacketCache, add debug print

* fixing server, make sure PacketCache work

* add constructor for Label

* Label: add default constructor

* mute unused variables in release mode

* add FGE_NET_PACKET_CACHE_DELAY_FACTOR, add the ability to set maximum size of packet reorder
- also add macro to help user compute a "perfect" size

* TransmitPacketPtr now use a unique_ptr as it doesn't make sense anymore to have it shared

* fix MTU discovery when low MTU

* fix packet defragmentation, remove extra debugging code

Author: JonathSpirit

CMakeLists.txt

@@ -21,6 +21,9 @@ else()
     endif()
 endif()
 
+#Find the OpenSSL package
+find_package(OpenSSL REQUIRED)
+
 #Add a LZ4 fix for missing INTERFACE_INCLUDE_DIRECTORIES property
 get_target_property(VAR_PROPERTY_CHECK LZ4::lz4_static INTERFACE_INCLUDE_DIRECTORIES)
 
@@ -246,6 +249,8 @@ target_sources(${FGE_SERVER_LIB_NAME} PRIVATE
         sources/C_tilelayer.cpp
         sources/C_timer.cpp
         sources/C_quad.cpp
+        sources/C_compressorBZ2.cpp
+        sources/C_compressorLZ4.cpp
         sources/fge_endian.cpp)
 
 target_sources(${FGE_SERVER_LIB_NAME} PRIVATE
@@ -275,14 +280,15 @@ target_sources(${FGE_SERVER_LIB_NAME} PRIVATE
 
 target_sources(${FGE_SERVER_LIB_NAME} PRIVATE
         sources/network/C_client.cpp
+        sources/network/C_error.cpp
         sources/network/C_clientList.cpp
         sources/network/C_ipAddress.cpp
         sources/network/C_networkType.cpp
         sources/network/C_packet.cpp
-        sources/network/C_packetBZ2.cpp
         sources/network/C_packetLZ4.cpp
         sources/network/C_server.cpp
         sources/network/C_socket.cpp
+        sources/network/C_netCommand.cpp
         sources/network/C_protocol.cpp)
 
 target_sources(${FGE_SERVER_LIB_NAME} PRIVATE
@@ -302,6 +308,8 @@ target_sources(${FGE_SERVER_LIB_NAME} PRIVATE
         sources/manager/timer_manager.cpp
         sources/manager/task_manager.cpp)
 
+target_sources(${FGE_SERVER_LIB_NAME} PRIVATE sources/private/fge_crypt.cpp)
+
 #######################
 
 target_sources(${FGE_LIB_NAME} PUBLIC FILE_SET publicHeaders TYPE HEADERS BASE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/includes FILES ${FGE_INCLUDES_PUBLIC})
@@ -358,6 +366,8 @@ target_sources(${FGE_LIB_NAME} PRIVATE
         sources/C_tilelayer.cpp
         sources/C_timer.cpp
         sources/C_quad.cpp
+        sources/C_compressorBZ2.cpp
+        sources/C_compressorLZ4.cpp
         sources/fge_endian.cpp)
 
 target_sources(${FGE_LIB_NAME} PRIVATE
@@ -387,14 +397,15 @@ target_sources(${FGE_LIB_NAME} PRIVATE
 
 target_sources(${FGE_LIB_NAME} PRIVATE
         sources/network/C_client.cpp
+        sources/network/C_error.cpp
         sources/network/C_clientList.cpp
         sources/network/C_ipAddress.cpp
         sources/network/C_networkType.cpp
         sources/network/C_packet.cpp
-        sources/network/C_packetBZ2.cpp
         sources/network/C_packetLZ4.cpp
         sources/network/C_server.cpp
         sources/network/C_socket.cpp
+        sources/network/C_netCommand.cpp
         sources/network/C_protocol.cpp)
 
 target_sources(${FGE_LIB_NAME} PRIVATE
@@ -416,11 +427,12 @@ target_sources(${FGE_LIB_NAME} PRIVATE
         sources/manager/task_manager.cpp)
 
 target_sources(${FGE_LIB_NAME} PRIVATE sources/private/spirv_reflect.cpp)
+target_sources(${FGE_LIB_NAME} PRIVATE sources/private/fge_crypt.cpp)
 
 #Linking library
 if(WIN32)
-    target_link_libraries(${FGE_LIB_NAME} PUBLIC user32 ws2_32 winmm)
-    target_link_libraries(${FGE_SERVER_LIB_NAME} PUBLIC user32 ws2_32 winmm)
+    target_link_libraries(${FGE_LIB_NAME} PUBLIC user32 ws2_32 winmm iphlpapi)
+    target_link_libraries(${FGE_SERVER_LIB_NAME} PUBLIC user32 ws2_32 winmm iphlpapi)
 endif()
 
 target_link_libraries(${FGE_LIB_NAME} PRIVATE glslang::glslang-default-resource-limits glslang::SPIRV glslang::glslang)
@@ -431,6 +443,7 @@ target_link_libraries(${FGE_LIB_NAME} PRIVATE fmt::fmt-header-only)
 target_link_libraries(${FGE_LIB_NAME} PRIVATE Freetype::Freetype)
 target_link_libraries(${FGE_LIB_NAME} PRIVATE re2::re2)
 target_link_libraries(${FGE_LIB_NAME} PUBLIC glm::glm-header-only volk::volk_headers GPUOpen::VulkanMemoryAllocator Vulkan::Headers)
+target_link_libraries(${FGE_LIB_NAME} PRIVATE OpenSSL::SSL OpenSSL::Crypto)
 
 target_link_libraries(${FGE_SERVER_LIB_NAME} PRIVATE glslang::glslang-default-resource-limits glslang::SPIRV glslang::glslang)
 target_link_libraries(${FGE_SERVER_LIB_NAME} PUBLIC SDL2::SDL2 SDL2_image::SDL2_image)
@@ -440,6 +453,7 @@ target_link_libraries(${FGE_SERVER_LIB_NAME} PRIVATE fmt::fmt-header-only)
 target_link_libraries(${FGE_SERVER_LIB_NAME} PRIVATE Freetype::Freetype)
 target_link_libraries(${FGE_SERVER_LIB_NAME} PRIVATE re2::re2)
 target_link_libraries(${FGE_SERVER_LIB_NAME} PUBLIC glm::glm-header-only volk::volk_headers GPUOpen::VulkanMemoryAllocator Vulkan::Headers)
+target_link_libraries(${FGE_SERVER_LIB_NAME} PRIVATE OpenSSL::SSL OpenSSL::Crypto)
 
 #Install
 include(GNUInstallDirs)

deps/.gitignore

@@ -5,6 +5,7 @@
 /x32/
 /msvc/
 /clang/
+/wsl/
 /build*/
 
 /.idea/