Simple interface for Mbed Cloud Client
Embed:
(wiki syntax)
Show/hide line numbers
arm_uc_pre_shared_key.h
00001 // ---------------------------------------------------------------------------- 00002 // Copyright 2016-2017 ARM Ltd. 00003 // 00004 // SPDX-License-Identifier: Apache-2.0 00005 // 00006 // Licensed under the Apache License, Version 2.0 (the "License"); 00007 // you may not use this file except in compliance with the License. 00008 // You may obtain a copy of the License at 00009 // 00010 // http://www.apache.org/licenses/LICENSE-2.0 00011 // 00012 // Unless required by applicable law or agreed to in writing, software 00013 // distributed under the License is distributed on an "AS IS" BASIS, 00014 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 00015 // See the License for the specific language governing permissions and 00016 // limitations under the License. 00017 // ---------------------------------------------------------------------------- 00018 00019 #ifndef ARM_UC_PRE_SHARED_KEY_H 00020 #define ARM_UC_PRE_SHARED_KEY_H 00021 00022 #ifdef __cplusplus 00023 extern "C" { 00024 #endif 00025 00026 #include "update-client-common/arm_uc_common.h" 00027 00028 #include <stdint.h> 00029 00030 typedef enum { 00031 ARM_UC_PSK_GET_DONE, 00032 ARM_UC_PSK_GET_ERROR 00033 } arm_uc_psk_event_t; 00034 00035 /** 00036 * @brief Register event handler. 00037 * 00038 * @param callback Event handler to signal result. 00039 * @return Error code. 00040 */ 00041 arm_uc_error_t ARM_UC_PreSharedKey_Initialize(void (*callback)(uint32_t)); 00042 00043 /** 00044 * @brief Set pointer to pre-shared-key with the given size. 00045 * 00046 * @param key Pointer to pre-shared-key. 00047 * @param bits Key size in bits. 00048 * 00049 * @return Error code. 00050 */ 00051 arm_uc_error_t ARM_UC_PreSharedKey_SetKey(const uint8_t* key, uint16_t bits); 00052 00053 /** 00054 * @brief Get pointer to pre-shared-key with the given size. 00055 * @details This call will generate an event upon completion because the key 00056 * pointing to might have to be loaded from asynchronous storage. 00057 * 00058 * If the event is ARM_UC_PSK_GET_DONE, key will point to a valid 00059 * pre-shared-key, which memory is handled internally. 00060 * 00061 * @param key Pointer-pointer to the shared key. 00062 * @param bits Key size in bits. 00063 * 00064 * @return Error code. 00065 */ 00066 arm_uc_error_t ARM_UC_PreSharedKey_GetKey(const uint8_t** key, uint16_t bits); 00067 00068 #ifdef __cplusplus 00069 } 00070 #endif 00071 00072 #endif // ARM_UC_PRE_SHARED_KEY_H
Generated on Tue Jul 12 2022 19:01:33 by 1.7.2