auth_fwh_sec_prot.h

00001 /*
00002  * Copyright (c) 2016-2019, 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 AUTH_FWH_SEC_PROT_H_
00019 #define AUTH_FWH_SEC_PROT_H_
00020 
00021 /*
00022  * Authenticator Four Way Handshake (4WH) security protocol. 4WH protocol is
00023  * specified in IEEE 802.11 and Wi-SUN FANWG-FANTPS.
00024  *
00025  */
00026 
00027 /**
00028  * auth_fwh_sec_prot_register register authenticator 4WH protocol to KMP service
00029  *
00030  * \param service KMP service
00031  *
00032  * \return < 0 failure
00033  * \return >= 0 success
00034  */
00035 int8_t auth_fwh_sec_prot_register(kmp_service_t *service);
00036 
00037 /**
00038  * auth_fwh_sec_prot_timing_adjust Adjust retries and timings of the 4WH protocol
00039  *
00040  * Timing value is a generic number between 0 to 32 that goes from fast and
00041  * reactive network to low bandwidth and long latency.
00042  *
00043  * example value definitions:
00044  * 0-8 very fast network
00045  * 9-16 medium network
00046  * 16-24 slow network
00047  * 25-32 extremely slow network
00048  *
00049  * There is no need to have lots variations in every layer if protocol is not very active in any case.
00050  *
00051  * \param timing Timing value.
00052  *
00053  * \return < 0 failure
00054  * \return >= 0 success
00055  *
00056  */
00057 int8_t auth_fwh_sec_prot_timing_adjust(uint8_t timing);
00058 
00059 #endif /* AUTH_FWH_SEC_PROT_H_ */