Secure ReadProperty decoding and BACnetActionCommand (#702)

* Refactored and secured BACnetActionCommand codec into bacaction.c module for command object and added to bacapp module encode/decode with define for enabling and pseudo application tag for internal use. * Simplified bacapp_data_len() and moved into bacdcode module as bacnet_enclosed_data_len() function. * Secured ReadProperty-REQUEST and -ACK decoding. * Removed deprecated Keylist_Key() functions from usage. * Removed pseudo application datatypes from bacapp_data_decode() which only uses primitive application tag encoded values. * Defined INT_MAX when it is not already defined by compiler or libc. * Deprecated bacapp_decode_application_data_len() and bacapp_decode_context_data_len() as they are no longer used in any code in the library. * Added BACnetScale to bacapp module. Improved complex property value decoding. Refactored bacapp_decode_known_property() function. * Refactored and improved the bacapp_snprintf() function for printing EPICS. * Fixed Lighting Output WriteProperty to handle known property decoding.
2024-07-25 17:12:08 -05:00
parent 923eaf2313
commit 4326128e72
191 changed files with 3856 additions and 2099 deletions
@@ -0,0 +1,108 @@
+/**
+ * @file
+ * @brief API for BACnetActionCommand codec used by Command objects
+ * @author Steve Karg <skarg@users.sourceforge.net>
+ * @date 2024
+ * @copyright SPDX-License-Identifier: MIT
+ */
+#ifndef BACNET_ACTION_H
+#define BACNET_ACTION_H
+#include <stdbool.h>
+#include <stdint.h>
+/* BACnet Stack defines - first */
+#include "bacnet/bacdef.h"
+#include "bacnet/bactimevalue.h"
+
+/* BACNET_ACTION_VALUE encodes and decodes the Property Value
+   in the Action Command. Choose the datatypes that your
+   application supports, or add additional. */
+#if !(                                                              \
+    defined(BACACTION_ALL) || defined(BACACTION_NULL) ||            \
+    defined(BACACTION_BOOLEAN) || defined(BACACTION_UNSIGNED) ||    \
+    defined(BACACTION_SIGNED) || defined(BACACTION_REAL) ||         \
+    defined(BACACTION_DOUBLE) || defined(BACACTION_OCTET_STRING) || \
+    defined(BACACTION_ENUMERATED))
+#define BACACTION_ALL
+#endif
+
+#if defined(BACACTION_ALL)
+#define BACACTION_NULL
+#define BACACTION_BOOLEAN
+#define BACACTION_UNSIGNED
+#define BACACTION_SIGNED
+#define BACACTION_REAL
+#define BACACTION_DOUBLE
+#define BACACTION_ENUMERATED
+#endif
+
+typedef struct BACnetActionPropertyValue {
+    uint8_t tag;
+    union {
+#if defined(BACACTION_NULL)
+        /* NULL - not needed because it is encoded in the tag alone */
+#endif
+#if defined(BACACTION_BOOLEAN)
+        bool Boolean;
+#endif
+#if defined(BACACTION_UNSIGNED)
+        BACNET_UNSIGNED_INTEGER Unsigned_Int;
+#endif
+#if defined(BACACTION_SIGNED)
+        int32_t Signed_Int;
+#endif
+#if defined(BACACTION_REAL)
+        float Real;
+#endif
+#if defined(BACACTION_DOUBLE)
+        double Double;
+#endif
+#if defined(BACACTION_ENUMERATED)
+        uint32_t Enumerated;
+#endif
+    } type;
+    /* simple linked list if needed */
+    struct BACnetActionPropertyValue *next;
+} BACNET_ACTION_PROPERTY_VALUE;
+
+typedef struct bacnet_action_list {
+    BACNET_OBJECT_ID Device_Id; /* Optional */
+    BACNET_OBJECT_ID Object_Id;
+    BACNET_PROPERTY_ID Property_Identifier;
+    uint32_t Property_Array_Index; /* Conditional */
+    BACNET_ACTION_PROPERTY_VALUE Value;
+    uint8_t Priority; /* Conditional */
+    uint32_t Post_Delay; /* Optional */
+    bool Quit_On_Failure;
+    bool Write_Successful;
+    struct bacnet_action_list *next;
+} BACNET_ACTION_LIST;
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+BACNET_STACK_EXPORT
+int bacnet_action_property_value_encode(
+    uint8_t *apdu, BACNET_ACTION_PROPERTY_VALUE *value);
+BACNET_STACK_EXPORT
+int bacnet_action_property_value_decode(
+    uint8_t *apdu, uint32_t apdu_size, BACNET_ACTION_PROPERTY_VALUE *value);
+BACNET_STACK_EXPORT
+bool bacnet_action_property_value_same(
+    BACNET_ACTION_PROPERTY_VALUE *value1, BACNET_ACTION_PROPERTY_VALUE *value2);
+
+BACNET_STACK_EXPORT
+int bacnet_action_command_encode(uint8_t *apdu, BACNET_ACTION_LIST *entry);
+
+BACNET_STACK_EXPORT
+int bacnet_action_command_decode(
+    uint8_t *apdu, size_t apdu_size, BACNET_ACTION_LIST *entry);
+
+BACNET_STACK_EXPORT
+bool bacnet_action_command_same(
+    BACNET_ACTION_LIST *entry1, BACNET_ACTION_LIST *entry2);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+#endif