ws_eapol_auth_relay.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 WS_EAPOL_AUTH_RELAY_H_
00019 #define WS_EAPOL_AUTH_RELAY_H_
00020 
00021 #ifdef HAVE_PAE_AUTH
00022 
00023 /*
00024  * EAPOL authenticator relay acts as a proxy between EAPOL UDP relay and
00025  * authenticator PAE (KMP service). Relay is bound by default to EAPOL UDP
00026  * relay port 10253 (set by local port parameter) and transfers messages
00027  * to/from authenticator PAE. As default PAE is bound to UDP port 10254
00028  * (set by remote address and port parameters).
00029  *
00030  */
00031 
00032 /**
00033  * ws_eapol_auth_relay_start start authenticator relay
00034  *
00035  * \param interface_ptr interface
00036  * \param local_port local port
00037  * \param remote_addr remote address
00038  * \param remote_port remote port
00039  *
00040  * \return < 0 failure
00041  * \return >= 0 success
00042  *
00043  */
00044 int8_t ws_eapol_auth_relay_start(protocol_interface_info_entry_t *interface_ptr, uint16_t local_port, const uint8_t *remote_addr, uint16_t remote_port);
00045 
00046 /**
00047  *  ws_eapol_auth_relay_delete delete authenticator relay
00048  *
00049  * \param interface_ptr interface
00050  *
00051  * \return < 0 failure
00052  * \return >= 0 success
00053  *
00054  */
00055 int8_t ws_eapol_auth_relay_delete(protocol_interface_info_entry_t *interface_ptr);
00056 
00057 #else
00058 
00059 #define ws_eapol_auth_relay_start(interface_ptr, local_port, remote_addr, remote_port)
00060 #define ws_eapol_auth_relay_delete(interface_ptr)
00061 
00062 #endif
00063 
00064 #endif /* WS_EAPOL_AUTH_RELAY_H_ */