feat: c at_activate and required components

.github/workflows/codeql.yml

@@ -53,7 +53,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@4f3212b61783c3c68e8309a0f18a699764811cda # v3.27.1
+      uses: github/codeql-action/init@f09c1c0a94de965c15400f5634aa42fac8fb8f88 # v3.27.5
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -81,6 +81,6 @@ jobs:
         ./build/main
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@4f3212b61783c3c68e8309a0f18a699764811cda # v3.27.1
+      uses: github/codeql-action/analyze@f09c1c0a94de965c15400f5634aa42fac8fb8f88 # v3.27.5
       with:
         category: "/language:${{matrix.language}}"

.github/workflows/scorecards.yml

@@ -67,6 +67,6 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard.
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@4f3212b61783c3c68e8309a0f18a699764811cda # v3.27.1
+        uses: github/codeql-action/upload-sarif@f09c1c0a94de965c15400f5634aa42fac8fb8f88 # v3.27.5
         with:
           sarif_file: results.sarif

.gitignore

@@ -22,3 +22,4 @@ __pycache__/
 .pio/
 
 test/*/test_*
+/.clang-format

CMakeLists.txt

@@ -9,20 +9,20 @@ cmake_policy(SET CMP0135 NEW)
 include(GNUInstallDirs)
 
 project(
-  atsdk
-  VERSION 0.0.1
-  DESCRIPTION "Atsign's atSDK library"
-  HOMEPAGE_URL https://atsign.com
-  LANGUAGES C
+        atsdk
+        VERSION 0.0.1
+        DESCRIPTION "Atsign's atSDK library"
+        HOMEPAGE_URL https://atsign.com
+        LANGUAGES C
 )
 
 # Determine if atchops is being built as a subproject using add_subdirectory()
-if(NOT DEFINED ATSDK_AS_SUBPROJECT)
-  set(ATSDK_AS_SUBPROJECT ON)
-  if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
-    set(ATSDK_AS_SUBPROJECT OFF)
-  endif()
-endif()
+if (NOT DEFINED ATSDK_AS_SUBPROJECT)
+    set(ATSDK_AS_SUBPROJECT ON)
+    if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
+        set(ATSDK_AS_SUBPROJECT OFF)
+    endif ()
+endif ()
 message(STATUS "[ATSDK] ATSDK_AS_SUBPROJECT: ${ATSDK_AS_SUBPROJECT}")
 
 # install each package
@@ -37,45 +37,55 @@ message(STATUS "Building atclient")
 set(ATCLIENT_BUILD_TESTS ${ATSDK_BUILD_TESTS})
 add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/packages/atclient)
 
-if(NOT ESP_PLATFORM)
-  # install dependencies
-  set(
-    ATSDK_TARGETS
-    mbedtls
-    mbedx509
-    mbedcrypto
-    everest
-    p256m
-    uuid4-static
-    atchops
-    cjson
-    atlogger
-    atclient
-  )
+message(STATUS "Building atcommons")
+set(ATCOMMONS_BUILD_TESTS ${ATSDK_BUILD_TESTS})
+add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/packages/atcommons)
 
-  install(
-    TARGETS ${ATSDK_TARGETS}
-    EXPORT ${PROJECT_NAME}-config
-    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-  )
+message(STATUS "Building atauth")
+set(ATAUTH_BUILD_TESTS ${ATSDK_BUILD_TESTS})
+add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/packages/atauth)
 
-  # export dependencies
-  if(NOT ATSDK_AS_SUBPROJECT)
-    export(PACKAGE ${PROJECT_NAME})
+if (NOT ESP_PLATFORM)
+    # install dependencies
+    set(
+            ATSDK_TARGETS
+            mbedtls
+            mbedx509
+            mbedcrypto
+            everest
+            p256m
+            uuid4-static
+            atchops
+            cjson
+            atlogger
+            atclient
+            atcommons
+            atauth
+    )
 
-    # install as a config.cmake
     install(
-      EXPORT ${PROJECT_NAME}-config
-      NAMESPACE ${PROJECT_NAME}::
-      DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
-      FILE ${PROJECT_NAME}-config.cmake
+            TARGETS ${ATSDK_TARGETS}
+            EXPORT ${PROJECT_NAME}-config
+            ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
     )
 
-    # export the config.cmake
-    export(
-      EXPORT ${PROJECT_NAME}-config
-      NAMESPACE ${PROJECT_NAME}::
-      FILE "cmake/${PROJECT_NAME}-config.cmake"
-    )
-  endif()
-endif()
+    # export dependencies
+    if (NOT ATSDK_AS_SUBPROJECT)
+        export(PACKAGE ${PROJECT_NAME})
+
+        # install as a config.cmake
+        install(
+                EXPORT ${PROJECT_NAME}-config
+                NAMESPACE ${PROJECT_NAME}::
+                DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
+                FILE ${PROJECT_NAME}-config.cmake
+        )
+
+        # export the config.cmake
+        export(
+                EXPORT ${PROJECT_NAME}-config
+                NAMESPACE ${PROJECT_NAME}::
+                FILE "cmake/${PROJECT_NAME}-config.cmake"
+        )
+    endif ()
+endif ()

cmake/atauth.cmake

@@ -0,0 +1,10 @@
+if(NOT TARGET atauth)
+    include(FetchContent)
+    message(
+            STATUS
+            "[ATAUTH] package not found, fetching from local repository.."
+    )
+    FetchContent_Declare(atauth SOURCE_DIR ${atauth_DIR})
+    FetchContent_MakeAvailable(atauth)
+    install(TARGETS atauth)
+endif()

cmake/atclient.cmake

@@ -1,9 +1,10 @@
 if(NOT TARGET atclient)
-  message(
-    STATUS
-    "[ATCLIENT] package not found, fetching from local repository.."
-  )
-  fetchcontent_declare(atclient SOURCE_DIR ${atclient_DIR})
-  fetchcontent_makeavailable(atclient)
-  install(TARGETS atclient)
+    include(FetchContent)
+    message(
+            STATUS
+            "[ATCLIENT] package not found, fetching from local repository.."
+    )
+    FetchContent_Declare(atclient SOURCE_DIR ${atclient_DIR})
+    FetchContent_MakeAvailable(atclient)
+    install(TARGETS atclient)
 endif()

cmake/atcommons.cmake

@@ -0,0 +1,10 @@
+if(NOT TARGET atcommons)
+    include(FetchContent)
+    message(
+            STATUS
+            "[ATCOMMONS] package not found, fetching from local repository.. [PATH: ${atcommons_DIR}]"
+    )
+    FetchContent_Declare(atcommons SOURCE_DIR ${atcommons_DIR})
+    FetchContent_MakeAvailable(atcommons)
+    install(TARGETS atcommons)
+endif()

cmake/atlogger.cmake

@@ -1,9 +1,10 @@
 if(NOT TARGET atlogger)
-  message(
-    STATUS
-    "[ATLOGGER] package not found, fetching from local repository.."
-  )
-  fetchcontent_declare(atlogger SOURCE_DIR ${atlogger_DIR})
-  fetchcontent_makeavailable(atlogger)
-  install(TARGETS atlogger)
+  include(FetchContent)
+    message(
+            STATUS
+            "[ATLOGGER] package not found, fetching from local repository.."
+    )
+    fetchcontent_declare(atlogger SOURCE_DIR ${atlogger_DIR})
+    fetchcontent_makeavailable(atlogger)
+    install(TARGETS atlogger)
 endif()

cmake/find_cjson.cmake

@@ -4,16 +4,16 @@ set(CJSON_BUILD_SHARED_LIBS OFF CACHE BOOL "Build cjson shared libraries")
 option(ENABLE_CJSON_TEST "Enable tests for cjson" OFF)
 set(FETCHCONTENT_TRY_FIND_PACKAGE_MODE OPT_IN) # only try find_package if FIND_PACKAGE_ARGS is set
 
-message(STATUS "[cjson] fetching package...")
+message(STATUS "[cJSON] fetching package...")
 include(FetchContent)
 
-fetchcontent_declare(
+FetchContent_Declare(
   cjson
   URL https://github.com/DaveGamble/cJSON/archive/refs/tags/v1.7.17.zip
   URL_HASH
     SHA256=51f3b07aece8d1786e74b951fd92556506586cb36670741b6bfb79bf5d484216 # hash for v1.7.17 .zip release source code
   # FIND_PACKAGE_ARGS 1.7.17 QUIET CONFIG
 )
 
-fetchcontent_makeavailable(cjson)
+FetchContent_MakeAvailable(cjson)
 install(TARGETS cjson)

examples/desktop/at_talk/src/main.c

@@ -15,6 +15,7 @@
 #include <stdlib.h>
 #include <string.h>
 #include <unistd.h>
+#include <bits/getopt_core.h>
 
 #define ROOT_HOST "root.atsign.org"
 #define ROOT_PORT 64
@@ -96,8 +97,8 @@ int main(int argc, char *argv[]) {
    * 4. Authenticate client connection (for crud operations)
    */
   pthread_mutex_lock(&client_mutex);
-  atclient_pkam_authenticate_options options;
-  atclient_pkam_authenticate_options_init(&options);
+  atclient_authenticate_options options;
+  atclient_authenticate_options_init(&options);
   if ((ret = atclient_pkam_authenticate(&atclient1, from_atsign, &atkeys, &options)) != 0) {
     atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "\natclient_pkam_authenticate: %d\n", ret);
     goto exit;
@@ -189,7 +190,7 @@ exit: {
   pthread_mutex_destroy(&monitor_mutex);
   ret = pthread_cancel(tid);
   atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_INFO, "pthread exit: %d\n", ret);
-  atclient_pkam_authenticate_options_free(&options);
+  atclient_authenticate_options_free(&options);
   return ret;
 }
 }
@@ -340,8 +341,8 @@ static int reconnect_clients(atclient *monitor, atclient *ctx, const char *atser
    * 1. Reconnect client connection
    */
   atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "Reconnecting client connection...\n");
-  atclient_pkam_authenticate_options options;
-  atclient_pkam_authenticate_options_init(&options);
+  atclient_authenticate_options options;
+  atclient_authenticate_options_init(&options);
   if ((ret = atclient_pkam_authenticate(ctx, from_atsign, atkeys, &options)) != 0) {
     atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "atclient_pkam_authenticate: %d\n", ret);
     return ret;

examples/desktop/cram_authenticate/.gitignore

@@ -0,0 +1 @@
+/*build*/

examples/desktop/cram_authenticate/CMakeLists.txt

@@ -0,0 +1,10 @@
+cmake_minimum_required(VERSION 3.19)
+
+project(cram_authenticate LANGUAGES C VERSION 0.0.1)
+
+add_executable(main ${CMAKE_CURRENT_LIST_DIR}/src/main.c)
+
+find_package(atsdk CONFIG REQUIRED)
+
+target_link_libraries(main PRIVATE atsdk::atclient atsdk::atchops atsdk::atcommons)
+

examples/desktop/cram_authenticate/develop.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+set -eu
+FULL_PATH_TO_SCRIPT="$(realpath "${BASH_SOURCE[0]}")"
+SCRIPT_DIRECTORY="$(dirname "$FULL_PATH_TO_SCRIPT")"
+cd "$SCRIPT_DIRECTORY/../../../packages/atclient"
+cmake -S . -B build
+sudo cmake --build build --target install
+pwd
+cd "$SCRIPT_DIRECTORY"
+cmake -S . -B build
+cmake --build build --target all
+echo "Running main:"
+echo ""
+echo ""
+cd build && ./main
+cd ..

examples/desktop/cram_authenticate/src/main.c

@@ -0,0 +1,41 @@
+#include <atclient/atclient.h>
+#include <atlogger/atlogger.h>
+#include <atchops/base64.h>
+#include <stdio.h>
+#include <string.h>
+
+#define ROOT_HOST "root.atsign.org"
+#define ROOT_PORT 64
+
+#define CRAM_SECRET "66e026167a79cb7e9d190afe7b01b3fc4f31bc3866a08cdcec06d82a7296e9febcac5d4f4a081728fb0ec9d08f27d4f866bd6570f3fe20c65464ace76643becb"
+#define ATSIGN "@disciplinarygemini"
+
+#define TAG "cram_authenticate"
+
+int main(int argc, char **argv) {
+  int ret = 1;
+
+  atlogger_set_logging_level(ATLOGGER_LOGGING_LEVEL_DEBUG);
+
+  atclient_authenticate_options options;
+  atclient_authenticate_options_init(&options);
+
+  atclient atclient;
+  atclient_init(&atclient);
+
+  const char *atsign = ATSIGN;
+  const char *cram_secret = &CRAM_SECRET[0];
+
+  if ((ret = atclient_cram_authenticate(&atclient, ATSIGN, cram_secret, &options)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to authenticate\n");
+    goto exit;
+  } else {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "Authenticated\n");
+  }
+
+exit: {
+  atclient_free(&atclient);
+  atclient_authenticate_options_free(&options);
+  return ret;
+}
+}

examples/desktop/crud/delete.c

@@ -36,8 +36,8 @@ int main() {
   atclient_atkey_init(&atkey);
   atclient_atkeys_init(&atkeys);
 
-  atclient_pkam_authenticate_options options;
-  atclient_pkam_authenticate_options_init(&options);
+  atclient_authenticate_options options;
+  atclient_authenticate_options_init(&options);
 
   if ((ret = atclient_atkeys_populate_from_path(&atkeys, ATKEYS_FILE_PATH)) != 0) {
     atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to populate atkeys");
@@ -65,7 +65,7 @@ exit: {
   atclient_free(&atclient);
   atclient_atkey_free(&atkey);
   atclient_atkeys_free(&atkeys);
-  atclient_pkam_authenticate_options_free(&options);
+  atclient_authenticate_options_free(&options);
   return ret;
 }
 }

examples/desktop/crud/get_publickey.c

@@ -45,8 +45,8 @@ int main() {
   atclient_atkeys_init(&atkeys);
   atclient_atkeys_populate_from_path(&atkeys, ATKEYS_FILE_PATH);
 
-  atclient_pkam_authenticate_options options;
-  atclient_pkam_authenticate_options_init(&options);
+  atclient_authenticate_options options;
+  atclient_authenticate_options_init(&options);
 
   char *atkeystr = NULL;
 
@@ -94,7 +94,7 @@ exit: {
   atclient_atkeys_free(&atkeys);
   atclient_atkey_free(&atkey);
   atclient_free(&atclient);
-  atclient_pkam_authenticate_options_free(&options);
+  atclient_authenticate_options_free(&options);
   free(atkeystr);
   return ret;
 }