Generate SBOM package records

CMakeLists.txt

@@ -3,10 +3,18 @@
 # We also add dependencies to targets defined elsewhere.
 # If any of options defined herein already exists as a variable, then do nothing;
 # This allows users to configure the kernel in their CMakeLists.txt
+cmake_minimum_required(VERSION 3.15)
 cmake_policy(SET CMP0079 NEW)
 cmake_policy(SET CMP0076 NEW)
 cmake_policy(SET CMP0077 NEW)
-
+set(CMRX_VERSION 0.1.3)
+set(CMRX_DOWNLOAD_REPOSITORY git+https://github.com/ventZl/cmrx)
+set(CMRX_ORGANIZATION "CMRX Microkernel RTOS Project")
+set(CMRX_CONTACT_EMAIL "info@cmrxrtos.org")
+set(CMRX_LICENSE_NAME "MIT")
+set(CMRX_SPDXID SPDXRef-CMRX-RTOS)
+
+project(cmrx-rtos VERSION ${CMRX_VERSION} LANGUAGES C ASM)
 message(DEBUG "CMRX root dir: ${CMAKE_CURRENT_SOURCE_DIR}")
 set_property(GLOBAL PROPERTY CMRX_ROOT_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
 
@@ -16,13 +24,6 @@ include(cmake/unit_test_build.cmake)
 include(cmake/clang-tidy.cmake)
 include(cmake/testing.cmake)
 
-CPMAddPackage(
-    NAME ctest
-    GIT_REPOSITORY "https://github.com/bvdberg/ctest"
-    GIT_TAG master
-    DOWNLOAD_ONLY YES
-    )
-
 include_directories(include)
 include_directories(${CMAKE_BINARY_DIR})
 add_definitions(-Wall -Wextra)
@@ -46,7 +47,34 @@ if (NOT UNIT_TESTING_BUILD)
     endif()
 
     include_directories(${HAL_PATH})
+    if (COMMAND sbom_add_package)
+        sbom_add_package(CMRX
+            VERSION ${CMRX_VERSION}
+            SUPPLIER ORGANIZATION "${CMRX_ORGANIZATION}" EMAIL "${CMRX_CONTACT_EMAIL}"
+            SPDXID ${CMRX_SPDXID}
+            LICENSE "${CMRX_LICENSE_NAME}"
+            DECLARED "${CMRX_LICENSE_NAME}"
+            PURPOSE "OPERATING-SYSTEM"
+            DOWNLOAD ${CMRX_DOWNLOAD_REPOSITORY}
+            )
+    endif()
+    if (COMMAND sbom_add)
+        sbom_add(
+            PACKAGE CMRX
+            DOWNLOAD_LOCATION ${CMRX_DOWNLOAD_REPOSITORY}
+            LICENSE "${CMRX_LICENSE_NAME}"
+            SPDXID ${CMRX_SPDXID}
+            SUPPLIER "Organization: ${CMRX_ORGANIZATION} (${CMRX_CONTACT_EMAIL})"
+            VERSION ${CMRX_VERSION}
+            )
+    endif()
 else()
+    CPMAddPackage(
+        NAME ctest
+        GIT_REPOSITORY "https://github.com/bvdberg/ctest"
+        GIT_TAG master
+        DOWNLOAD_ONLY YES
+        )
     # Parent CMake will set these, get rid of them
     unset(ENV{CC})
     unset(ENV{CXX})

README.md

@@ -58,6 +58,7 @@ See [step-by-step guide](https://ventzl.github.io/cmrx/getting_started.html) on
  * C11 clean
  * compatible with all vendor SDKs providing CMSIS headers
  * runs hosted on Linux machine
+ * SBOM provisioning
 
 # Documentation
 
@@ -91,9 +92,13 @@ Static code analysis can be performed using Clang-tidy on fully configured sourc
 
 Integration tests are always executed on target hardware. It is using [HIL testing harness](HIL_TESTING.md) to execute these tests. Integration tests check that the functionality provided by CMRX kernel is implemented correctly and behaves as expected using particular porting layer of your choice. These tests take much longer to execute and require physical hardware to be attached to the machine which executes these tests so it is less suitable for frequent execution in CI/CD pipeline.
 
-HIL testing harness can be used by your own tests to automate test execution. This can be combined with or without kernel's own integration tests. For more information see the [HIL_TESTING.md] file.
+HIL testing harness can be used by your own tests to automate test execution. This can be combined with or without kernel's own integration tests. For more information see the HIL testing harness documentation file.
 
+# SBOM generation
 
+CMRX is designed to participate on SBOM generation for projects that are using it. This feature is optional and it is turned on automatically if [CMAKE-SBOM-Builder](https://github.com/sodgeit/CMake-SBOM-Builder) or [cmake-sbom](https://github.com/DEMCON/cmake-sbom) are included in your project. CMRX will generate package entry for itself in your SBOM automatically.
+
+To use this feature, no special steps are needed aside from properly integrating one of supported SBOM generators. Note that for this feature to work you have to include CMRX source directory after the point of call to `sbom_generate` function.
 
 # Contributing