Added a basic example Auditlog object. (#458)

Co-authored-by: Steve Karg <skarg@users.sourceforge.net>
This commit is contained in:
Mikhail Antropov
2025-06-23 20:18:13 +03:00
committed by GitHub
parent 464be15bae
commit 267db756b8
12 changed files with 3618 additions and 2 deletions
File diff suppressed because it is too large Load Diff
+258
View File
@@ -0,0 +1,258 @@
/**
* @file
* @brief API for BACnetAuditNotification and BACnetAuditLogRecord codec used
* by Audit Log objects
* @author Mikhail Antropov <michail.antropov@dsr-corporation.com>
* @author Steve Karg <skarg@users.sourceforge.net>
* @date November 2024
* @copyright SPDX-License-Identifier: MIT
*/
#ifndef BACNET_AUDIT_H
#define BACNET_AUDIT_H
#include <stdbool.h>
#include <stdint.h>
/* BACnet Stack defines - first */
#include "bacnet/bacdef.h"
/* BACnet Stack API */
#include "bacnet/bacdest.h"
#include "bacnet/cov.h"
#include "bacnet/datetime.h"
#include "bacnet/bacdevobjpropref.h"
/**
* @brief Container to hold the target value or current value
* @note This must be a separate struct from BACapp to avoid
* recursive a recursive include.
* @note This is a union to save space. The application tag
* is used to determine which type is used.
*
*
*/
typedef struct BACnet_Audit_Value {
uint8_t tag; /* application tag data type */
union {
/* NULL - not needed as it is encoded in the tag alone */
bool boolean_value;
float real_value;
uint32_t enumerated_value;
uint32_t unsigned_value;
int32_t integer_value;
/* note: use ifdef for values larger than 32-bits are supported */
} type;
} BACNET_AUDIT_VALUE;
/**
* @brief Storage structures for Audit Log record
*
* @note I've tried to minimize the storage requirements here
* as the memory requirements for logging in embedded
* implementations are frequently a big issue. For PC or
* embedded Linux type setupz this may seem like overkill
* but if you have limited memory and need to squeeze as much
* logging capacity as possible every little byte counts!
*/
#if !( \
defined(BACNET_AUDIT_NOTIFICATION_MINIMAL_ENABLE) || \
defined(BACNET_AUDIT_NOTIFICATION_OPTIONAL_ENABLE) || \
defined(BACNET_AUDIT_NOTIFICATION_SOURCE_TIMESTAMP_ENABLE) || \
defined(BACNET_AUDIT_NOTIFICATION_TARGET_TIMESTAMP_ENABLE) || \
defined(BACNET_AUDIT_NOTIFICATION_SOURCE_OBJECT_ENABLE) || \
defined(BACNET_AUDIT_NOTIFICATION_SOURCE_COMMENT_ENABLE) || \
defined(BACNET_AUDIT_NOTIFICATION_TARGET_COMMENT_ENABLE) || \
defined(BACNET_AUDIT_NOTIFICATION_INVOKE_ID_ENABLE) || \
defined(BACNET_AUDIT_NOTIFICATION_SOURCE_USER_ID_ENABLE) || \
defined(BACNET_AUDIT_NOTIFICATION_SOURCE_USER_ROLE_ENABLE) || \
defined(BACNET_AUDIT_NOTIFICATION_TARGET_OBJECT_ENABLE) || \
defined(BACNET_AUDIT_NOTIFICATION_TARGET_PROPERTY_ENABLE) || \
defined(BACNET_AUDIT_NOTIFICATION_TARGET_PRIORITY_ENABLE) || \
defined(BACNET_AUDIT_NOTIFICATION_TARGET_VALUE_ENABLE) || \
defined(BACNET_AUDIT_NOTIFICATION_CURRENT_VALUE_ENABLE) || \
defined(BACNET_AUDIT_NOTIFICATION_RESULT_ENABLE))
#define BACNET_AUDIT_NOTIFICATION_OPTIONAL_ENABLE
#endif
#ifdef BACNET_AUDIT_NOTIFICATION_OPTIONAL_ENABLE
#define BACNET_AUDIT_NOTIFICATION_SOURCE_TIMESTAMP_ENABLE
#define BACNET_AUDIT_NOTIFICATION_TARGET_TIMESTAMP_ENABLE
#define BACNET_AUDIT_NOTIFICATION_SOURCE_OBJECT_ENABLE
#define BACNET_AUDIT_NOTIFICATION_SOURCE_COMMENT_ENABLE
#define BACNET_AUDIT_NOTIFICATION_TARGET_COMMENT_ENABLE
#define BACNET_AUDIT_NOTIFICATION_INVOKE_ID_ENABLE
#define BACNET_AUDIT_NOTIFICATION_SOURCE_USER_ID_ENABLE
#define BACNET_AUDIT_NOTIFICATION_SOURCE_USER_ROLE_ENABLE
#define BACNET_AUDIT_NOTIFICATION_TARGET_OBJECT_ENABLE
#define BACNET_AUDIT_NOTIFICATION_TARGET_PROPERTY_ENABLE
#define BACNET_AUDIT_NOTIFICATION_TARGET_PRIORITY_ENABLE
#define BACNET_AUDIT_NOTIFICATION_TARGET_VALUE_ENABLE
#define BACNET_AUDIT_NOTIFICATION_CURRENT_VALUE_ENABLE
#define BACNET_AUDIT_NOTIFICATION_RESULT_ENABLE
#endif
/*
* BACnetAuditNotification ::= SEQUENCE {
* source-timestamp [0] BACnetTimeStamp OPTIONAL,
* target-timestamp [1] BACnetTimeStamp OPTIONAL,
* source-device [2] BACnetRecipient,
* source-object [3] BACnetObjectIdentifier OPTIONAL,
* operation [4] BACnetAuditOperation,
* source-comment [5] CharacterString OPTIONAL,
* target-comment [6] CharacterString OPTIONAL,
* invoke-id [7] Unsigned8 OPTIONAL,
* source-user-id [8] Unsigned16 OPTIONAL,
* source-user-role [9] Unsigned8 OPTIONAL,
* target-device [10] BACnetRecipient,
* target-object [11] BACnetObjectIdentifier OPTIONAL,
* target-property [12] BACnetPropertyReference OPTIONAL,
* target-priority [13] Unsigned (1..16) OPTIONAL,
* target-value [14] ABSTRACT-SYNTAX.&Type OPTIONAL,
* current-value [15] ABSTRACT-SYNTAX.&Type OPTIONAL,
* result [16] Error OPTIONAL
* }
*/
typedef struct BACnetAuditNotification {
#ifdef BACNET_AUDIT_NOTIFICATION_SOURCE_TIMESTAMP_ENABLE
/* source-timestamp [0] BACnetTimeStamp OPTIONAL */
BACNET_TIMESTAMP source_timestamp;
#endif
#ifdef BACNET_AUDIT_NOTIFICATION_TARGET_TIMESTAMP_ENABLE
/* target-timestamp [1] BACnetTimeStamp OPTIONAL */
BACNET_TIMESTAMP target_timestamp;
#endif
/* source-device [2] BACnetRecipient */
BACNET_RECIPIENT source_device;
#ifdef BACNET_AUDIT_NOTIFICATION_SOURCE_OBJECT_ENABLE
/* source-object [3] BACnetObjectIdentifier OPTIONAL */
BACNET_OBJECT_ID source_object;
#endif
/* operation [4] BACnetAuditOperation */
uint8_t operation;
#ifdef BACNET_AUDIT_NOTIFICATION_SOURCE_COMMENT_ENABLE
/* source-comment [5] CharacterString OPTIONAL */
BACNET_CHARACTER_STRING source_comment;
#endif
#ifdef BACNET_AUDIT_NOTIFICATION_TARGET_COMMENT_ENABLE
/* target-comment [6] CharacterString OPTIONAL */
BACNET_CHARACTER_STRING target_comment;
#endif
#ifdef BACNET_AUDIT_NOTIFICATION_INVOKE_ID_ENABLE
/* invoke-id [7] Unsigned8 OPTIONAL */
uint8_t invoke_id;
#endif
#ifdef BACNET_AUDIT_NOTIFICATION_SOURCE_USER_ID_ENABLE
/* source-user-id [8] Unsigned16 OPTIONAL */
uint16_t source_user_id;
#endif
#ifdef BACNET_AUDIT_NOTIFICATION_SOURCE_USER_ROLE_ENABLE
/* source-user-role [9] Unsigned8 OPTIONAL */
uint8_t source_user_role;
#endif
/* target-device [10] BACnetRecipient */
BACNET_RECIPIENT target_device;
#ifdef BACNET_AUDIT_NOTIFICATION_TARGET_OBJECT_ENABLE
/* target-object [11] BACnetObjectIdentifier OPTIONAL */
BACNET_OBJECT_ID target_object;
#endif
#ifdef BACNET_AUDIT_NOTIFICATION_TARGET_PROPERTY_ENABLE
/* target-property [12] BACnetPropertyReference OPTIONAL */
struct BACnetPropertyReference target_property;
#endif
#ifdef BACNET_AUDIT_NOTIFICATION_TARGET_PRIORITY_ENABLE
/* target-priority [13] Unsigned (1..16) OPTIONAL */
uint8_t target_priority;
#endif
#ifdef BACNET_AUDIT_NOTIFICATION_TARGET_VALUE_ENABLE
/* target-value [14] ABSTRACT-SYNTAX.&Type OPTIONAL */
BACNET_AUDIT_VALUE target_value;
#endif
#ifdef BACNET_AUDIT_NOTIFICATION_CURRENT_VALUE_ENABLE
/* current-value [15] ABSTRACT-SYNTAX.&Type OPTIONAL */
BACNET_AUDIT_VALUE current_value;
#endif
#ifdef BACNET_AUDIT_NOTIFICATION_RESULT_ENABLE
/* result [16] Error OPTIONAL */
BACNET_ERROR_CODE result;
#endif
} BACNET_AUDIT_NOTIFICATION;
/**
* @brief Datum types associated with a BACnetAuditLogRecord.
* The tag numbers are used when encoding or decoding the log_datum field.
*/
#define AUDIT_LOG_DATUM_TAG_STATUS 0
#define AUDIT_LOG_DATUM_TAG_NOTIFICATION 1
#define AUDIT_LOG_DATUM_TAG_TIME_CHANGE 2
/*
* BACnetAuditLogRecord ::= SEQUENCE {
* timestamp [0] BACnetDateTime,
* log-datum [1] CHOICE {
* log-status [0] BACnetLogStatus,
* audit-notification [1] BACnetAuditNotification,
* time-change [2] REAL
* }
* }
*/
typedef struct BACnetAuditLogRecord {
BACNET_DATE_TIME timestamp;
uint8_t tag;
union {
uint8_t log_status;
BACNET_AUDIT_NOTIFICATION notification;
float time_change;
} log_datum;
} BACNET_AUDIT_LOG_RECORD;
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
BACNET_STACK_EXPORT
int bacnet_audit_log_record_encode(
uint8_t *apdu, const BACNET_AUDIT_LOG_RECORD *value);
BACNET_STACK_EXPORT
int bacnet_audit_log_record_decode(
const uint8_t *apdu, uint32_t apdu_size, BACNET_AUDIT_LOG_RECORD *value);
BACNET_STACK_EXPORT
bool bacnet_audit_log_record_same(
const BACNET_AUDIT_LOG_RECORD *value1,
const BACNET_AUDIT_LOG_RECORD *value2);
BACNET_STACK_EXPORT
int bacnet_audit_log_notification_encode(
uint8_t *apdu, const BACNET_AUDIT_NOTIFICATION *value);
BACNET_STACK_EXPORT
int bacnet_audit_log_notification_decode(
const uint8_t *apdu, uint32_t apdu_size, BACNET_AUDIT_NOTIFICATION *value);
BACNET_STACK_EXPORT
int bacnet_audit_log_notification_context_decode(
const uint8_t *apdu,
uint16_t apdu_size,
uint8_t tag_number,
BACNET_AUDIT_NOTIFICATION *value);
BACNET_STACK_EXPORT
bool bacnet_audit_log_notification_same(
const BACNET_AUDIT_NOTIFICATION *value1,
const BACNET_AUDIT_NOTIFICATION *value2);
BACNET_STACK_EXPORT
int bacnet_audit_value_encode(uint8_t *apdu, const BACNET_AUDIT_VALUE *value);
BACNET_STACK_EXPORT
int bacnet_audit_value_context_encode(
uint8_t *apdu, uint8_t tag_number, const BACNET_AUDIT_VALUE *value);
BACNET_STACK_EXPORT
int bacnet_audit_value_decode(
const uint8_t *apdu, uint32_t apdu_size, BACNET_AUDIT_VALUE *value);
BACNET_STACK_EXPORT
int bacnet_audit_value_context_decode(
const uint8_t *apdu,
uint16_t apdu_size,
uint8_t tag_number,
BACNET_AUDIT_VALUE *value);
BACNET_STACK_EXPORT
bool bacnet_audit_value_same(
const BACNET_AUDIT_VALUE *value1, const BACNET_AUDIT_VALUE *value2);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif
+4 -2
View File
@@ -1861,7 +1861,8 @@ typedef enum BACnetStatusFlags {
typedef enum BACnetLogStatus {
LOG_STATUS_LOG_DISABLED = 0,
LOG_STATUS_BUFFER_PURGED = 1,
LOG_STATUS_LOG_INTERRUPTED = 2
LOG_STATUS_LOG_INTERRUPTED = 2,
LOG_STATUS_MAX = 3
} BACNET_LOG_STATUS;
typedef enum BACnetLoggingType {
@@ -3123,7 +3124,8 @@ typedef enum BACnetAuditOperation {
The enumerated values match the bit positions in
BACnetAuditOperationFlags. */
AUDIT_OPERATION_PROPRIETARY_MIN = 32,
AUDIT_OPERATION_PROPRIETARY_MAX = 63
AUDIT_OPERATION_PROPRIETARY_MAX = 63,
AUDIT_OPERATION_MAX = 64
} BACNET_AUDIT_OPERATION;
typedef enum BACnetSCHubConnectorState {
File diff suppressed because it is too large Load Diff
+124
View File
@@ -0,0 +1,124 @@
/**
* @file
* @author Mikhail Antropov <michail.antropov@dsr-corporation.com>
* @date Jul 2023
* @brief Auditlog object, customize for your use
*
* @section DESCRIPTION
*
* An Audit Log object combines audit notifications from operation sources and
* operation targets and stores the combined record in an internal buffer for
* subsequent retrieval. Each timestamped buffer entry is called an audit log
* "record."
*
* @section LICENSE
*
* Copyright (C) 2023 Steve Karg <skarg@users.sourceforge.net>
*
* SPDX-License-Identifier: MIT
*/
#ifndef AUDITLOG_H
#define AUDITLOG_H
#include <stdbool.h>
#include <stdint.h>
/* BACnet Stack defines - first */
#include "bacnet/bacdef.h"
/* BACnet Stack API */
#include "bacnet/bacaudit.h"
#include "bacnet/bacdest.h"
#include "bacnet/cov.h"
#include "bacnet/datetime.h"
#include "bacnet/readrange.h"
#include "bacnet/rp.h"
#include "bacnet/wp.h"
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
BACNET_STACK_EXPORT
void Audit_Log_Property_Lists(
const int **pRequired, const int **pOptional, const int **pProprietary);
BACNET_STACK_EXPORT
bool Audit_Log_Valid_Instance(uint32_t object_instance);
BACNET_STACK_EXPORT
unsigned Audit_Log_Count(void);
BACNET_STACK_EXPORT
uint32_t Audit_Log_Index_To_Instance(unsigned index);
BACNET_STACK_EXPORT
unsigned Audit_Log_Instance_To_Index(uint32_t instance);
BACNET_STACK_EXPORT
bool Audit_Log_Object_Instance_Add(uint32_t instance);
BACNET_STACK_EXPORT
bool Audit_Log_Object_Name(
uint32_t object_instance, BACNET_CHARACTER_STRING *object_name);
BACNET_STACK_EXPORT
bool Audit_Log_Name_Set(uint32_t object_instance, const char *new_name);
BACNET_STACK_EXPORT
const char *Audit_Log_Name_ASCII(uint32_t object_instance);
BACNET_STACK_EXPORT
const char *Audit_Log_Description(uint32_t instance);
BACNET_STACK_EXPORT
bool Audit_Log_Description_Set(uint32_t instance, const char *new_name);
BACNET_STACK_EXPORT
int Audit_Log_Read_Property(BACNET_READ_PROPERTY_DATA *rpdata);
BACNET_STACK_EXPORT
bool Audit_Log_Write_Property(BACNET_WRITE_PROPERTY_DATA *wp_data);
BACNET_STACK_EXPORT
uint32_t Audit_Log_Create(uint32_t object_instance);
BACNET_STACK_EXPORT
bool Audit_Log_Delete(uint32_t object_instance);
BACNET_STACK_EXPORT
void Audit_Log_Cleanup(void);
BACNET_STACK_EXPORT
void Audit_Log_Init(void);
BACNET_STACK_EXPORT
uint32_t Audit_Log_Buffer_Size(uint32_t object_instance);
BACNET_STACK_EXPORT
bool Audit_Log_Buffer_Size_Set(uint32_t object_instance, uint32_t buffer_size);
BACNET_STACK_EXPORT
uint32_t Audit_Log_Record_Count(uint32_t object_instance);
BACNET_STACK_EXPORT
uint32_t Audit_Log_Total_Record_Count(uint32_t object_instance);
BACNET_STACK_EXPORT
void Audit_Log_Record_Status_Insert(
uint32_t instance, BACNET_LOG_STATUS eStatus, bool bState);
BACNET_STACK_EXPORT
void Audit_Log_Record_Notification_Insert(
uint32_t instance, BACNET_AUDIT_NOTIFICATION *notification);
BACNET_STACK_EXPORT
BACNET_AUDIT_LOG_RECORD *
Audit_Log_Record_Entry(uint32_t object_instance, uint32_t index);
BACNET_STACK_EXPORT
void Audit_Log_Record_Entry_Delete(uint32_t object_instance, uint32_t index);
BACNET_STACK_EXPORT
bool Audit_Log_Record_Entry_Add(
uint32_t object_instance, const BACNET_AUDIT_LOG_RECORD *value);
BACNET_STACK_EXPORT
bool Audit_Log_Enable(uint32_t instance);
BACNET_STACK_EXPORT
bool Audit_Log_Enable_Set(uint32_t object_instance, bool enable);
BACNET_STACK_EXPORT
int Audit_Log_Read_Range_By_Position(BACNET_READ_RANGE_DATA *pRequest);
BACNET_STACK_EXPORT
int Audit_Log_Read_Range_By_Sequence(BACNET_READ_RANGE_DATA *pRequest);
BACNET_STACK_EXPORT
int Audit_Log_Read_Range_By_Time(BACNET_READ_RANGE_DATA *pRequest);
BACNET_STACK_EXPORT
int Audit_Log_Read_Range(uint8_t *apdu, BACNET_READ_RANGE_DATA *pRequest);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif
+45
View File
@@ -2688,6 +2688,45 @@ static const int Trend_Log_Multiple_Properties_Optional[] = {
-1
};
static const int Audit_Log_Properties_Required[] = {
/* unordered list of properties */
PROP_OBJECT_IDENTIFIER,
PROP_OBJECT_NAME,
PROP_OBJECT_TYPE,
PROP_STATUS_FLAGS,
PROP_EVENT_STATE,
PROP_ENABLE,
PROP_BUFFER_SIZE,
PROP_LOG_BUFFER,
PROP_RECORD_COUNT,
PROP_TOTAL_RECORD_COUNT,
-1
};
static const int Audit_Log_Properties_Optional[] = {
/* unordered list of properties */
PROP_DESCRIPTION,
PROP_RELIABILITY,
PROP_MEMBER_OF,
PROP_DELETE_ON_FORWARD,
PROP_ISSUE_CONFIRMED_NOTIFICATIONS,
PROP_EVENT_DETECTION_ENABLE,
PROP_NOTIFICATION_CLASS,
PROP_EVENT_ENABLE,
PROP_ACKED_TRANSITIONS,
PROP_NOTIFY_TYPE,
PROP_EVENT_TIME_STAMPS,
PROP_EVENT_MESSAGE_TEXTS,
PROP_EVENT_MESSAGE_TEXTS_CONFIG,
PROP_RELIABILITY_EVALUATION_INHIBIT,
PROP_AUDIT_LEVEL,
PROP_AUDITABLE_OPERATIONS,
PROP_TAGS,
PROP_PROFILE_LOCATION,
PROP_PROFILE_NAME,
-1
};
/**
* Function that returns the list of all Optional properties
* of known standard objects.
@@ -2891,6 +2930,9 @@ const int *property_list_optional(BACNET_OBJECT_TYPE object_type)
case OBJECT_TREND_LOG_MULTIPLE:
pList = Trend_Log_Multiple_Properties_Optional;
break;
case OBJECT_AUDIT_LOG:
pList = Audit_Log_Properties_Optional;
break;
default:
pList = Default_Properties_Optional;
break;
@@ -3102,6 +3144,9 @@ const int *property_list_required(BACNET_OBJECT_TYPE object_type)
case OBJECT_TREND_LOG_MULTIPLE:
pList = Trend_Log_Multiple_Properties_Required;
break;
case OBJECT_AUDIT_LOG:
pList = Audit_Log_Properties_Required;
break;
default:
pList = Default_Properties_Required;
break;