auth_gkh_sec_prot.h

00001 /*
00002  * Copyright (c) 2018-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_GKH_SEC_PROT_H_
00019 #define AUTH_GKH_SEC_PROT_H_
00020 
00021 /**
00022  * auth_gkh_sec_prot_register register authenticator GKH protocol to KMP service
00023  *
00024  * \param service KMP service
00025  *
00026  * \return < 0 failure
00027  * \return >= 0 success
00028  */
00029 int8_t auth_gkh_sec_prot_register(kmp_service_t *service);
00030 
00031 /**
00032  * auth_gkh_sec_prot_timing_adjust Adjust retries and timings of the GKH protocol
00033  *
00034  * Timing value is a generic number between 0 to 32 that goes from fast and
00035  * reactive network to low bandwidth and long latency.
00036  *
00037  * example value definitions:
00038  * 0-8 very fast network
00039  * 9-16 medium network
00040  * 16-24 slow network
00041  * 25-32 extremely slow network
00042  *
00043  * There is no need to have lots variations in every layer if protocol is not very active in any case.
00044  *
00045  * \param timing Timing value.
00046  *
00047  * \return < 0 failure
00048  * \return >= 0 success
00049  *
00050  */
00051 int8_t auth_gkh_sec_prot_timing_adjust(uint8_t timing);
00052 
00053 #endif /* AUTH_GKH_SEC_PROT_H_ */