/** * @file * @brief A basic BACnet Access User Object implementation. * @author Nikola Jelic * @date 2015 * @copyright SPDX-License-Identifier: MIT */ #include #include #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" /* BACnet Stack API */ #include "bacnet/bacdcode.h" #include "bacnet/bacapp.h" #include "bacnet/proplist.h" #include "bacnet/wp.h" #include "access_user.h" #include "bacnet/basic/services.h" static bool Access_User_Initialized = false; static ACCESS_USER_DESCR au_descr[MAX_ACCESS_USERS]; /* These three arrays are used by the ReadPropertyMultiple handler */ static const int32_t Properties_Required[] = { /* unordered list of required properties */ PROP_OBJECT_IDENTIFIER, PROP_OBJECT_NAME, PROP_OBJECT_TYPE, PROP_GLOBAL_IDENTIFIER, PROP_STATUS_FLAGS, PROP_RELIABILITY, PROP_USER_TYPE, PROP_CREDENTIALS, -1 }; static const int32_t Properties_Optional[] = { -1 }; static const int32_t Properties_Proprietary[] = { -1 }; /* Every object shall have a Writable Property_List property which is a BACnetARRAY of property identifiers, one property identifier for each property within this object that is always writable. */ static const int32_t Writable_Properties[] = { /* unordered list of writable properties */ PROP_GLOBAL_IDENTIFIER, -1, }; void Access_User_Property_Lists( const int32_t **pRequired, const int32_t **pOptional, const int32_t **pProprietary) { if (pRequired) { *pRequired = Properties_Required; } if (pOptional) { *pOptional = Properties_Optional; } if (pProprietary) { *pProprietary = Properties_Proprietary; } return; } /** * @brief Get the list of writable properties for an Access User object * @param object_instance - object-instance number of the object * @param properties - Pointer to the pointer of writable properties. */ void Access_User_Writable_Property_List( uint32_t object_instance, const int32_t **properties) { (void)object_instance; if (properties) { *properties = Writable_Properties; } } void Access_User_Init(void) { unsigned i; if (!Access_User_Initialized) { Access_User_Initialized = true; for (i = 0; i < MAX_ACCESS_USERS; i++) { au_descr[i].global_identifier = 0; /* set to some meaningful value */ au_descr[i].reliability = RELIABILITY_NO_FAULT_DETECTED; au_descr[i].user_type = ACCESS_USER_TYPE_PERSON; au_descr[i].credentials_count = 0; /* fill in the credentials with proper ids */ } } return; } /* we simply have 0-n object instances. Yours might be */ /* more complex, and then you need validate that the */ /* given instance exists */ bool Access_User_Valid_Instance(uint32_t object_instance) { if (object_instance < MAX_ACCESS_USERS) { return true; } return false; } /* we simply have 0-n object instances. Yours might be */ /* more complex, and then count how many you have */ unsigned Access_User_Count(void) { return MAX_ACCESS_USERS; } /* we simply have 0-n object instances. Yours might be */ /* more complex, and then you need to return the instance */ /* that correlates to the correct index */ uint32_t Access_User_Index_To_Instance(unsigned index) { return index; } /* we simply have 0-n object instances. Yours might be */ /* more complex, and then you need to return the index */ /* that correlates to the correct instance number */ unsigned Access_User_Instance_To_Index(uint32_t object_instance) { unsigned index = MAX_ACCESS_USERS; if (object_instance < MAX_ACCESS_USERS) { index = object_instance; } return index; } /* note: the object name must be unique within this device */ bool Access_User_Object_Name( uint32_t object_instance, BACNET_CHARACTER_STRING *object_name) { char text[32] = ""; bool status = false; if (object_instance < MAX_ACCESS_USERS) { snprintf( text, sizeof(text), "ACCESS USER %lu", (unsigned long)object_instance); status = characterstring_init_ansi(object_name, text); } return status; } /* return apdu len, or BACNET_STATUS_ERROR on error */ int Access_User_Read_Property(BACNET_READ_PROPERTY_DATA *rpdata) { int len = 0; int apdu_len = 0; /* return value */ BACNET_BIT_STRING bit_string; BACNET_CHARACTER_STRING char_string; unsigned object_index = 0; unsigned i = 0; uint8_t *apdu = NULL; if ((rpdata == NULL) || (rpdata->application_data == NULL) || (rpdata->application_data_len == 0)) { return 0; } apdu = rpdata->application_data; object_index = Access_User_Instance_To_Index(rpdata->object_instance); switch (rpdata->object_property) { case PROP_OBJECT_IDENTIFIER: apdu_len = encode_application_object_id( &apdu[0], OBJECT_ACCESS_USER, rpdata->object_instance); break; case PROP_OBJECT_NAME: Access_User_Object_Name(rpdata->object_instance, &char_string); apdu_len = encode_application_character_string(&apdu[0], &char_string); break; case PROP_OBJECT_TYPE: apdu_len = encode_application_enumerated(&apdu[0], OBJECT_ACCESS_USER); break; case PROP_GLOBAL_IDENTIFIER: apdu_len = encode_application_unsigned( &apdu[0], au_descr[object_index].global_identifier); break; case PROP_STATUS_FLAGS: bitstring_init(&bit_string); bitstring_set_bit(&bit_string, STATUS_FLAG_IN_ALARM, false); bitstring_set_bit(&bit_string, STATUS_FLAG_FAULT, false); bitstring_set_bit(&bit_string, STATUS_FLAG_OVERRIDDEN, false); bitstring_set_bit(&bit_string, STATUS_FLAG_OUT_OF_SERVICE, false); apdu_len = encode_application_bitstring(&apdu[0], &bit_string); break; case PROP_RELIABILITY: apdu_len = encode_application_enumerated( &apdu[0], au_descr[object_index].reliability); break; case PROP_USER_TYPE: apdu_len = encode_application_enumerated( &apdu[0], au_descr[object_index].user_type); break; case PROP_CREDENTIALS: for (i = 0; i < au_descr[object_index].credentials_count; i++) { len = bacapp_encode_device_obj_ref( &apdu[0], &au_descr[object_index].credentials[i]); if (apdu_len + len < MAX_APDU) { apdu_len += len; } else { rpdata->error_code = ERROR_CODE_ABORT_SEGMENTATION_NOT_SUPPORTED; apdu_len = BACNET_STATUS_ABORT; break; } } break; default: rpdata->error_class = ERROR_CLASS_PROPERTY; rpdata->error_code = ERROR_CODE_UNKNOWN_PROPERTY; apdu_len = BACNET_STATUS_ERROR; break; } return apdu_len; } /* returns true if successful */ bool Access_User_Write_Property(BACNET_WRITE_PROPERTY_DATA *wp_data) { bool status = false; /* return value */ int len = 0; BACNET_APPLICATION_DATA_VALUE value = { 0 }; unsigned object_index = 0; /* decode the some of the request */ len = bacapp_decode_application_data( wp_data->application_data, wp_data->application_data_len, &value); /* FIXME: len < application_data_len: more data? */ if (len < 0) { /* error while decoding - a value larger than we can handle */ wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE; return false; } object_index = Access_User_Instance_To_Index(wp_data->object_instance); switch (wp_data->object_property) { case PROP_GLOBAL_IDENTIFIER: status = write_property_type_valid( wp_data, &value, BACNET_APPLICATION_TAG_UNSIGNED_INT); if (status) { au_descr[object_index].global_identifier = value.type.Unsigned_Int; } break; default: if (property_lists_member( Properties_Required, Properties_Optional, Properties_Proprietary, wp_data->object_property)) { wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_WRITE_ACCESS_DENIED; } else { wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_UNKNOWN_PROPERTY; } break; } return status; }