Add namespace flexibility to v1 branch

CMakeLists.txt

@@ -8,12 +8,34 @@ project(sframe
 option(TESTING    "Build tests" OFF)
 option(CLANG_TIDY "Perform linting with clang-tidy" OFF)
 option(SANITIZERS "Enable sanitizers" OFF)
+option(NAMESPACE_SUFFIX "Namespace Suffix for CXX and CMake Export")
+
+if(NAMESPACE_SUFFIX)
+    set(SFRAME_CXX_NAMESPACE "sframe_${NAMESPACE_SUFFIX}" CACHE STRING "Top-level Namespace for CXX")
+    set(SFRAME_EXPORT_NAMESPACE "SFrame${NAMESPACE_SUFFIX}" CACHE STRING "Namespace for CMake Export")
+else()
+    set(SFRAME_CXX_NAMESPACE "sframe" CACHE STRING "Top-level Namespace for CXX")
+    set(SFRAME_EXPORT_NAMESPACE "SFrame" CACHE STRING "Namespace for CMake Export")
+endif()
+message(STATUS "CXX Namespace: ${SFRAME_CXX_NAMESPACE}")
+message(STATUS "CMake Export Namespace: ${SFRAME_EXPORT_NAMESPACE}")
+
+# Use -DCRYPTO=(OPENSSL_1_1 | OPENSSL_3 | BORINGSSL) to configure crypto
+if(NOT DEFINED CRYPTO)
+  set(CRYPTO "OPENSSL_3")
+endif()
 
 ###
 ### Global Config
 ###
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 
+configure_file(
+  "${CMAKE_CURRENT_SOURCE_DIR}/cmake/namespace.h.in"
+  "${CMAKE_CURRENT_BINARY_DIR}/include/namespace.h"
+  @ONLY
+)
+
 set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 if (CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR CMAKE_CXX_COMPILER_ID MATCHES "GNU")
@@ -49,7 +71,24 @@ endif()
 ###
 
 # External libraries
-find_package(OpenSSL 1.1 REQUIRED)
+if(${CRYPTO} STREQUAL "OPENSSL_1_1")
+  message(STATUS "Configuring with OpenSSL 1.1")
+  find_package(OpenSSL 1.1 EXACT REQUIRED)
+  add_compile_definitions(OPENSSL_1_1)
+  set(CRYPTO_LIB OpenSSL::Crypto)
+elseif(${CRYPTO} STREQUAL "OPENSSL_3")
+  message(STATUS "Configuring with OpenSSL 3")
+  find_package(OpenSSL 3 EXACT REQUIRED)
+  add_compile_definitions(OPENSSL_3)
+  set(CRYPTO_LIB OpenSSL::Crypto)
+elseif(${CRYPTO} STREQUAL "BORINGSSL")
+  message(STATUS "Configuring with BoringSSL")
+  find_package(OpenSSL REQUIRED)
+  add_compile_definitions(BORINGSSL)
+  set(CRYPTO_LIB OpenSSL::Crypto)
+else()
+  message(FATAL_ERROR "Please select a crypto back-end (OPENSSL_1_1 or OPENSSL_3) [${CRYPTO}]")
+endif()
 
 # gsl-lite fetched from GitHub
 include( ExternalProject )
@@ -82,14 +121,16 @@ target_include_directories( gsl INTERFACE ${GSL_LITE_INCLUDE_DIR} )
 set(LIB_NAME "${PROJECT_NAME}")
 
 file(GLOB_RECURSE LIB_HEADERS CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/include/*.h")
+file(GLOB_RECURSE LIB_GENERATED_HEADERS CONFIGURE_DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/include/*.h")
 file(GLOB_RECURSE LIB_SOURCES CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp")
 
-add_library(${LIB_NAME} ${LIB_HEADERS} ${LIB_SOURCES})
+add_library(${LIB_NAME} ${LIB_HEADERS} ${LIB_GENERATED_HEADERS} ${LIB_SOURCES})
 add_dependencies(${LIB_NAME} gsl)
 target_link_libraries(${LIB_NAME} PRIVATE gsl OpenSSL::Crypto)
 target_include_directories(${LIB_NAME}
   PUBLIC
     $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/include>
     $<INSTALL_INTERFACE:include/${PROJECT_NAME}-${PROJECT_VERSION}>
 )
 

Makefile

@@ -10,6 +10,10 @@ CLANG_FORMAT=clang-format -i
 TEST_VECTOR_DIR=./build/test
 TEST_GEN=./build/cmd/test_gen/test_gen
 
+OPENSSL_1_1_MANIFEST=alternatives/OPENSSL_1_1
+OPENSSL_3_MANIFEST=alternatives/OPENSSL_3
+BORINGSSL_MANIFEST=alternatives/BORINGSSL
+
 .PHONY: all tidy test clean cclean format
 
 all: ${BUILD_DIR}
@@ -19,7 +23,19 @@ ${BUILD_DIR}: CMakeLists.txt test/CMakeLists.txt
 	cmake -B${BUILD_DIR} .
 
 dev: CMakeLists.txt test/CMakeLists.txt
-	cmake -B${BUILD_DIR} -DCLANG_TIDY=ON -DTESTING=ON -DSANITIZERS=ON .
+	cmake -B${BUILD_DIR} -DCMAKE_BUILD_TYPE=Debug -DTESTING=ON \
+		-DCLANG_TIDY=ON -DSANITIZERS=ON \
+		-DCRYPTO=OPENSSL_3 -DVCPKG_MANIFEST_DIR=${OPENSSL_3_MANIFEST}
+
+dev1: CMakeLists.txt test/CMakeLists.txt
+	cmake -B${BUILD_DIR} -DCMAKE_BUILD_TYPE=Debug -DTESTING=ON \
+		-DCLANG_TIDY=ON -DSANITIZERS=ON \
+		-DCRYPTO=OPENSSL_1_1 -DVCPKG_MANIFEST_DIR=${OPENSSL_1_1_MANIFEST}
+
+devB: CMakeLists.txt test/CMakeLists.txt
+	cmake -B${BUILD_DIR} -DCMAKE_BUILD_TYPE=Debug -DTESTING=ON \
+		-DCLANG_TIDY=ON -DSANITIZERS=ON \
+		-DCRYPTO=BORINGSSL -DVCPKG_MANIFEST_DIR=${BORINGSSL_MANIFEST}
 
 test: ${BUILD_DIR} test/*
 	cmake --build ${BUILD_DIR} --target sframe_test

alternatives/BORINGSSL/vcpkg.json

@@ -0,0 +1,14 @@
+{
+  "name": "mlspp",
+  "version-string": "0.1",
+  "description": "Cisco MLS C++ library (BoringSSL 1.1)",
+  "dependencies": [
+    {
+      "name": "boringssl",
+      "version>=": "2023-10-13"
+    },
+    "doctest",
+    "nlohmann-json"
+  ],
+  "builtin-baseline": "eb33d2f7583405fca184bcdf7fdd5828ec88ac05"
+}

alternatives/OPENSSL_1_1/vcpkg.json

@@ -0,0 +1,20 @@
+{
+  "name": "mlspp",
+  "version-string": "0.1",
+  "description": "Cisco MLS C++ library",
+  "dependencies": [
+    {
+      "name": "openssl",
+      "version>=": "1.1.1n"
+    },
+    "doctest",
+    "nlohmann-json"
+  ],
+  "builtin-baseline": "eb33d2f7583405fca184bcdf7fdd5828ec88ac05",
+  "overrides": [
+    {
+      "name": "openssl",
+      "version-string": "1.1.1n"
+    }
+  ]
+}

alternatives/OPENSSL_3/vcpkg.json

@@ -0,0 +1,20 @@
+{
+  "name": "mlspp",
+  "version-string": "0.1",
+  "description": "Cisco MLS C++ library (OpenSSL 3)",
+  "dependencies": [
+    {
+      "name": "openssl",
+      "version>=": "3.0.7"
+    },
+    "doctest",
+    "nlohmann-json"
+  ],
+  "builtin-baseline": "eb33d2f7583405fca184bcdf7fdd5828ec88ac05",
+  "overrides": [
+    {
+      "name": "openssl",
+      "version": "3.0.7"
+    }
+  ]
+}

cmake/namespace.h.in

@@ -0,0 +1,4 @@
+#pragma once
+
+// Configurable top-level namespace
+#define SFRAME_NAMESPACE @SFRAME_CXX_NAMESPACE@

include/sframe/sframe.h

@@ -5,9 +5,10 @@
 #include <memory>
 #include <vector>
 
+#include <namespace.h>
 #include <gsl/gsl-lite.hpp>
 
-namespace sframe {
+namespace SFRAME_NAMESPACE {
 
 struct openssl_error : std::runtime_error
 {
@@ -147,4 +148,4 @@ class MLSContext : public SFrame
   KeyState& get_state(KeyID key_id) override;
 };
 
-} // namespace sframe
+} // namespace SFRAME_NAMESPACE