feat(wip): checking in v2 of C srv

Author: XavierChanth

dev_docs/socket_connector_design_H1-2025.md

@@ -108,9 +108,10 @@ connector into an application directly.
 
 There are more types to of channel IO to consider below.
 
-#### Directional Typing
+#### Directional Typing ("Class")
 
 - Inbound IO like tcp bind sockets, which accept a connection to be used
+- Accepted IO like tcp accepted sockets
 - Outbound IO like tcp clients, which make connections to bind sockets
 
 #### Remote IO vs Local IO

dev_docs/streaming_between_dart_and_c_Q2-2025.md

@@ -0,0 +1,14 @@
+# Streaming Between Dart and C
+
+Date: 04/04/2025
+
+## Overview
+
+The main purpose of being able to stream between C and Dart is so that we can
+embed C srv into NoPorts Desktop and possibly npt/sshnp.
+
+C srv already has a standalone ring buffer implementation, so it seems that
+exposing the ring buffer as a control_io in C may be the simplest path forward.
+With it exposed, we can wrap it in Dart ffi, and wrap that into a Dart stream.
+
+Any further difficulties or considerations will be documented as they appear.

packages/c/.clang-format

@@ -1,4 +1,3 @@
 ---
 Language: Cpp # Covers C and C++
 BasedOnStyle: LLVM # Added this to ensure a sane set of defaults
-ColumnLimit: 120 # LLVM uses 80, but we mostly use 120 at Atsign

packages/c/justfile

@@ -108,7 +108,7 @@ configure-dev:
     -DSSHNPD_ENABLE_TESTING_SHUTDOWN_NOTIFICATION=ON
 
 configure-strict:
-  cmake -B {{ dev_dir }} \
+  cmake -B {{ strict_dir }} \
     -S $PWD \
     -G "$GENERATOR" \
     --preset dev \

packages/c/srv/.gitignore

@@ -0,0 +1 @@
+just.env

packages/c/srv/CMakeLists.txt

@@ -10,8 +10,20 @@ project(srv VERSION 1.0.4 LANGUAGES C)
 # globs are known as bad practice, so we do not use them here
 set(
   SRV_SRCS
+  ${CMAKE_CURRENT_LIST_DIR}/src/authenticate.c
+  ${CMAKE_CURRENT_LIST_DIR}/src/channel.c
+  ${CMAKE_CURRENT_LIST_DIR}/src/channel_io.c
+  ${CMAKE_CURRENT_LIST_DIR}/src/channel_io_tcp.c
+  ${CMAKE_CURRENT_LIST_DIR}/src/channel_sink.c
+  ${CMAKE_CURRENT_LIST_DIR}/src/channel_transformer.c
+  ${CMAKE_CURRENT_LIST_DIR}/src/channel_transformer_aes_ctr.c
   ${CMAKE_CURRENT_LIST_DIR}/src/params.c
-  ${CMAKE_CURRENT_LIST_DIR}/src/side.c
+  ${CMAKE_CURRENT_LIST_DIR}/src/pthread_handle.c
+  ${CMAKE_CURRENT_LIST_DIR}/src/ring.c
+  ${CMAKE_CURRENT_LIST_DIR}/src/session.c
+  ${CMAKE_CURRENT_LIST_DIR}/src/session_control.c
+  ${CMAKE_CURRENT_LIST_DIR}/src/session_single.c
+  ${CMAKE_CURRENT_LIST_DIR}/src/session_stacking.c
   ${CMAKE_CURRENT_LIST_DIR}/src/srv.c
 )
 
@@ -67,16 +79,16 @@ endif()
 # 5. Create srv_lib library target
 
 add_compile_options("-pthread")
-add_library(${PROJECT_NAME}-lib STATIC ${SRV_SRCS})
+add_library(lib${PROJECT_NAME} STATIC ${SRV_SRCS})
 
 target_link_libraries(
-  ${PROJECT_NAME}-lib
+  lib${PROJECT_NAME}
   PRIVATE argparse::argparse-static atlogger atchops mbedtls
 )
 
 # Set include directories for srv target
 target_include_directories(
-  ${PROJECT_NAME}-lib
+  lib${PROJECT_NAME}
   PUBLIC
     $<BUILD_INTERFACE:${SRV_INCLUDE_DIR}>
     $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
@@ -85,13 +97,13 @@ target_include_directories(
 # 6 Install srv library
 # This step configures running `cmake --build build --target install` (which is the same thing as `make install`)
 # This work also helps other CMake projects use `find_package(atclient)` to find our library, once installed.
-list(APPEND SRV_TARGETS_TO_INSTALL ${PROJECT_NAME}-lib) # install srv_lib
+list(APPEND SRV_TARGETS_TO_INSTALL lib${PROJECT_NAME}) # install srv_lib
 
 foreach(target ${SRV_TARGETS_TO_INSTALL})
   message(STATUS "[SRV] Installing ${target}..")
   install(
     TARGETS ${target}
-    EXPORT ${PROJECT_NAME}-lib-config
+    EXPORT lib${PROJECT_NAME}-config
     ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
   )
 endforeach()
@@ -102,11 +114,11 @@ install(
 )
 
 # 7. Create srv executable target
-add_executable(${PROJECT_NAME} ${CMAKE_CURRENT_LIST_DIR}/src/main.c)
+add_executable(${PROJECT_NAME} ${CMAKE_CURRENT_LIST_DIR}/src/srv.c)
 
 target_link_libraries(
   ${PROJECT_NAME}
-  PRIVATE ${PROJECT_NAME}-lib atlogger atchops mbedtls argparse::argparse-static
+  PRIVATE lib${PROJECT_NAME} atlogger atchops mbedtls argparse::argparse-static
 )
 
 # 8. Build tests

packages/c/srv/include/srv/params.h

@@ -1,54 +1,60 @@
 #ifndef SRV_PARAMS_H
 #define SRV_PARAMS_H
-#define SRV_VERSION "0.1.0"
+#ifdef __cplusplus
+extern "C" {
+#endif
 
-#include <argparse/argparse.h>
-#include <getopt.h>
-#include <stdbool.h>
 #include <stdint.h>
 
-typedef struct {
-  char *rvd_auth_string;
-  char *session_aes_key_string;
-  char *session_aes_iv_string;
-} srv_env_t;
-
-/**
- * @brief Free the memory allocated for a single side of the socket connection.
- *
- * @param side a pointer to the side struture which will be freed by this function.
- */
-typedef struct {
+enum srv_io_type {
+  srv_io_type_tcp_client = 0,
+  srv_io_type_tcp_bind = 1,
+};
+
+enum srv_transformer_type {
+  srv_transformer_none = 0,
+  srv_transformer_aes_ctr = 1,
+};
+
+enum srv_auth_type {
+  srv_auth_type_none = 0,
+  srv_auth_type_payload = 1,
+};
+
+enum srv_channel_mode {
+  srv_mode_single = 0,
+  srv_mode_stacking = 1,
+  srv_mode_control = 2,
+};
+
+struct srv_params {
   char *host;
-  uint16_t port;
-  uint16_t local_port;
+  char *port;
   char *local_host;
+  char *local_port;
 
-  bool bind_local_port;
-  bool rv_auth;
-  bool rv_e2ee;
-  bool multi;
   int timeout;
 
-  char *rvd_auth_string;
-  char *session_aes_key_string;
-  char *session_aes_iv_string;
-} srv_params_t;
-
-/**
- * @brief Apply the default values to a params structure
- *
- * @param params a pointer to the parameters structure to apply the defaults to.
- */
-void apply_default_values_to_srv_params(srv_params_t *params);
-
-/**
- * @brief Parse parameters into a params structure
- *
- * @param params a pointer ot the parameters structure
- * @param argc the count of arguments
- * @param argv the list of arguments
- */
-int parse_srv_params(srv_params_t *params, int argc, const char **argv, srv_env_t *environment);
-
+  enum srv_channel_mode mode;
+  enum srv_io_type remote_io;
+  enum srv_io_type local_io;
+  enum srv_transformer_type transformer;
+  enum srv_auth_type remote_auth;
+  uint8_t verbose : 1;
+};
+
+#define srv_params_initializer                                                 \
+  (struct srv_params) {                                                        \
+    .host = NULL, .port = NULL, .local_host = "localhost", .local_port = "0",  \
+    .timeout = 60, .mode = srv_mode_single,                                    \
+    .remote_io = srv_io_type_tcp_client, .local_io = srv_io_type_tcp_client,   \
+    .transformer = srv_transformer_aes_ctr,                                    \
+    .remote_auth = srv_auth_type_payload, .verbose = 0,                        \
+  }
+
+int parse_srv_params(int argc, char **argv, struct srv_params *params);
+
+#ifdef __cplusplus
+}
+#endif
 #endif