mac_security_mib.h

00001 /*
00002  * Copyright (c) 2016-2017, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 
00018 #ifndef MAC_SECURITY_MIB_H_
00019 #define MAC_SECURITY_MIB_H_
00020 
00021 #include "mlme.h"
00022 
00023 struct protocol_interface_rf_mac_setup;
00024 struct mac_description_storage_size_s;
00025 
00026 typedef struct mlme_key_descriptor_s {
00027     mlme_key_id_lookup_descriptor_t *KeyIdLookupList;
00028     uint8_t KeyIdLookupListEntries;
00029     mlme_key_device_descriptor_t *KeyDeviceList;
00030     uint8_t KeyDeviceListSize;
00031     uint8_t KeyDeviceListEntries;
00032     mlme_key_usage_descriptor_t *KeyUsageList;
00033     uint8_t KeyUsageListEntries;
00034     uint8_t KeyUsageListSize;
00035     uint8_t Key[16];
00036     bool unique_key_descriptor;
00037 }mlme_key_descriptor_t;
00038 
00039 int8_t mac_sec_mib_init(struct protocol_interface_rf_mac_setup *rf_mac_setup, struct mac_description_storage_size_s *storage_sizes);
00040 
00041 void mac_sec_mib_deinit(struct protocol_interface_rf_mac_setup *rf_mac_setup);
00042 
00043 int8_t mac_sec_mib_device_description_set(uint8_t atribute_index, mlme_device_descriptor_t *device_descriptor, struct protocol_interface_rf_mac_setup *rf_mac_setup);
00044 
00045 int8_t mac_sec_mib_key_description_set(uint8_t atribute_index, mlme_key_descriptor_entry_t *key_descriptor, struct protocol_interface_rf_mac_setup *rf_mac_setup);
00046 
00047 mlme_device_descriptor_t *mac_sec_mib_device_description_get_attribute_index(struct protocol_interface_rf_mac_setup *rf_mac_setup, uint8_t attribute_index);
00048 
00049 mlme_device_descriptor_t *mac_sec_mib_device_description_get(struct protocol_interface_rf_mac_setup *rf_mac_setup, const uint8_t *address, uint8_t type);
00050 
00051 uint8_t mac_mib_device_descption_attribute_get_by_descriptor(struct protocol_interface_rf_mac_setup *rf_mac_setup, mlme_device_descriptor_t *descriptor);
00052 
00053 mlme_key_descriptor_t * mac_sec_key_description_get(struct protocol_interface_rf_mac_setup *rf_mac_setup, mlme_security_t *key_source, uint8_t address_mode, uint8_t *address_ptr, uint16_t pan_id);
00054 
00055 mlme_key_device_descriptor_t * mac_sec_mib_key_device_description_list_update(mlme_key_descriptor_t *key_descpription_table);
00056 
00057 mlme_key_device_descriptor_t * mac_sec_mib_key_device_description_discover_from_list(mlme_key_descriptor_t *key_descpription_table, uint8_t device_descriptor_handle);
00058 
00059 void mac_sec_mib_device_description_blacklist(struct protocol_interface_rf_mac_setup *rf_mac_setup , uint8_t device_handle);
00060 
00061 #endif /* MAC_SECURITY_MIB_H_ */