Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
openapi_radius.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2017-2018 Broadcom
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_radius.h
28 *
29 * @purpose RADIUS Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 12/09/2016
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_RADIUS_H_INCLUDED
39 #define OPENAPI_RADIUS_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
44 typedef enum
45 {
46  OPEN_RADIUS_SERVER_ENTRY_TYPE_PRIMARY = 1,
47  OPEN_RADIUS_SERVER_ENTRY_TYPE_SECONDARY = 2,
49 
50 /*****************************************************************/
63 
64 /*****************************************************************/
77 
78 /*****************************************************************/
102  OPEN_IP_ADDRESS_TYPE_t addressType, open_buffdesc *serverName);
103 
104 /*****************************************************************/
125  OPEN_IP_ADDRESS_TYPE_t addressType);
126 
127 /*****************************************************************/
147  OPEN_IP_ADDRESS_TYPE_t addressType, uint32_t portNumber);
148 
149 /*****************************************************************/
167  OPEN_IP_ADDRESS_TYPE_t addressType, uint32_t *portNumber);
168 
169 /*****************************************************************/
190 
191 /*****************************************************************/
210 
211 /*****************************************************************/
230  open_inet_addr_t *ipAddr);
231 
232 /*****************************************************************/
251  open_inet_addr_t *ipAddr);
252 
253 /*****************************************************************/
266 
267 /*****************************************************************/
282 
283 /*****************************************************************/
303  open_buffdesc *encryptedSecret);
304 
305 #endif
306 
open_error_t openapiRadiusAuthServerAttribute4Set(openapiClientHandle_t *client_handle, OPEN_BOOL_t mode, open_inet_addr_t *ipAddr)
Set the RADIUS authentication server attribute 4 value.
open_error_t openapiRadiusAuthServerSharedSecretEncryptedSet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, open_buffdesc *encryptedSecret)
Set the shared secret being used between the RADIUS client and the RADIUS server. ...
open_error_t openapiRadiusAuthServerAttribute4Get(openapiClientHandle_t *client_handle, OPEN_BOOL_t *mode, open_inet_addr_t *ipAddr)
Get the RADIUS authentication server attribute 4 value.
open_error_t openapiRadiusAuthServerTypeSet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType, OPEN_RADIUS_SERVER_ENTRY_TYPE_t serverType)
Set the RADIUS authentication server type.
OPEN_RADIUS_SERVER_ENTRY_TYPE_t
Designates a server as primary or secondary.
open_error_t
OPEN uses these enumerators to indicate the error codes.
open_error_t openapiRadiusAuthServerAdd(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType, open_buffdesc *serverName)
Add a RADIUS authentication server.
uint32_t openapiRadiusServerNameMaxLengthGet(openapiClientHandle_t *client_handle)
Get the maximum size allowed for the RADIUS servers name parameter.
open_error_t openapiRadiusAuthServerTypeGet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType, OPEN_RADIUS_SERVER_ENTRY_TYPE_t *serverType)
Get the RADIUS authentication server type.
open_error_t openapiRadiusAuthServerPortNumSet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType, uint32_t portNumber)
Set the RADIUS authentication server port number.
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
uint32_t openapiRadiusServerAddressMaxLengthGet(openapiClientHandle_t *client_handle)
Get the maximum size allowed for the RADIUS servers address parameter.
uint32_t openapiRadiusSharedSecretMaxLengthGet(openapiClientHandle_t *client_handle)
Get the maximum size allowed for the RADIUS shared secret.
OPEN_IP_ADDRESS_TYPE_t
OpEN uses this enumeration to define IP address types.
uint32_t openapiRadiusEncryptedSharedSecretSizeGet(openapiClientHandle_t *client_handle)
Get the size for an encrypted RADIUS shared secret.
open_error_t openapiRadiusAuthServerRemove(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType)
Remove a RADIUS authentication server.
open_error_t openapiRadiusAuthServerPortNumGet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType, uint32_t *portNumber)
Get the RADIUS authentication server port number.