Steve Karg
117 lines
3.2 KiB
C
117 lines
3.2 KiB
C
/**
|
|
* @file
|
|
* @brief API for basic BACnet Access Credential Object implementation.
|
|
* @author Nikola Jelic <nikola.jelic@euroicc.com>
|
|
* @date 2015
|
|
* @copyright SPDX-License-Identifier: MIT
|
|
*/
|
|
#ifndef BACNET_BASIC_OBJECT_ACCESS_CREDENTIAL_H
|
|
#define BACNET_BASIC_OBJECT_ACCESS_CREDENTIAL_H
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
/* BACnet Stack defines - first */
|
|
#include "bacnet/bacdef.h"
|
|
/* BACnet Stack API */
|
|
#include "bacnet/bacerror.h"
|
|
#include "bacnet/datetime.h"
|
|
#include "bacnet/timestamp.h"
|
|
#include "bacnet/bacdevobjpropref.h"
|
|
#include "bacnet/assigned_access_rights.h"
|
|
#include "bacnet/credential_authentication_factor.h"
|
|
#include "bacnet/rp.h"
|
|
#include "bacnet/wp.h"
|
|
|
|
|
|
#ifndef MAX_ACCESS_CREDENTIALS
|
|
#define MAX_ACCESS_CREDENTIALS 4
|
|
#endif
|
|
|
|
#ifndef MAX_REASONS_FOR_DISABLE
|
|
#define MAX_REASONS_FOR_DISABLE 4
|
|
#endif
|
|
|
|
#ifndef MAX_AUTHENTICATION_FACTORS
|
|
#define MAX_AUTHENTICATION_FACTORS 4
|
|
#endif
|
|
|
|
#ifndef MAX_ASSIGNED_ACCESS_RIGHTS
|
|
#define MAX_ASSIGNED_ACCESS_RIGHTS 4
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
typedef struct {
|
|
uint32_t global_identifier;
|
|
BACNET_RELIABILITY reliability;
|
|
bool credential_status;
|
|
uint32_t reasons_count;
|
|
BACNET_ACCESS_CREDENTIAL_DISABLE_REASON
|
|
reason_for_disable[MAX_REASONS_FOR_DISABLE];
|
|
uint32_t auth_factors_count;
|
|
BACNET_CREDENTIAL_AUTHENTICATION_FACTOR
|
|
auth_factors[MAX_AUTHENTICATION_FACTORS];
|
|
BACNET_DATE_TIME activation_time, expiration_time;
|
|
BACNET_ACCESS_CREDENTIAL_DISABLE credential_disable;
|
|
uint32_t assigned_access_rights_count;
|
|
BACNET_ASSIGNED_ACCESS_RIGHTS
|
|
assigned_access_rights[MAX_ASSIGNED_ACCESS_RIGHTS];
|
|
} ACCESS_CREDENTIAL_DESCR;
|
|
|
|
BACNET_STACK_EXPORT
|
|
void Access_Credential_Property_Lists(
|
|
const int **pRequired,
|
|
const int **pOptional,
|
|
const int **pProprietary);
|
|
BACNET_STACK_EXPORT
|
|
bool Access_Credential_Valid_Instance(
|
|
uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
unsigned Access_Credential_Count(
|
|
void);
|
|
BACNET_STACK_EXPORT
|
|
uint32_t Access_Credential_Index_To_Instance(
|
|
unsigned index);
|
|
BACNET_STACK_EXPORT
|
|
unsigned Access_Credential_Instance_To_Index(
|
|
uint32_t instance);
|
|
BACNET_STACK_EXPORT
|
|
bool Access_Credential_Object_Instance_Add(
|
|
uint32_t instance);
|
|
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Access_Credential_Object_Name(
|
|
uint32_t object_instance,
|
|
BACNET_CHARACTER_STRING * object_name);
|
|
BACNET_STACK_EXPORT
|
|
bool Access_Credential_Name_Set(
|
|
uint32_t object_instance,
|
|
char *new_name);
|
|
|
|
BACNET_STACK_EXPORT
|
|
int Access_Credential_Read_Property(
|
|
BACNET_READ_PROPERTY_DATA * rpdata);
|
|
BACNET_STACK_EXPORT
|
|
bool Access_Credential_Write_Property(
|
|
BACNET_WRITE_PROPERTY_DATA * wp_data);
|
|
|
|
BACNET_STACK_EXPORT
|
|
uint32_t Access_Credential_Create(
|
|
uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
bool Access_Credential_Delete(
|
|
uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
void Access_Credential_Cleanup(
|
|
void);
|
|
BACNET_STACK_EXPORT
|
|
void Access_Credential_Init(
|
|
void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
#endif
|