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

* 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
+52 -45
View File
@@ -31,80 +31,87 @@ static void testAlarmAck(void)
uint8_t buffer[MAX_APDU];
int inLen;
int outLen;
bool status;
testAlarmAckIn.ackProcessIdentifier = 0x1234;
characterstring_init_ansi(&testAlarmAckIn.ackSource, "This is a test");
testAlarmAckIn.ackTimeStamp.tag = TIME_STAMP_SEQUENCE;
testAlarmAckIn.ackTimeStamp.value.sequenceNum = 0x4331;
status = bacapp_timestamp_init_ascii(&testAlarmAckIn.ackTimeStamp, "1234");
zassert_true(status, NULL);
zassert_equal(testAlarmAckIn.ackTimeStamp.tag, TIME_STAMP_SEQUENCE, NULL);
zassert_equal(testAlarmAckIn.ackTimeStamp.value.sequenceNum, 1234, NULL);
testAlarmAckIn.eventObjectIdentifier.instance = 567;
testAlarmAckIn.eventObjectIdentifier.type = OBJECT_DEVICE;
testAlarmAckIn.eventTimeStamp.tag = TIME_STAMP_TIME;
testAlarmAckIn.eventTimeStamp.value.time.hour = 10;
testAlarmAckIn.eventTimeStamp.value.time.min = 11;
testAlarmAckIn.eventTimeStamp.value.time.sec = 12;
testAlarmAckIn.eventTimeStamp.value.time.hundredths = 14;
status = bacapp_timestamp_init_ascii(
&testAlarmAckIn.eventTimeStamp, "10:11:12.14");
zassert_true(status, NULL);
zassert_equal(testAlarmAckIn.eventTimeStamp.tag, TIME_STAMP_TIME, NULL);
testAlarmAckIn.eventStateAcked = EVENT_STATE_OFFNORMAL;
memset(&testAlarmAckOut, 0, sizeof(testAlarmAckOut));
inLen = alarm_ack_encode_service_request(buffer, &testAlarmAckIn);
outLen = alarm_ack_decode_service_request(buffer, inLen, &testAlarmAckOut);
zassert_equal(inLen, outLen, NULL);
zassert_equal(inLen, outLen, "inlen=%d outlen=%d", inLen, outLen);
zassert_equal(
testAlarmAckIn.ackProcessIdentifier,
testAlarmAckOut.ackProcessIdentifier, NULL);
zassert_equal(testAlarmAckIn.ackProcessIdentifier,
testAlarmAckOut.ackProcessIdentifier, NULL);
zassert_equal(
testAlarmAckIn.ackTimeStamp.tag, testAlarmAckOut.ackTimeStamp.tag, NULL);
zassert_equal(
testAlarmAckIn.ackTimeStamp.value.sequenceNum,
testAlarmAckOut.ackTimeStamp.value.sequenceNum, NULL);
zassert_equal(testAlarmAckIn.ackTimeStamp.tag,
testAlarmAckOut.ackTimeStamp.tag, "in-tag=%d out-tag=%d",
testAlarmAckIn.ackTimeStamp.tag, testAlarmAckOut.ackTimeStamp.tag);
zassert_equal(testAlarmAckIn.ackTimeStamp.value.sequenceNum,
testAlarmAckOut.ackTimeStamp.value.sequenceNum, NULL);
zassert_equal(
testAlarmAckIn.ackProcessIdentifier,
testAlarmAckOut.ackProcessIdentifier, NULL);
zassert_equal(testAlarmAckIn.ackProcessIdentifier,
testAlarmAckOut.ackProcessIdentifier, NULL);
zassert_equal(
testAlarmAckIn.eventObjectIdentifier.instance,
testAlarmAckOut.eventObjectIdentifier.instance, NULL);
zassert_equal(
testAlarmAckIn.eventObjectIdentifier.type,
testAlarmAckOut.eventObjectIdentifier.type, NULL);
zassert_equal(testAlarmAckIn.eventObjectIdentifier.instance,
testAlarmAckOut.eventObjectIdentifier.instance, NULL);
zassert_equal(testAlarmAckIn.eventObjectIdentifier.type,
testAlarmAckOut.eventObjectIdentifier.type, NULL);
zassert_equal(
testAlarmAckIn.eventTimeStamp.tag,
testAlarmAckOut.eventTimeStamp.tag, NULL);
zassert_equal(
testAlarmAckIn.eventTimeStamp.value.time.hour,
testAlarmAckOut.eventTimeStamp.value.time.hour, NULL);
zassert_equal(
testAlarmAckIn.eventTimeStamp.value.time.min,
testAlarmAckOut.eventTimeStamp.value.time.min, NULL);
zassert_equal(
testAlarmAckIn.eventTimeStamp.value.time.sec,
testAlarmAckOut.eventTimeStamp.value.time.sec, NULL);
zassert_equal(
testAlarmAckIn.eventTimeStamp.value.time.hundredths,
testAlarmAckOut.eventTimeStamp.value.time.hundredths, NULL);
zassert_equal(testAlarmAckIn.eventTimeStamp.tag,
testAlarmAckOut.eventTimeStamp.tag, NULL);
zassert_equal(testAlarmAckIn.eventTimeStamp.value.time.hour,
testAlarmAckOut.eventTimeStamp.value.time.hour, NULL);
zassert_equal(testAlarmAckIn.eventTimeStamp.value.time.min,
testAlarmAckOut.eventTimeStamp.value.time.min, NULL);
zassert_equal(testAlarmAckIn.eventTimeStamp.value.time.sec,
testAlarmAckOut.eventTimeStamp.value.time.sec, NULL);
zassert_equal(testAlarmAckIn.eventTimeStamp.value.time.hundredths,
testAlarmAckOut.eventTimeStamp.value.time.hundredths, NULL);
zassert_equal(
testAlarmAckIn.eventStateAcked, testAlarmAckOut.eventStateAcked, NULL);
status = bacapp_timestamp_init_ascii(
&testAlarmAckIn.eventTimeStamp, "2021/12/31");
zassert_true(status, NULL);
zassert_equal(testAlarmAckIn.eventTimeStamp.tag, TIME_STAMP_DATETIME, NULL);
inLen = alarm_ack_encode_service_request(buffer, &testAlarmAckIn);
outLen = alarm_ack_decode_service_request(buffer, inLen, &testAlarmAckOut);
zassert_equal(inLen, outLen, "inlen=%d outlen=%d", inLen, outLen);
status =
bacapp_timestamp_init_ascii(&testAlarmAckIn.eventTimeStamp, "1234");
zassert_true(status, NULL);
zassert_equal(testAlarmAckIn.eventTimeStamp.tag, TIME_STAMP_SEQUENCE, NULL);
inLen = alarm_ack_encode_service_request(buffer, &testAlarmAckIn);
outLen = alarm_ack_decode_service_request(buffer, inLen, &testAlarmAckOut);
zassert_equal(inLen, outLen, "inlen=%d outlen=%d", inLen, outLen);
}
/**
* @}
*/
#if defined(CONFIG_ZTEST_NEW_API)
ZTEST_SUITE(alarm_ack_tests, NULL, NULL, NULL, NULL, NULL);
#else
void test_main(void)
{
ztest_test_suite(alarm_ack_tests,
ztest_unit_test(testAlarmAck)
);
ztest_test_suite(alarm_ack_tests, ztest_unit_test(testAlarmAck));
ztest_run_test_suite(alarm_ack_tests);
}