Anjay Lite 1.0.0-beta.2

Author: Łukasz Kwinta

.gitignore

@@ -23,6 +23,7 @@ CMakeFiles/
 CMakeDoxyfile.in
 *.cmake
 !cmake/*.cmake
+!tests/init_header_check/run_check.cmake
 CMakeCache.txt
 Makefile
 __pycache__/
@@ -44,6 +45,7 @@ libanj.a
 /dm_without_composite_tests
 /exchange_tests
 /core_tests
+/downloader_tests
 /net_tests
 /anj_config
 /cxx_header_check

CHANGELOG.md

@@ -1,5 +1,39 @@
 # Changelog
 
+## Anjay Lite 1.0.0-beta.2 (Aughust 27th, 2025)
+
+### BREAKING CHANGES
+
+- Changed error codes defined in the `anj_net_api.h` to positive values. Returning any positive values from the
+  user Network API implementation, other than `ANJ_NET_E*`, is prohibited.
+
+### Features
+
+- CoAP Downloader module for large file transfers from CoAP servers, supporting FOTA Pull scenarios.
+- Added support for Write-Composite operation.
+
+### Improvements
+
+- Added `anj/init.h` header to make config includes and option dependency checks
+  more consistent.
+- Removed unnecessary usages of `ANJ_CONTAINER_OF()` in object implementation
+  examples.
+- Introduce Python tools for downloading object XMLs from OMA registry - `tools/lwm2m_object_registry.py` and generating
+  object stubs - `tools/anjay_codegen.py`
+- Implemented responses caching
+- If no confirmable notification is sent for 24 hours, the next notification sent will be confirmable.
+- The library now follows the include pattern recommendations from Include What You Use (IWYU) version 0.24 
+  compatible with clang 20.
+
+### Bugfixes
+
+- Fixed improper handling of LwM2M Server responses in Separate Response mode.
+- Updated default value in description of `ANJ_COAP_MAX_OPTIONS_NUMBER` option.
+- Fixed an issue with calling the observation module API during message exchange handling.
+- Corrected the timing for setting the last sent notification timestamp.
+- Fixed an issue that allowed server both bootstrap and management to freely read 
+  the Security and OSCORE objects.
+
 ## Anjay Lite 1.0.0-beta.1 (June 9th, 2025)
 
 Initial release.

CMakeLists.txt

@@ -5,14 +5,14 @@
 # Licensed under AVSystem Anjay Lite LwM2M Client SDK - Non-Commercial License.
 # See the attached LICENSE file for details.
 
-cmake_minimum_required(VERSION 3.6.0)
+cmake_minimum_required(VERSION 3.16.0)
+
+project(anjay_lite C)
 
 # Core CMake code is located in cmake/anjay_lite-config.cmake and the library is
 # supposed to be imported using find_package() mechanism - this file only meant
 # to be a convenience wrapper for all example and test targets.
 
-project(anjay_lite C)
-
 set(CMAKE_C_STANDARD 99)
 set(CMAKE_C_EXTENSIONS OFF)
 
@@ -24,6 +24,17 @@ find_program(VALGRIND_EXECUTABLE valgrind)
 
 add_custom_target(run_tests)
 
+# determine list of -D variables set by users, they need to be prefixed with CLI_
+get_cmake_property(_cache_vars CACHE_VARIABLES)
+set(COMMAND_LINE_FLAGS "")
+foreach(_var ${_cache_vars})
+    if(_var MATCHES "CLI_")
+        list(APPEND COMMAND_LINE_FLAGS "-D${_var}=${${_var}}")
+    endif()
+endforeach()
+
+message(STATUS "Command line flags: ${COMMAND_LINE_FLAGS}")
+
 function(add_standalone_target NAME PATH WITH_VALGRIND)
   set(workdir "${CMAKE_BINARY_DIR}/${NAME}")
 
@@ -32,16 +43,18 @@ function(add_standalone_target NAME PATH WITH_VALGRIND)
 
   add_custom_target(${NAME} ALL)
   add_custom_command(TARGET ${NAME} COMMAND ${CMAKE_COMMAND} -E make_directory
-                                            "${workdir}")
+                                            "${workdir}" PRE_BUILD)
   add_custom_command(
     TARGET ${NAME}
     COMMAND
       ${CMAKE_COMMAND} -S "${CMAKE_CURRENT_SOURCE_DIR}/${PATH}" -B .
       -DCMAKE_C_COMPILER="${CMAKE_C_COMPILER}"
       -DCMAKE_C_FLAGS="${unescaped_c_flags}"
       -DCMAKE_EXE_LINKER_FLAGS="${unescaped_exe_linker_flags}"
+      ${COMMAND_LINE_FLAGS}
     COMMAND ${CMAKE_COMMAND} --build . --target ${NAME} -- -j${NPROC}
-    WORKING_DIRECTORY "${workdir}")
+    WORKING_DIRECTORY "${workdir}" 
+    POST_BUILD)
 
   if(WITH_VALGRIND AND VALGRIND_EXECUTABLE)
     add_custom_target(
@@ -53,7 +66,7 @@ function(add_standalone_target NAME PATH WITH_VALGRIND)
 
   if(${NAME} MATCHES "_tests")
     add_dependencies(run_tests ${NAME})
-    add_custom_command(TARGET run_tests COMMAND "${workdir}/${NAME}")
+    add_custom_command(TARGET run_tests COMMAND "${workdir}/${NAME}" POST_BUILD)
   endif()
 endfunction()
 
@@ -68,9 +81,11 @@ add_standalone_target(io_tests_without_extended tests/anj/io_without_extended ON
 add_standalone_target(coap_tests tests/anj/coap ON)
 add_standalone_target(net_tests tests/anj/net ON)
 add_standalone_target(core_tests tests/anj/core ON)
+add_standalone_target(downloader_tests tests/anj/downloader ON)
 
 # examples
 add_standalone_target(anjay_lite_firmware_update examples/tutorial/firmware-update OFF)
+add_standalone_target(anjay_lite_firmware_update_pull examples/tutorial/firmware-update-coap-downloader OFF)
 
 add_standalone_target(anjay_lite_bc_initialization examples/tutorial/BC-Initialization OFF)
 add_standalone_target(anjay_lite_bc_mandatory_objects examples/tutorial/BC-MandatoryObjects OFF)
@@ -88,8 +103,20 @@ add_standalone_target(anjay_lite_at_multi_instance_resource_dynamic examples/tut
 add_standalone_target(anjay_lite_minimal_network_api examples/custom-network/minimal OFF)
 add_standalone_target(anjay_lite_reuse_port examples/custom-network/reuse-port OFF)
 
+add_standalone_target(anjay_lite_mbedtls_build examples/tutorial/mbedtls-build OFF)
+
 # Sphinx and doxygen documentation
 add_subdirectory(doc)
 
 # C++ header compatibility check
 add_standalone_target(cxx_header_check tests/cxx_header_check OFF)
+
+add_standalone_target(codegen_compilation_check tests/codegen/compilation OFF)
+add_standalone_target(codegen_object_registry_check tests/codegen/object_registry OFF)
+add_standalone_target(codegen_add_object_tests tests/codegen/add_object OFF)
+
+# Check for correct inclusion of anj/init.h
+add_custom_target(init_header_check
+  COMMAND ${CMAKE_COMMAND} -P "${CMAKE_CURRENT_SOURCE_DIR}/tests/init_header_check/run_check.cmake"
+  WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
+)

Doxyfile

@@ -2394,7 +2394,7 @@ PREDEFINED             = ANJ_IN_MSG_BUFFER_SIZE \
                          ANJ_OUT_PAYLOAD_BUFFER_SIZE \
                          ANJ_DM_MAX_OBJECTS_NUMBER \
                          ANJ_WITH_COMPOSITE_OPERATIONS \
-                         ANJ_DM_MAX_COMPOSITE_ENTRIES \
+                         ANJ_DM_MAX_COMP_READ_ENTRIES \
                          ANJ_WITH_DEFAULT_DEVICE_OBJ \
                          ANJ_WITH_DEFAULT_SECURITY_OBJ \
                          ANJ_SEC_OBJ_MAX_PUBLIC_KEY_OR_IDENTITY_SIZE \

LICENSE

@@ -36,8 +36,8 @@ Purposes, as defined below.
    1. use the Software for Non-Commercial Purposes;
    2. copy and modify the Software;
    3. distribute unmodified or modified versions of the Software, provided that:
-      - Redistribution of source code must retain AVSystem’s copyright notice
-        and include the list of usage conditions and AVSystem’s disclaimer;
+      - Redistribution of source code must retain AVSystem's copyright notice
+        and include the list of usage conditions and AVSystem's disclaimer;
       - Redistribution in binary form, except as embedded in a physical device,
         must include the following acknowledgment in accompanying documentation
         or user interface: "This product includes software developed by AVSystem

LICENSE.3RDPARTY

@@ -4,7 +4,7 @@ The core Anjay Lite LwM2M Client Library is entirely developed and maintained by
 AVSystem and is free of any third-party open-source code dependencies.
 
 This file lists licenses of any third-party components that are used solely in
-the SDK’s supporting infrastructure, such as documentation generation (e.g.
+the SDK's supporting infrastructure, such as documentation generation (e.g.
 Doxygen) or development tooling. These components are not part of the runtime
 library itself.
 

README.md

@@ -43,6 +43,7 @@ issues via our GitHub repository.
 * [About OMA LwM2M](#about-oma-lwm2m)
 * [Quickstart Guide](#quickstart-guide)
   * [Building and Running a Single Anjay Lite Example](#building-and-running-a-single-anjay-lite-example)
+  * [Configuring the MbedTLS](#configuring-the-mbedtls)
 * [Documentation](#documentation)
 * [License](#license)
 * [Commercial Support](#commercial-support)
@@ -120,6 +121,45 @@ make -j
 
 Replace <endpoint_name> with your desired endpoint name.
 
+### Configuring the MbedTLS
+
+Anjay Lite uses Mbed TLS to implement DTLS for secure transport.
+The library automatically fetches and builds MbedTLS version 3.6.0 during the
+build process. You can override this default version or use a custom, pre-installed MbedTLS library if needed.
+
+To override the default version fetched via FetchContent, set the MBEDTLS_VERSION variable:
+
+``` sh
+cd examples/tutorial/mbedtls-build
+mkdir build
+cd build
+cmake .. -DMBEDTLS_VERSION=3.5.0
+make -j
+```
+
+If you want to use your own prebuilt version of MbedTLS with custom configuration, follow these steps:
+
+1. Build and install MbedTLS manually (in specified directory, without affecting global installed MbedTLS):
+
+``` sh
+git clone https://github.com/ARMmbed/mbedtls.git
+cd mbedtls
+git checkout v3.4.0 # or another supported version
+# change configuration using scripts/config.py or modify mbedtls_config.h directly
+cmake . -DCMAKE_INSTALL_PREFIX=$PWD/install
+make install
+```
+
+2. Build Anjay Lite with that installed version:
+
+``` sh
+cd /path/to/anjay-lite/build
+cmake .. -DMBEDTLS_ROOT_DIR=mbedtls-path/mbedtls/install
+make -j
+```
+
+Anjay Lite requires MbedTLS 3.x. Versions from the 2.x series are not supported.
+
 <p align="right">(<a href="#readme-top">Back to top</a>)</p>
 
 ## Documentation

cmake/anjay_lite-config.cmake

@@ -5,7 +5,7 @@
 # Licensed under AVSystem Anjay Lite LwM2M Client SDK - Non-Commercial License.
 # See the attached LICENSE file for details.
 
-cmake_minimum_required(VERSION 3.6.0)
+cmake_minimum_required(VERSION 3.16.0)
 
 project(anjay_lite)
 
@@ -44,7 +44,7 @@ define_overridable_option(ANJ_OUT_PAYLOAD_BUFFER_SIZE STRING 1024 "Payload buffe
 # data model configuration
 define_overridable_option(ANJ_DM_MAX_OBJECTS_NUMBER STRING 10 "Max LwM2M Objects defined in data model")
 define_overridable_option(ANJ_WITH_COMPOSITE_OPERATIONS BOOL ON "Enable composite operations support")
-define_overridable_option(ANJ_DM_MAX_COMPOSITE_ENTRIES STRING 5 "Max entries (paths) in a composite operations")
+define_overridable_option(ANJ_DM_MAX_COMP_READ_ENTRIES STRING 5 "Max entries (paths) in a composite read operation")
 
 # device object configuration
 define_overridable_option(ANJ_WITH_DEFAULT_DEVICE_OBJ BOOL ON "Enable default implementation of Device Object")
@@ -69,6 +69,11 @@ define_overridable_option(ANJ_FOTA_WITH_HTTPS BOOL OFF "Enable HTTPS support in
 define_overridable_option(ANJ_FOTA_WITH_COAP_TCP BOOL OFF "Enable TCP support in FW Update Object")
 define_overridable_option(ANJ_FOTA_WITH_COAPS_TCP BOOL OFF "Enable TLS support in FW Update Object")
 
+# CoAP downloader configuration
+define_overridable_option(ANJ_WITH_COAP_DOWNLOADER BOOL OFF "Enable CoAP Downloader support")
+define_overridable_option(ANJ_COAP_DOWNLOADER_MAX_PATHS_NUMBER STRING 3 "Max CoAP Paths number in CoAP Downloader")
+define_overridable_option(ANJ_COAP_DOWNLOADER_MAX_MSG_SIZE STRING 1200 "Max CoAP message size used in CoAP Downloader")
+
 # observe configuration
 define_overridable_option(ANJ_WITH_OBSERVE BOOL ON "Enable Observe-Notify mechanism")
 define_overridable_option(ANJ_WITH_OBSERVE_COMPOSITE BOOL OFF "Enable Observe-Composite support")
@@ -115,6 +120,8 @@ define_overridable_option(ANJ_COAP_MAX_OPTIONS_NUMBER STRING 15 "Max number of C
 define_overridable_option(ANJ_COAP_MAX_ATTR_OPTION_SIZE STRING 40 "Max Attribute-related CoAP option size")
 define_overridable_option(ANJ_COAP_MAX_LOCATION_PATHS_NUMBER STRING 2 "Max CoAP Location-Paths number in Registration Interface")
 define_overridable_option(ANJ_COAP_MAX_LOCATION_PATH_SIZE STRING 40 "Max size of a single CoAP Location-Path in Registration Interface")
+define_overridable_option(ANJ_WITH_CACHE BOOL ON "Enable responses caching")
+define_overridable_option(ANJ_CACHE_ENTRIES_NUMBER STRING 10 "Non-recent cache entries number")
 
 # logger configuration
 define_overridable_option(ANJ_LOG_FULL BOOL ON "Enable full logger: includes module, level, file, and line info")
@@ -133,6 +140,11 @@ define_overridable_option(ANJ_WITH_LWM2M12 BOOL ON "Enable LwM2M protocol versio
 define_overridable_option(ANJ_WITH_CUSTOM_CONVERSION_FUNCTIONS BOOL ON "Enable custom string<->number conversion function")
 define_overridable_option(ANJ_PLATFORM_BIG_ENDIAN BOOL OFF "Define platform endianess as big endian")
 
+# MbedTLS configuration
+define_overridable_option(ANJ_WITH_MBEDTLS BOOL OFF "Enable MbedTLS support")
+define_overridable_option(MBEDTLS_VERSION STRING "" "MbedTLS version to use when MBEDTLS_ROOT_DIR is not set, default is 3.6.0")
+define_overridable_option(MBEDTLS_ROOT_DIR STRING "" "Path to MbedTLS root directory (if not set, MbedTLS will be fetched from GitHub)")
+
 set(repo_root "${CMAKE_CURRENT_LIST_DIR}/..")
 set(config_root "${CMAKE_BINARY_DIR}/anj_config")
 set(config_base_path anj/anj_config.h)
@@ -156,14 +168,6 @@ if(NOT HAVE_MATH_LIBRARY)
     endif()
 endif()
 
-function(use_iwyu_if_enabled TARGET)
-  if (ANJ_IWYU_PATH)
-    set_target_properties(${TARGET} PROPERTIES
-            C_INCLUDE_WHAT_YOU_USE
-            "${ANJ_IWYU_PATH};-Xiwyu;--keep=*/anj/anj_config.h")
-  endif()
-endfunction()
-
 add_library(anj STATIC ${anj_sources})
 target_include_directories(
   anj PUBLIC "${repo_root}/include_public" "${config_root}")
@@ -206,3 +210,8 @@ if(gcc_or_clang)
     target_compile_options(anj PUBLIC -Wno-pedantic -Wno-c++-compat)
   endif()
 endif()
+
+if(ANJ_WITH_MBEDTLS)
+  include("${repo_root}/cmake/anjay_lite_mbedtls.cmake")
+  target_link_libraries(anj PUBLIC ${MBEDTLS_TARGETS})
+endif()

cmake/anjay_lite_mbedtls.cmake

@@ -0,0 +1,36 @@
+# Copyright 2023-2025 AVSystem <avsystem@avsystem.com>
+# AVSystem Anjay Lite LwM2M SDK
+# All rights reserved.
+#
+# Licensed under AVSystem Anjay Lite LwM2M Client SDK - Non-Commercial License.
+# See the attached LICENSE file for details.
+
+if(NOT MBEDTLS_VERSION STREQUAL "" AND NOT MBEDTLS_ROOT_DIR STREQUAL "")
+    message(FATAL_ERROR "MBEDTLS_VERSION and MBEDTLS_ROOT_DIR cannot be set at the same time!")
+endif()
+
+if(MBEDTLS_VERSION STREQUAL "")
+    set(MBEDTLS_VERSION "3.6.0")
+endif()
+
+if(NOT MBEDTLS_ROOT_DIR)
+    include(FetchContent)
+    message(STATUS "No MBEDTLS_ROOT_DIR provided. Fetching MbedTLS ${MBEDTLS_VERSION} ...")
+    FetchContent_Declare(
+        mbedtls
+        GIT_REPOSITORY https://github.com/Mbed-TLS/mbedtls.git
+        GIT_TAG        v${MBEDTLS_VERSION}
+    )
+    FetchContent_MakeAvailable(mbedtls)
+    set(MBEDTLS_TARGETS MbedTLS::mbedtls MbedTLS::mbedx509 MbedTLS::mbedcrypto)
+
+    # Add aliases so that targets have consistent names with find_package(MbedTLS)
+    add_library(MbedTLS::mbedtls ALIAS mbedtls)
+    add_library(MbedTLS::mbedcrypto ALIAS mbedcrypto)
+    add_library(MbedTLS::mbedx509 ALIAS mbedx509)
+else()
+    message(STATUS "Using MbedTLS from: ${MBEDTLS_ROOT_DIR}")
+    set(_MBEDTLS_SEARCH_ARGS PATHS "${MBEDTLS_ROOT_DIR}" NO_DEFAULT_PATH)
+    find_package(MbedTLS CONFIG REQUIRED ${_MBEDTLS_SEARCH_ARGS})
+    set(MBEDTLS_TARGETS MbedTLS::mbedtls MbedTLS::mbedx509 MbedTLS::mbedcrypto)
+endif()

doc/CMakeLists.txt

@@ -21,7 +21,7 @@ set(SNIPPET_SOURCE_MD5FILE ${SPHINX_DIR})
 file(MAKE_DIRECTORY ${repo_root}/doc/build)
 
 if(EXISTS "${SPHINX_SOURCE}/conf.py.in")
-    set(DOC_VERSION "1.0.0-beta.1")
+    set(DOC_VERSION "1.0.0-beta.2")
 
     configure_file(${SPHINX_SOURCE}/conf.py.in
                    ${SPHINX_DIR}/conf.py