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

Bugfix/deprecate decode tag number and value (#481)

Browse Source 
* added or updated secure the BACnet primitive value decoders - the core codecs - named bacnet_x_decode(), bacnet_x_application_decode() and bacnet_x_context_decode where x is one of the 13 BACnet primitive value names.  The updated API includes an APDU size to prevent over-reading of an APDU buffer while decoding.  Improved or added unit test code coverage for the BACnet primitive value decoders.

* marked the insecure decoding API as 'deprecated' which is defined in src/bacnet/basic/sys/platform.h and can be disabled during a build. 

* added secure decoders for BACnetTimeValue, BACnetHostNPort, BACnetTimeStamp, BACnetAddress, and Weekly_Schedule and improved unit test code coverage.

* improved test code coverage for BACnet objects and properties.

* secured AtomicReadFile and AtomicWriteFile service decoders and improved unit test code coverage.

* secured BACnet Error service decoder and improved unit test code coverage.

---------

Co-authored-by: Steve Karg <skarg@users.sourceforge.net>
This commit is contained in:
Steve Karg
2023-09-08 11:39:27 -05:00
committed by GitHub
parent bc8c261153
commit f641aacddb
67 changed files with 6103 additions and 3145 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/bacnet/timestamp/src/main.c
+75 -68
View File
@@ -28,22 +28,21 @@ static void testTimestampSequence(void)
BACNET_TIMESTAMP testTimestampIn;
BACNET_TIMESTAMP testTimestampOut;
uint8_t buffer[MAX_APDU];
int inLen;
int outLen;
int len;
int test_len;
testTimestampIn.tag = TIME_STAMP_SEQUENCE;
testTimestampIn.value.sequenceNum = 0x1234;
memset(&testTimestampOut, 0, sizeof(testTimestampOut));
inLen = bacapp_encode_context_timestamp(buffer, 2, &testTimestampIn);
outLen = bacapp_decode_context_timestamp(buffer, 2, &testTimestampOut);
len = bacapp_encode_context_timestamp(buffer, 2, &testTimestampIn);
test_len = bacapp_decode_context_timestamp(buffer, 2, &testTimestampOut);
zassert_equal(inLen, outLen, NULL);
zassert_equal(len, test_len, NULL);
zassert_equal(testTimestampIn.tag, testTimestampOut.tag, NULL);
zassert_equal(
testTimestampIn.value.sequenceNum,
testTimestampOut.value.sequenceNum, NULL);
zassert_equal(testTimestampIn.value.sequenceNum,
testTimestampOut.value.sequenceNum, NULL);
}
#if defined(CONFIG_ZTEST_NEW_API)
@@ -55,8 +54,8 @@ static void testTimestampTime(void)
BACNET_TIMESTAMP testTimestampIn;
BACNET_TIMESTAMP testTimestampOut;
uint8_t buffer[MAX_APDU];
int inLen;
int outLen;
int len;
int test_len;
testTimestampIn.tag = TIME_STAMP_TIME;
testTimestampIn.value.time.hour = 1;
@@ -66,20 +65,19 @@ static void testTimestampTime(void)
memset(&testTimestampOut, 0, sizeof(testTimestampOut));
inLen = bacapp_encode_context_timestamp(buffer, 2, &testTimestampIn);
outLen = bacapp_decode_context_timestamp(buffer, 2, &testTimestampOut);
len = bacapp_encode_context_timestamp(buffer, 2, &testTimestampIn);
test_len = bacapp_decode_context_timestamp(buffer, 2, &testTimestampOut);
zassert_equal(inLen, outLen, NULL);
zassert_equal(len, test_len, NULL);
zassert_equal(testTimestampIn.tag, testTimestampOut.tag, NULL);
zassert_equal(
testTimestampIn.value.time.hour, testTimestampOut.value.time.hour, NULL);
zassert_equal(testTimestampIn.value.time.hour,
testTimestampOut.value.time.hour, NULL);
zassert_equal(
testTimestampIn.value.time.min, testTimestampOut.value.time.min, NULL);
zassert_equal(
testTimestampIn.value.time.sec, testTimestampOut.value.time.sec, NULL);
zassert_equal(
testTimestampIn.value.time.hundredths,
testTimestampOut.value.time.hundredths, NULL);
zassert_equal(testTimestampIn.value.time.hundredths,
testTimestampOut.value.time.hundredths, NULL);
}
#if defined(CONFIG_ZTEST_NEW_API)
@@ -89,70 +87,79 @@ static void testTimestampTimeDate(void)
#endif
{
BACNET_TIMESTAMP testTimestampIn;
BACNET_TIMESTAMP testTimestampOut;
BACNET_TIMESTAMP testTimestampOut = { 0 };
uint8_t tag_number = 2;
uint8_t buffer[MAX_APDU];
int inLen;
int outLen;
int len;
int test_len;
int null_len;
bool status;
testTimestampIn.tag = TIME_STAMP_DATETIME;
testTimestampIn.value.dateTime.time.hour = 1;
testTimestampIn.value.dateTime.time.min = 2;
testTimestampIn.value.dateTime.time.sec = 3;
testTimestampIn.value.dateTime.time.hundredths = 4;
testTimestampIn.value.dateTime.date.year = 1901;
testTimestampIn.value.dateTime.date.month = 1;
testTimestampIn.value.dateTime.date.wday = 2;
testTimestampIn.value.dateTime.date.day = 3;
memset(&testTimestampOut, 0, sizeof(testTimestampOut));
inLen = bacapp_encode_context_timestamp(buffer, 2, &testTimestampIn);
outLen = bacapp_decode_context_timestamp(buffer, 2, &testTimestampOut);
zassert_equal(inLen, outLen, NULL);
status =
bacapp_timestamp_init_ascii(&testTimestampIn, "1901/01/03-1:02:03");
zassert_true(status, NULL);
null_len = bacapp_encode_timestamp(NULL, &testTimestampIn);
len = bacapp_encode_timestamp(buffer, &testTimestampIn);
zassert_equal(null_len, len, NULL);
null_len = bacnet_timestamp_decode(buffer, len, NULL);
test_len = bacnet_timestamp_decode(buffer, len, &testTimestampOut);
zassert_equal(null_len, test_len, NULL);
zassert_equal(len, test_len, "len=%d test_len=%d", len, test_len);
/* test ERROR when APDU is too short*/
while (len) {
len--;
test_len = bacnet_timestamp_decode(buffer, len, &testTimestampOut);
zassert_equal(test_len, BACNET_STATUS_ERROR, NULL);
}
null_len = bacapp_encode_context_timestamp(NULL, tag_number, &testTimestampIn);
len = bacapp_encode_context_timestamp(buffer, tag_number, &testTimestampIn);
zassert_equal(null_len, len, NULL);
zassert_true(len > 0, NULL);
null_len = bacnet_timestamp_context_decode(
buffer, len, tag_number, NULL);
test_len = bacnet_timestamp_context_decode(
buffer, len, tag_number, &testTimestampOut);
zassert_equal(null_len, test_len, NULL);
zassert_equal(len, test_len, NULL);
/* test ERROR when APDU is too short*/
while (len) {
len--;
test_len = bacnet_timestamp_context_decode(
buffer, len, tag_number, &testTimestampOut);
zassert_equal(test_len, BACNET_STATUS_ERROR, NULL);
}
/* test for valid values */
zassert_equal(testTimestampIn.tag, testTimestampOut.tag, NULL);
zassert_equal(
testTimestampIn.value.dateTime.time.hour,
testTimestampOut.value.dateTime.time.hour, NULL);
zassert_equal(
testTimestampIn.value.dateTime.time.min,
testTimestampOut.value.dateTime.time.min, NULL);
zassert_equal(
testTimestampIn.value.dateTime.time.sec,
testTimestampOut.value.dateTime.time.sec, NULL);
zassert_equal(
testTimestampIn.value.dateTime.time.hundredths,
testTimestampOut.value.dateTime.time.hundredths, NULL);
zassert_equal(testTimestampIn.value.dateTime.time.hour,
testTimestampOut.value.dateTime.time.hour, NULL);
zassert_equal(testTimestampIn.value.dateTime.time.min,
testTimestampOut.value.dateTime.time.min, NULL);
zassert_equal(testTimestampIn.value.dateTime.time.sec,
testTimestampOut.value.dateTime.time.sec, NULL);
zassert_equal(testTimestampIn.value.dateTime.time.hundredths,
testTimestampOut.value.dateTime.time.hundredths, NULL);
zassert_equal(
testTimestampIn.value.dateTime.date.year,
testTimestampOut.value.dateTime.date.year, NULL);
zassert_equal(
testTimestampIn.value.dateTime.date.month,
testTimestampOut.value.dateTime.date.month, NULL);
zassert_equal(
testTimestampIn.value.dateTime.date.wday,
testTimestampOut.value.dateTime.date.wday, NULL);
zassert_equal(
testTimestampIn.value.dateTime.date.day,
testTimestampOut.value.dateTime.date.day, NULL);
zassert_equal(testTimestampIn.value.dateTime.date.year,
testTimestampOut.value.dateTime.date.year, NULL);
zassert_equal(testTimestampIn.value.dateTime.date.month,
testTimestampOut.value.dateTime.date.month, NULL);
zassert_equal(testTimestampIn.value.dateTime.date.wday,
testTimestampOut.value.dateTime.date.wday, NULL);
zassert_equal(testTimestampIn.value.dateTime.date.day,
testTimestampOut.value.dateTime.date.day, NULL);
}
/**
* @}
*/
#if defined(CONFIG_ZTEST_NEW_API)
ZTEST_SUITE(timestamp_tests, NULL, NULL, NULL, NULL, NULL);
#else
void test_main(void)
{
ztest_test_suite(timestamp_tests,
ztest_unit_test(testTimestampSequence),
ztest_unit_test(testTimestampTime),
ztest_unit_test(testTimestampTimeDate)
);
ztest_test_suite(timestamp_tests, ztest_unit_test(testTimestampSequence),
ztest_unit_test(testTimestampTime),
ztest_unit_test(testTimestampTimeDate));
ztest_run_test_suite(timestamp_tests);
}