ws_eapol_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_RELAY_H_
00019 #define WS_EAPOL_RELAY_H_
00020 
00021 #ifdef HAVE_EAPOL_RELAY
00022 
00023 /*
00024  * EAPOL relay conveys EAPOL PDUs between authenticator EAPOL relay and local
00025  * MPX interface.
00026  *
00027  * On supplicant (i.e. node) relay should be bound to UDP port 10253 (local
00028  * port parameter).
00029  *
00030  * On authenticator (border router) relay will need to use some other port than
00031  * 10253 since authenticator EAPOL relay is bound to port 10253.
00032  *
00033  * Border router address needs to be set on start (remote address and remote port
00034  * parameter).
00035  *
00036  */
00037 
00038 /**
00039  *  ws_eapol_relay_start start EAPOL relay
00040  *
00041  * \param interface_ptr interface
00042  * \param local_port local port
00043  * \param remote_addr remote address (border router relay address)
00044  * \param remote_port remote port (border router relay port)
00045  *
00046  * \return < 0 failure
00047  * \return >= 0 success
00048  *
00049  */
00050 int8_t ws_eapol_relay_start(protocol_interface_info_entry_t *interface_ptr, uint16_t local_port, const uint8_t *remote_addr, uint16_t remote_port);
00051 
00052 /**
00053  *  ws_eapol_relay_delete delete EAPOL
00054  *
00055  * \param interface_ptr interface
00056  *
00057  * \return < 0 failure
00058  * \return >= 0 success
00059  *
00060  */
00061 int8_t ws_eapol_relay_delete(protocol_interface_info_entry_t *interface_ptr);
00062 
00063 #else
00064 
00065 #define ws_eapol_relay_start(interface_ptr, local_port, remote_addr, remote_port);
00066 #define ws_eapol_relay_delete(interface_ptr);
00067 
00068 #endif
00069 
00070 #endif /* WS_EAPOL_RELAY_H_ */