auth_eap_tls_sec_prot.h

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