Added a basic example Auditlog object. (#458)
Co-authored-by: Steve Karg <skarg@users.sourceforge.net>
This commit is contained in:
Mikhail Antropov
@@ -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
|
||||
Reference in New Issue
Block a user