dali/bacnet_stack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Bugfix/secure read range codec (#957)

Browse Source 
* Secured ReadRange service codecs. Added ReadRange unit testing. Secured ReadRange-ACK handler to enable APDU size checking.
This commit is contained in:
Steve Karg
2025-04-03 09:14:08 -05:00
committed by GitHub
parent 921264b2c2
commit 31af2507fb
13 changed files with 828 additions and 440 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/CMakeLists.txt
+1
View File
@@ -107,6 +107,7 @@ list(APPEND testdirs
bacnet/property
bacnet/ptransfer
bacnet/rd
bacnet/readrange
bacnet/reject
bacnet/rp
bacnet/rpm
test/Makefile
+2
View File
@@ -140,6 +140,8 @@ libwebsockets:
bash -c 'cd libwebsockets;mkdir build;cd build;cmake .. -DLWS_WITH_LIBUV=ON -DLWS_WITH_MINIMAL_EXAMPLES=0 -DLWS_MAX_SMP=32;make'
sudo bash -c 'cd libwebsockets;cd build;make install'
test-bsc: bsc-datalink bsc-node bsc-hub bsc-bvlc bsc-socket websockets
.PHONY: clean
clean:
-rm -rf $(BUILD_DIR)
test/bacnet/readrange/CMakeLists.txt
+47
View File
@@ -0,0 +1,47 @@
# SPDX-License-Identifier: MIT
cmake_minimum_required(VERSION 3.10 FATAL_ERROR)
get_filename_component(basename ${CMAKE_CURRENT_SOURCE_DIR} NAME)
project(test_${basename}
VERSION 1.0.0
LANGUAGES C)
string(REGEX REPLACE
"/test/bacnet/[a-zA-Z_/-]*$"
"/src"
SRC_DIR
${CMAKE_CURRENT_SOURCE_DIR})
string(REGEX REPLACE
"/test/bacnet/[a-zA-Z_/-]*$"
"/test"
TST_DIR
${CMAKE_CURRENT_SOURCE_DIR})
set(ZTST_DIR "${TST_DIR}/ztest/src")
add_compile_definitions(
BIG_ENDIAN=0
CONFIG_ZTEST=1
)
include_directories(
${SRC_DIR}
${TST_DIR}/ztest/include
)
add_executable(${PROJECT_NAME}
# File(s) under test
${SRC_DIR}/bacnet/readrange.c
# Support files and stubs (pathname alphabetical)
${SRC_DIR}/bacnet/bacdcode.c
${SRC_DIR}/bacnet/bacint.c
${SRC_DIR}/bacnet/bacreal.c
${SRC_DIR}/bacnet/bacstr.c
${SRC_DIR}/bacnet/proplist.c
${SRC_DIR}/bacnet/basic/sys/bigend.c
# Test and test library files
./src/main.c
${ZTST_DIR}/ztest_mock.c
${ZTST_DIR}/ztest.c
)
test/bacnet/readrange/src/main.c
+211
View File
@@ -0,0 +1,211 @@
/**
* @file
* @brief Unit test for ReadRange services encode and decode
* @author Steve Karg <skarg@users.sourceforge.net>
* @date April 2025
* @copyright SPDX-License-Identifier: MIT
*/
#include <zephyr/ztest.h>
#include <bacnet/bacdcode.h>
#include <bacnet/readrange.h>
/**
* @addtogroup bacnet_tests
* @{
*/
static const char *read_range_request_type(int type)
{
switch (type) {
case RR_BY_POSITION:
return "RR_BY_POSITION";
case RR_BY_SEQUENCE:
return "RR_BY_SEQUENCE";
case RR_BY_TIME:
return "RR_BY_TIME";
case RR_READ_ALL:
return "RR_READ_ALL";
default:
return "UNKNOWN";
}
}
/**
* @brief Test
*/
static void testReadRangeAckUnit(BACNET_READ_RANGE_DATA *data)
{
uint8_t apdu[480] = { 0 };
uint8_t apdu2[480] = { 0 };
int apdu_len = 0, test_len = 0, null_len = 0;
BACNET_READ_RANGE_DATA test_data = { 0 };
BACNET_OBJECT_TYPE object_type = OBJECT_DEVICE;
uint32_t object_instance = 0;
BACNET_OBJECT_TYPE object = 0;
data->application_data_len = encode_bacnet_object_id(
&apdu2[0], data->object_type, data->object_instance);
data->application_data = &apdu2[0];
null_len = readrange_ack_service_encode(&apdu[0], sizeof(apdu), NULL);
zassert_equal(null_len, 0, NULL);
null_len = readrange_ack_service_encode(&apdu[0], 0, NULL);
zassert_equal(null_len, 0, NULL);
null_len = readrange_ack_service_encode(NULL, sizeof(apdu), data);
zassert_not_equal(null_len, 0, NULL);
apdu_len = readrange_ack_service_encode(&apdu[0], sizeof(apdu), data);
zassert_equal(
apdu_len, null_len, "apdu_len=%d null_len=%d", apdu_len, null_len);
zassert_not_equal(apdu_len, 0, NULL);
zassert_not_equal(apdu_len, BACNET_STATUS_ERROR, NULL);
null_len = rr_ack_decode_service_request(NULL, apdu_len, &test_data);
zassert_true(null_len < 0, NULL);
test_len = rr_ack_decode_service_request(&apdu[0], apdu_len, &test_data);
zassert_equal(apdu_len, test_len, NULL);
zassert_not_equal(test_len, -1, NULL);
zassert_equal(test_data.object_type, data->object_type, NULL);
zassert_equal(test_data.object_instance, data->object_instance, NULL);
zassert_equal(test_data.object_property, data->object_property, NULL);
zassert_equal(test_data.array_index, data->array_index, NULL);
zassert_equal(
test_data.application_data_len, data->application_data_len,
"test app len=%d app len=%d", test_data.application_data_len,
data->application_data_len);
/* since object property == object_id, decode the application data using
the appropriate decode function */
test_len =
decode_object_id(test_data.application_data, &object, &object_instance);
object_type = object;
zassert_equal(object_type, data->object_type, NULL);
zassert_equal(object_instance, data->object_instance, NULL);
while (apdu_len) {
apdu_len--;
if (apdu_len == 17) {
/* boundary of optional parameters, so becomes valid */
continue;
}
test_len =
rr_ack_decode_service_request(&apdu[0], apdu_len, &test_data);
zassert_true(
test_len < 0, "test_len=%d apdu_len=%d", test_len, apdu_len);
}
}
#if defined(CONFIG_ZTEST_NEW_API)
ZTEST(rp_tests, testReadRangeAck)
#else
static void testReadRangeAck(void)
#endif
{
BACNET_READ_RANGE_DATA data = { 0 };
data.object_type = OBJECT_DEVICE;
data.object_instance = 1;
data.object_property = PROP_OBJECT_IDENTIFIER;
data.array_index = 0;
data.RequestType = RR_READ_ALL;
testReadRangeAckUnit(&data);
data.array_index = BACNET_ARRAY_ALL;
for (int i = 0; i < 3; i++) {
data.ItemCount = i;
data.RequestType = RR_READ_ALL;
testReadRangeAckUnit(&data);
/* firstSequenceNumber - used only if 'Item Count' > 0 and
the request was either of type 'By Sequence Number' or 'By Time' */
for (int j = 0; j < 3; j++) {
data.FirstSequence = j;
data.RequestType = RR_BY_TIME;
testReadRangeAckUnit(&data);
data.RequestType = RR_BY_SEQUENCE;
testReadRangeAckUnit(&data);
}
data.FirstSequence = 0;
data.RequestType = RR_BY_POSITION;
testReadRangeAckUnit(&data);
}
}
static void testReadRangeUnit(BACNET_READ_RANGE_DATA *data)
{
uint8_t apdu[480] = { 0 };
int apdu_len = 0, test_len = 0, null_len = 0;
BACNET_READ_RANGE_DATA test_data;
null_len = read_range_request_encode(&apdu[0], 0, data);
zassert_equal(null_len, 0, NULL);
null_len = read_range_request_encode(&apdu[0], sizeof(apdu), NULL);
zassert_equal(null_len, 0, NULL);
null_len = read_range_request_encode(NULL, sizeof(apdu), data);
zassert_not_equal(null_len, 0, NULL);
apdu_len = read_range_request_encode(&apdu[0], sizeof(apdu), data);
zassert_equal(
apdu_len, null_len, "apdu_len=%d null_len=%d", apdu_len, null_len);
zassert_not_equal(apdu_len, 0, NULL);
null_len = rr_decode_service_request(NULL, apdu_len, &test_data);
zassert_true(null_len < 0, NULL);
test_len = rr_decode_service_request(&apdu[0], apdu_len, &test_data);
zassert_equal(
apdu_len, test_len, "apdu_len=%d test_len=%d", apdu_len, test_len);
zassert_not_equal(test_len, -1, NULL);
zassert_equal(test_data.object_type, data->object_type, NULL);
zassert_equal(test_data.object_instance, data->object_instance, NULL);
zassert_equal(test_data.object_property, data->object_property, NULL);
zassert_equal(test_data.array_index, data->array_index, NULL);
while (apdu_len) {
apdu_len--;
test_len = rr_decode_service_request(&apdu[0], apdu_len, &test_data);
if (apdu_len == 7) {
/* boundary of optional parameters, so becomes valid */
continue;
}
zassert_true(
test_len < 0, "test_len=%d apdu_len=%d request=%s array=%u",
test_len, apdu_len, read_range_request_type(data->RequestType),
data->array_index);
}
}
#if defined(CONFIG_ZTEST_NEW_API)
ZTEST(rp_tests, testReadRange)
#else
static void testReadRange(void)
#endif
{
BACNET_READ_RANGE_DATA data = { 0 };
data.object_type = OBJECT_DEVICE;
data.object_instance = 1;
data.object_property = PROP_OBJECT_IDENTIFIER;
data.array_index = 0;
data.RequestType = RR_READ_ALL;
testReadRangeUnit(&data);
data.array_index = BACNET_ARRAY_ALL;
data.RequestType = RR_READ_ALL;
testReadRangeUnit(&data);
data.RequestType = RR_BY_POSITION;
testReadRangeUnit(&data);
data.RequestType = RR_BY_SEQUENCE;
testReadRangeUnit(&data);
data.RequestType = RR_BY_TIME;
testReadRangeUnit(&data);
return;
}
/**
* @}
*/
#if defined(CONFIG_ZTEST_NEW_API)
ZTEST_SUITE(rp_tests, NULL, NULL, NULL, NULL, NULL);
#else
void test_main(void)
{
ztest_test_suite(
readrange_tests, ztest_unit_test(testReadRange),
ztest_unit_test(testReadRangeAck));
ztest_run_test_suite(readrange_tests);
}
#endif