Checkpoint Development for Mock BPA Requirements Testing (#11)

* squash test

* Added initial implementation of abstract mock bpa policy, still need better memory management

* Adding more fields for policy granularity

* Finished new draft of multiple mock bpa policy registrations with memory handling

* tests + init json

* pp conf json

* ion pp

* submodule updates

* correct mlib ver

* formatting

* file as param

* cleaning up json parsing, err checking

* comments

* more requirements tests

* requirements tests progress

* Adding comments for each test for clarity

* keyset json

* base64url -> base16

* cli option for keyset

* update key json reading

* keys from json

* small changes to merge in

* Updated policies in the requirements tests

* json pp

* json work?

* Update for error handling of key initialization

* Fix for possible memory corruption from free()

* idk

* Some cleanup for merging

* cleaning up

* PR patches

* remove temp file

* import star removals

* Adding jansson to CI and RPM deps

* Fix jansson link config, try pkg-config first

* Added new front-end interface to use memory pool-type thing for policy registry

* Update to fix key interface based on main

* Fix to memory pool deinit and missing key ids

* Bug fixes for policy location and BCB policy initialization

* cleanup & fixes

* param fix

* fix up test fixtures

* fix mock bpa issues

* fix 14 test fixture

* bsl_02 working; KEK decrypt fixes

* pass 47, needs work on encrypt KEK

* policy bits fix

* init epxected no output

* quickfix

* Forcing bundle drop with extraneous bits

* forgot to target primary block

* appeasing the symbol checker

* revert keywrap modification

* keywrap bit

* use wrapped key bit

* in progress: BSL_17

* BSL17

* implement more tests

* bsl33

* Fixing some formatting and clang-error spacing

* Fixed mock bpa poll checking and bundle decoder error checking. Added simple start-stop test.

* Fix CI prep options

* Update packages.yaml

* ipn change

* Fixing memory issues for simple start-stop test

* Fixing struct leak

* Using timeout exception with assertRaises in tests, no change to logic

* Fixed naming convention

* move secp deinit, cleanup comments

* Getting mock bpa runner to pass for merge

* A more graceful way of getting mock bpa test runner to pass

* retrigger checks

* Temporary shim to get runner checks passing

* Format checker changes

* Trying again to make format checker happy

* Fixing doxygen tree structure (broken by license markings)

* remove assert

---------

Co-authored-by: Joshua Stone <joshua.stone@jhuapl.edu>
Co-authored-by: Brian Sipos <brian.sipos@jhuapl.edu>

Author: 3 people

.github/workflows/build-test.yaml

@@ -55,7 +55,7 @@ jobs:
               cmake ninja-build \
               ruby pkg-config ccache patch \
               ${{matrix.compiler=='clang' && 'clang llvm' || 'gcc g++'}} \
-              libssl-dev \
+              libssl-dev libjansson-dev \
               valgrind gcovr xmlstarlet
       - name: Set up OS
         if: startsWith(matrix.os, 'centos')
@@ -67,7 +67,7 @@ jobs:
               cmake ninja-build \
               ruby pkg-config ccache patch \
               ${{matrix.compiler=='clang' && 'clang llvm' || 'gcc gcc-c++'}} \
-              openssl-devel \
+              openssl-devel jansson-devel \
               valgrind xmlstarlet python3-pip
           pip3 install gcovr
       - name: Checkout repository
@@ -129,7 +129,7 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y \
               cmake ninja-build ruby gcc g++ ccache patch \
-              libssl-dev \
+              libssl-dev libjansson-dev \
               valgrind gcovr xmlstarlet
       - name: Set up OS
         if: startsWith(matrix.os, 'centos')
@@ -140,7 +140,7 @@ jobs:
               git rsync \
               cmake ninja-build \
               ruby pkg-config gcc gcc-c++ ccache patch \
-              openssl-devel \
+              openssl-devel jansson-devel \
               valgrind xmlstarlet python3-pip
           pip3 install gcovr
       - name: Checkout repository

.github/workflows/codeql.yml

@@ -86,7 +86,7 @@ jobs:
       run: |
         sudo apt-get update && sudo apt-get install -y \
           cmake ninja-build ruby build-essential \
-          libssl-dev
+          libssl-dev libjansson-dev
         ./build.sh deps
         ./build.sh prep -DTEST_MEMCHECK=OFF -DTEST_COVERAGE=OFF -DBUILD_DOCS_API=OFF -DBUILD_DOCS_MAN=OFF
 

.github/workflows/docs.yaml

@@ -44,7 +44,7 @@ jobs:
         run: |
           sudo apt-get update && sudo apt-get install -y \
             cmake ninja-build ruby build-essential \
-            libssl-dev \
+            libssl-dev libjansson-dev \
             doxygen graphviz plantuml texlive texlive-latex-extra dblatex
       - name: Dependency build
         run: ./build.sh deps

.github/workflows/packages.yaml

@@ -42,7 +42,7 @@ jobs:
           dnf install -y epel-release
           dnf install -y \
               rsync cmake git ninja-build gcc ruby \
-              openssl-devel \
+              openssl-devel jansson-devel \
               doxygen graphviz plantuml texlive-bibtex \
               asciidoctor \
               rpm-build rpmlint
@@ -52,7 +52,7 @@ jobs:
           fetch-depth: 0
           submodules: recursive
       - name: Prep
-        run: ./build.sh prep -DBUILD_LIB=OFF -DBUILD_TESTING=OFF -DBUILD_DOCS=OFF -DBUILD_PACKAGE=ON
+        run: ./build.sh prep -DBUILD_LIB=OFF -DBUILD_TESTING=OFF -DBUILD_DOCS_API=OFF -DBUILD_DOCS_MAN=OFF -DBUILD_PACKAGE=ON
       - name: Build
         run: |
           ./build.sh rpm-build

.gitignore

@@ -11,3 +11,5 @@ build
 testroot
 __pycache__
 /.pytest_cache/
+venv/
+mock-bpa-test/ccsds_bpsec_redbook_draft_734.5-R-2_requirements_implementation_guide.yaml

CMakeLists.txt

@@ -115,6 +115,7 @@ if(BUILD_LIB)
     find_package(QCBOR REQUIRED)
     find_package(OpenSSL REQUIRED)
     find_package(Threads REQUIRED)
+    find_package(jansson REQUIRED)
 endif(BUILD_LIB)
 
 include(CheckSymbolExists)

cmake/Findjansson.cmake

@@ -0,0 +1,18 @@
+
+# Try pkg-config first
+pkg_search_module(JANSSON jansson IMPORTED_TARGET)
+if(JANSSON_FOUND)
+    add_library(Jansson::Jansson ALIAS PkgConfig::JANSSON)
+endif(JANSSON_FOUND)
+
+# Fall-back to manual
+if(NOT JANSSON_FOUND)
+    find_path(JANSSON_HEADER NAMES jansson.h REQUIRED)
+    find_library(JANSSON_LIB NAMES jansson REQUIRED)
+
+    add_library(Jansson::Jansson SHARED IMPORTED)
+    set_target_properties(Jansson::Jansson PROPERTIES
+        INTERFACE_INCLUDE_DIRECTORIES "${JANSSON_HEADER}"
+        IMPORTED_LOCATION "${JANSSON_LIB}"
+    )
+endif(NOT JANSSON_FOUND)

docs/CMakeLists.txt

@@ -19,8 +19,7 @@ Institute of Technology, sponsored by the United States Government under
 the prime contract 80NM0018D0004 between the Caltech and NASA under
 subcontract 1700763.
 ]]
-#message(${BUILD_DOCS_API})
-#add_subdirectory(api)
+
 if(BUILD_DOCS_API)
     add_subdirectory(api)
 endif(BUILD_DOCS_API)

docs/api/CMakeLists.txt

@@ -20,17 +20,27 @@ the prime contract 80NM0018D0004 between the Caltech and NASA under
 subcontract 1700763.
 ]]
 find_package(Doxygen REQUIRED)
-find_program(MAKE_EXECUTABLE make REQUIRED)
+
+find_program(MAKE_EXECUTABLE make)
 message(STATUS "Found make at ${MAKE_EXECUTABLE}")
 find_program(DBLATEX_EXECUTABLE dblatex)
+message(STATUS "Found dblatex at ${DBLATEX_EXECUTABLE}")
+find_file(
+  PLANTUML_JAR
+  NAMES plantuml.jar
+  PATH_SUFFIXES "share/java" "share/plantuml"
+)
+if(PLANTUML_JAR)
+    message(STATUS "Found plantuml at ${PLANTUML_JAR}")
+endif(PLANTUML_JAR)
 
 configure_file(Doxyfile.in Doxyfile @ONLY)
 
-add_custom_command(
-    OUTPUT
+add_custom_target(
+    docs-api-html
+    BYPRODUCTS
         ${CMAKE_CURRENT_BINARY_DIR}/html/index.html
         ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.tex
-    BYPRODUCTS
         ${CMAKE_CURRENT_BINARY_DIR}/latex/Makefile
     DEPENDS
         ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
@@ -41,26 +51,6 @@ add_custom_command(
     COMMENT "Generating API documentation with Doxygen"
     USES_TERMINAL
 )
-
-add_custom_command(
-    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.pdf
-    DEPENDS
-        ${CMAKE_CURRENT_BINARY_DIR}/latex/Makefile
-        ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.tex
-    COMMAND ${MAKE_EXECUTABLE}
-    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/latex
-    COMMENT "Generating API documentation PDF"
-)
-
-add_custom_target(
-    docs-api-html
-    DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/html/index.html
-)
-add_custom_target(
-    docs-api-pdf
-    DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.pdf
-)
-
 include(GNUInstallDirs)
 install(
     FILES
@@ -73,12 +63,24 @@ install(
     TYPE DOC
     COMPONENT docs-api
 )
-if(DBLATEX_EXECUTABLE)
-install(
-    FILES
-        ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.pdf
-    TYPE DOC
-    RENAME "BSL-API.pdf"
-    COMPONENT docs-api
-)
-endif(DBLATEX_EXECUTABLE)
+
+if(MAKE_EXECUTABLE AND DBLATEX_EXECUTABLE)
+    add_custom_target(
+        docs-api-pdf
+        BYPRODUCTS
+            ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.pdf
+        DEPENDS
+            ${CMAKE_CURRENT_BINARY_DIR}/latex/Makefile
+            ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.tex
+        COMMAND ${MAKE_EXECUTABLE}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/latex
+        COMMENT "Generating API documentation PDF"
+    )
+    install(
+        FILES
+            ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.pdf
+        TYPE DOC
+        RENAME "${PROJECT_NAME}-api.pdf"
+        COMPONENT docs-api
+    )
+endif(MAKE_EXECUTABLE AND DBLATEX_EXECUTABLE)

docs/api/Developer_Guide.md

@@ -1,3 +1,4 @@
+@page Developer_Guide Developer Guide
 <!--
 Copyright (c) 2025 The Johns Hopkins University Applied Physics
 Laboratory LLC.
@@ -20,8 +21,6 @@ the prime contract 80NM0018D0004 between the Caltech and NASA under
 subcontract 1700763.
 -->
 
-# Developer Guide
-
 This page covers information for **Backend Developers**, or more specifically those who may be implementing a BPSec backend, or a new Security Context or Policy Provider.
 
 This page contains conventions necessary for BSL developers and helpful for BSL users to understand.