Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.11.1.2
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,
48 } OPEN_RADIUS_SERVER_ENTRY_TYPE_t;
49 
50 typedef enum
51 {
52  OPEN_RADIUS_SERVER_TYPE_UNKNOWN = 0,
53  OPEN_RADIUS_SERVER_TYPE_AUTH,
54  OPEN_RADIUS_SERVER_TYPE_ACCT
55 } OPEN_RADIUS_SERVER_TYPE_t;
56 
57 typedef enum
58 {
59  OPEN_RADIUSGLOBAL = 0,
60  OPEN_RADIUSLOCAL
61 } OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t;
62 
63 /*****************************************************************/
75 uint32_t openapiRadiusServerAddressMaxLengthGet(openapiClientHandle_t *client_handle);
76 
77 /*****************************************************************/
89 uint32_t openapiRadiusServerNameMaxLengthGet(openapiClientHandle_t *client_handle);
90 
91 /*****************************************************************/
114 open_error_t openapiRadiusAuthServerAdd(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress,
115  OPEN_IP_ADDRESS_TYPE_t addressType, open_buffdesc *serverName);
116 
117 /*****************************************************************/
137 open_error_t openapiRadiusAuthServerRemove(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress,
138  OPEN_IP_ADDRESS_TYPE_t addressType);
139 
140 /*****************************************************************/
159 open_error_t openapiRadiusAuthServerPortNumSet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress,
160  OPEN_IP_ADDRESS_TYPE_t addressType, uint32_t portNumber);
161 
162 /*****************************************************************/
179 open_error_t openapiRadiusAuthServerPortNumGet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress,
180  OPEN_IP_ADDRESS_TYPE_t addressType, uint32_t *portNumber);
181 
182 /*****************************************************************/
201 open_error_t openapiRadiusAuthServerTypeSet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress,
202  OPEN_IP_ADDRESS_TYPE_t addressType, OPEN_RADIUS_SERVER_ENTRY_TYPE_t serverType);
203 
204 /*****************************************************************/
221 open_error_t openapiRadiusAuthServerTypeGet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress,
222  OPEN_IP_ADDRESS_TYPE_t addressType, OPEN_RADIUS_SERVER_ENTRY_TYPE_t *serverType);
223 
224 /*****************************************************************/
242 open_error_t openapiRadiusAuthServerAttribute4Set(openapiClientHandle_t *client_handle, OPEN_BOOL_t mode,
243  open_inet_addr_t *ipAddr);
244 
245 /*****************************************************************/
263 open_error_t openapiRadiusAuthServerAttribute4Get(openapiClientHandle_t *client_handle, OPEN_BOOL_t *mode,
264  open_inet_addr_t *ipAddr);
265 
266 /*****************************************************************/
278 uint32_t openapiRadiusSharedSecretMaxLengthGet(openapiClientHandle_t *client_handle);
279 
280 /*****************************************************************/
294 uint32_t openapiRadiusEncryptedSharedSecretSizeGet(openapiClientHandle_t *client_handle);
295 
296 /*****************************************************************/
315 open_error_t openapiRadiusAuthServerSharedSecretEncryptedSet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress,
316  open_buffdesc *encryptedSecret);
317 
318 /*************************************************************************/
334 open_error_t
335 openapiRadiusConfiguredServersCountGet(openapiClientHandle_t *client_handle,
336  OPEN_RADIUS_SERVER_TYPE_t servType,
337  uint32_t *pCount);
338 
339 /*************************************************************************/
356 open_error_t
357 openapiRadiusServerRetransGet(openapiClientHandle_t *client_handle,
358  open_buffdesc *pHostAddr,
359  uint32_t *pMaxRetransmit,
360  OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t *pParamStatus);
361 
362 /*************************************************************************/
380 open_error_t
381 openapiRadiusServerRetransSet(openapiClientHandle_t *client_handle,
382  open_buffdesc *pHostAddr,
383  uint32_t maxRetransmit,
384  OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t paramStatus);
385 
386 /*************************************************************************/
403 open_error_t
404 openapiRadiusServerTimeOutGet(openapiClientHandle_t *client_handle,
405  open_buffdesc *pHostAddr,
406  uint32_t *pTimeOut,
407  OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t *pParamStatus);
408 
409 /*************************************************************************/
427 open_error_t
428 openapiRadiusServerTimeOutSet(openapiClientHandle_t *client_handle,
429  open_buffdesc *pHostAddr,
430  uint32_t timeOut,
431  OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t paramStatus);
432 
433 /*************************************************************************/
450 open_error_t
451 openapiRadiusAccountingModeGet(openapiClientHandle_t *client_handle,
452  OPEN_CONTROL_t *pAccMode);
453 
454 /*************************************************************************/
470 open_error_t
471 openapiRadiusAccountingModeSet(openapiClientHandle_t *client_handle,
472  OPEN_CONTROL_t accntMode);
473 
474 /*************************************************************************/
490 open_error_t
491 openapiRadiusServerFirstIPHostNameGet(openapiClientHandle_t *client_handle,
492  open_buffdesc *pServerAddr,
493  OPEN_IP_ADDRESS_TYPE_t *pAddrType);
494 
495 /*************************************************************************/
513 open_error_t
514 openapiRadiusServerNextIPHostNameGet(openapiClientHandle_t *client_handle,
515  open_buffdesc *pCurServerAddr,
516  open_buffdesc *pNextServerAddr,
517  OPEN_IP_ADDRESS_TYPE_t *pAddrType);
518 
519 /*************************************************************************/
536 open_error_t
537 openapiRadiusServerHostNameGet(openapiClientHandle_t *client_handle,
538  open_buffdesc *pServerAddr,
539  OPEN_IP_ADDRESS_TYPE_t addrType,
540  open_buffdesc *pServerName);
541 
542 /*************************************************************************/
558 open_error_t
559 openapiRadiusServerGlobalSelectedGet(openapiClientHandle_t *client_handle,
560  open_buffdesc *pServerAddr,
561  OPEN_IP_ADDRESS_TYPE_t *pServerAddrType);
562 
563 /*************************************************************************/
581 open_error_t
582 openapiRadiusServerNameSet(openapiClientHandle_t *client_handle,
583  open_buffdesc *pServerAddr,
584  OPEN_IP_ADDRESS_TYPE_t addrType,
585  open_buffdesc *pServerName);
586 /*************************************************************************/
603 open_error_t
604 openapiRadiusNamedServerAddrGet(openapiClientHandle_t *client_handle,
605  open_buffdesc *pServerName,
606  open_buffdesc *pServerAddr,
607  OPEN_IP_ADDRESS_TYPE_t *pAddrType);
608 
609 /*************************************************************************/
625 open_error_t
626 openapiRadiusServerStatRTTGet(openapiClientHandle_t *client_handle,
627  open_buffdesc *pHostAddr,
628  uint32_t *pRoundTripTime);
629 
630 /*************************************************************************/
648 open_error_t
649 openapiRadiusServerStatAccessReqGet(openapiClientHandle_t *client_handle,
650  open_buffdesc *pHostAddr,
651  uint32_t *pPacketCount);
652 
653 /*************************************************************************/
671 open_error_t
672 openapiRadiusServerStatAccessRetransGet(openapiClientHandle_t *client_handle,
673  open_buffdesc *pHostAddr,
674  uint32_t *pPacketCount);
675 
676 /*************************************************************************/
694 open_error_t
695 openapiRadiusServerStatAccessAcceptGet(openapiClientHandle_t *client_handle,
696  open_buffdesc *pHostAddr,
697  uint32_t *pPacketCount);
698 
699 /*************************************************************************/
717 open_error_t
718 openapiRadiusServerStatAccessRejectGet(openapiClientHandle_t *client_handle,
719  open_buffdesc *pHostAddr,
720  uint32_t *pPacketCount);
721 
722 /*************************************************************************/
740 open_error_t
741 openapiRadiusServerStatAccessChallengeGet(openapiClientHandle_t *client_handle,
742  open_buffdesc *pHostAddr,
743  uint32_t *pPacketCount);
744 
745 /*************************************************************************/
766 open_error_t
767 openapiRadiusServerStatMalformedAccessResponseGet(openapiClientHandle_t *client_handle,
768  open_buffdesc *pHostAddr,
769  uint32_t *pPacketCount);
770 
771 /*************************************************************************/
790 open_error_t
791 openapiRadiusServerStatBadAuthGet(openapiClientHandle_t *client_handle,
792  open_buffdesc *pHostAddr,
793  uint32_t *pPacketCount);
794 
795 /*************************************************************************/
816 open_error_t
817 openapiRadiusServerStatPendingReqGet(openapiClientHandle_t *client_handle,
818  open_buffdesc *pHostAddr,
819  uint32_t *pPacketCount);
820 
821 /*************************************************************************/
839 open_error_t
840 openapiRadiusServerStatTimeoutsGet(openapiClientHandle_t *client_handle,
841  open_buffdesc *pHostAddr,
842  uint32_t *pPacketCount);
843 
844 /*************************************************************************/
862 open_error_t
863 openapiRadiusServerStatUnknownTypeGet(openapiClientHandle_t *client_handle,
864  open_buffdesc *pHostAddr,
865  uint32_t *pPacketCount);
866 
867 /*************************************************************************/
885 open_error_t
886 openapiRadiusServerStatPktsDroppedGet(openapiClientHandle_t *client_handle,
887  open_buffdesc *pHostAddr,
888  uint32_t *pPacketCount);
889 
890 /*************************************************************************/
908 open_error_t
909 openapiRadiusNamedAcctServerAddrGet(openapiClientHandle_t *client_handle,
910  open_buffdesc *pServerName,
911  open_buffdesc *pServerAddr,
912  OPEN_IP_ADDRESS_TYPE_t *pAddrType);
913 
914 /*************************************************************************/
932 open_error_t
933 openapiRadiusAccountingServerIPHostNameVerify(openapiClientHandle_t *client_handle,
934  open_buffdesc *pServerAddr,
935  OPEN_IP_ADDRESS_TYPE_t addrType,
936  OPEN_BOOL_t *pVerified);
937 
938 /*************************************************************************/
956 open_error_t
957 openapiRadiusServerAcctHostNameGet(openapiClientHandle_t *client_handle,
958  open_buffdesc *pServerAddr,
959  OPEN_IP_ADDRESS_TYPE_t addrType,
960  open_buffdesc *pServerName);
961 
962 /*************************************************************************/
978 open_error_t
979 openapiRadiusAcctServerStatRTTGet(openapiClientHandle_t *client_handle,
980  open_buffdesc *pHostAddr,
981  uint32_t *pRoundTripTime);
982 
983 /*************************************************************************/
1001 open_error_t
1002 openapiRadiusAcctServerStatReqGet(openapiClientHandle_t *client_handle,
1003  open_buffdesc *pHostAddr,
1004  uint32_t *pPacketCount);
1005 
1006 /*************************************************************************/
1024 open_error_t
1025 openapiRadiusAcctServerStatRetransGet(openapiClientHandle_t *client_handle,
1026  open_buffdesc *pHostAddr,
1027  uint32_t *pPacketCount);
1028 
1029 /*************************************************************************/
1047 open_error_t
1048 openapiRadiusAcctServerStatResponseGet(openapiClientHandle_t *client_handle,
1049  open_buffdesc *pHostAddr,
1050  uint32_t *pPacketCount);
1051 
1052 /*************************************************************************/
1073 open_error_t
1074 openapiRadiusAcctServerStatMalformedResponseGet(openapiClientHandle_t *client_handle,
1075  open_buffdesc *pHostAddr,
1076  uint32_t *pPacketCount);
1077 
1078 /*************************************************************************/
1097 open_error_t
1098 openapiRadiusAcctServerStatBadAuthGet(openapiClientHandle_t *client_handle,
1099  open_buffdesc *pHostAddr,
1100  uint32_t *pPacketCount);
1101 
1102 /*************************************************************************/
1122 open_error_t
1123 openapiRadiusAcctServerStatPendingReqGet(openapiClientHandle_t *client_handle,
1124  open_buffdesc *pHostAddr,
1125  uint32_t *pPacketCount);
1126 
1127 /*************************************************************************/
1144 open_error_t
1145 openapiRadiusAcctServerStatTimeoutsGet(openapiClientHandle_t *client_handle,
1146  open_buffdesc *pHostAddr,
1147  uint32_t *pTimeout);
1148 
1149 /*************************************************************************/
1167 open_error_t
1168 openapiRadiusAcctServerStatUnknownTypeGet(openapiClientHandle_t *client_handle,
1169  open_buffdesc *pHostAddr,
1170  uint32_t *pPacketCount);
1171 
1172 /*************************************************************************/
1191 open_error_t
1192 openapiRadiusAcctServerStatPktsDroppedGet(openapiClientHandle_t *client_handle,
1193  open_buffdesc *pHostAddr,
1194  uint32_t *pPacketCount);
1195 
1196 /*************************************************************************/
1212 open_error_t
1213 openapiRadiusAcctServerFirstIPHostNameGet(openapiClientHandle_t *client_handle,
1214  open_buffdesc *pServerAddr,
1215  OPEN_IP_ADDRESS_TYPE_t *pAddrType);
1216 
1217 /*************************************************************************/
1236 open_error_t
1237 openapiRadiusServerGlobalCurentGet(openapiClientHandle_t *client_handle,
1238  OPEN_RADIUS_SERVER_TYPE_t servType,
1239  open_buffdesc *pServerAddr,
1240  OPEN_IP_ADDRESS_TYPE_t *pAddrType);
1241 
1242 /*************************************************************************/
1260 open_error_t
1261 openapiRadiusAcctServerNextIPHostNameGet(openapiClientHandle_t *client_handle,
1262  open_buffdesc *pCurServerAddr,
1263  open_buffdesc *pNextServerAddr,
1264  OPEN_IP_ADDRESS_TYPE_t *pAddrType);
1265 
1266 /*************************************************************************/
1284 open_error_t
1285 openapiRadiusAccountingHostNameServerPortNumGet(openapiClientHandle_t *client_handle,
1286  open_buffdesc *pServerAddr,
1287  OPEN_IP_ADDRESS_TYPE_t addrType,
1288  uint32_t *pPort);
1289 
1290 /*************************************************************************/
1308 open_error_t
1309 openapiRadiusAccountingHostNameServerPortNumSet(openapiClientHandle_t *client_handle,
1310  open_buffdesc *pServerAddr,
1311  OPEN_IP_ADDRESS_TYPE_t addrType,
1312  uint32_t port);
1313 
1314 /*************************************************************************/
1331 open_error_t
1332 openapiRadiusHostNameServerAddrVerify(openapiClientHandle_t *client_handle,
1333  open_buffdesc *pServerAddr,
1334  OPEN_IP_ADDRESS_TYPE_t addrType,
1335  OPEN_BOOL_t *pVerified);
1336 
1337 /*************************************************************************/
1358 open_error_t
1359 openapiRadiusHostNameServerSharedSecretKeyTypeSet(openapiClientHandle_t *client_handle,
1360  open_buffdesc *pServerAddr,
1361  OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t paramStatus,
1362  OPEN_BOOL_t keyType);
1363 
1364 /*************************************************************************/
1384 open_error_t
1385 openapiRadiusAccountingHostNameServerSharedSecretSet(openapiClientHandle_t *client_handle,
1386  open_buffdesc *pServerAddr,
1387  OPEN_IP_ADDRESS_TYPE_t addrType,
1388  open_buffdesc *pSharedSecret);
1389 
1390 
1391 #endif
1392 
openapiRadiusServerStatUnknownTypeGet
open_error_t openapiRadiusServerStatUnknownTypeGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS packets of unknown type received from requested server on the authentic...
openapiRadiusAuthServerAttribute4Set
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.
openapiRadiusServerStatRTTGet
open_error_t openapiRadiusServerStatRTTGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pRoundTripTime)
Get the round trip time.
openapiRadiusAuthServerSharedSecretEncryptedSet
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. ...
openapiRadiusServerStatPktsDroppedGet
open_error_t openapiRadiusServerStatPktsDroppedGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS packets received from server on the authentication port that were dropp...
openapiRadiusServerGlobalSelectedGet
open_error_t openapiRadiusServerGlobalSelectedGet(openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t *pServerAddrType)
Gets global selected radius server address and address type.
openapiRadiusAuthServerAttribute4Get
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.
openapiRadiusAcctServerStatMalformedResponseGet
open_error_t openapiRadiusAcctServerStatMalformedResponseGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of malformed RADIUS accounting-response packets received from requested server...
openapiRadiusAuthServerTypeSet
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
OPEN_RADIUS_SERVER_ENTRY_TYPE_t
Designates a server as primary or secondary.
Definition: openapi_radius.h:44
open_error_t
open_error_t
OPEN uses these enumerators to indicate the error codes.
Definition: openapi_common.h:64
openapiRadiusNamedAcctServerAddrGet
open_error_t openapiRadiusNamedAcctServerAddrGet(openapiClientHandle_t *client_handle, open_buffdesc *pServerName, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t *pAddrType)
Gets server of specified accounting serverName.
openapiRadiusServerStatAccessReqGet
open_error_t openapiRadiusServerStatAccessReqGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS access-request packets sent to requested server.
openapiRadiusAuthServerAdd
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.
openapiRadiusServerNameMaxLengthGet
uint32_t openapiRadiusServerNameMaxLengthGet(openapiClientHandle_t *client_handle)
Get the maximum size allowed for the RADIUS servers name parameter.
openapiRadiusAcctServerNextIPHostNameGet
open_error_t openapiRadiusAcctServerNextIPHostNameGet(openapiClientHandle_t *client_handle, open_buffdesc *pCurServerAddr, open_buffdesc *pNextServerAddr, OPEN_IP_ADDRESS_TYPE_t *pAddrType)
Get the configured accounting server next in the list after the specified server. ...
openapiRadiusAcctServerFirstIPHostNameGet
open_error_t openapiRadiusAcctServerFirstIPHostNameGet(openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t *pAddrType)
Gets first accounting configured server.
openapiRadiusAcctServerStatRetransGet
open_error_t openapiRadiusAcctServerStatRetransGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS accounting-request packets retransmitted to requested server...
openapiRadiusConfiguredServersCountGet
open_error_t openapiRadiusConfiguredServersCountGet(openapiClientHandle_t *client_handle, OPEN_RADIUS_SERVER_TYPE_t servType, uint32_t *pCount)
Gets the number of configured servers of specified type (Auth or Acct).
open_buffdesc
Definition: openapi_common.h:137
openapiRadiusAcctServerStatTimeoutsGet
open_error_t openapiRadiusAcctServerStatTimeoutsGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pTimeout)
Retrieve the number of accounting time-outs to requested server.
openapiRadiusAcctServerStatRTTGet
open_error_t openapiRadiusAcctServerStatRTTGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pRoundTripTime)
Get the round trip time.
openapiClientHandle_s
Definition: openapi_common.h:130
openapiRadiusAcctServerStatPktsDroppedGet
open_error_t openapiRadiusAcctServerStatPktsDroppedGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS packets received from server on the accounting port that were dropped f...
openapiRadiusServerFirstIPHostNameGet
open_error_t openapiRadiusServerFirstIPHostNameGet(openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t *pAddrType)
Gets first configured server.
openapiRadiusNamedServerAddrGet
open_error_t openapiRadiusNamedServerAddrGet(openapiClientHandle_t *client_handle, open_buffdesc *pServerName, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t *pAddrType)
Gets server Name of specified radius server.
openapiRadiusServerHostNameGet
open_error_t openapiRadiusServerHostNameGet(openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, open_buffdesc *pServerName)
Get the server Name of specified radius server.
openapiRadiusAccountingModeGet
open_error_t openapiRadiusAccountingModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pAccMode)
Gets radius-accounting mode parameter.
openapiRadiusServerRetransSet
open_error_t openapiRadiusServerRetransSet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t maxRetransmit, OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t paramStatus)
Sets the maximum number of retransmissions parameter.
openapiRadiusServerStatBadAuthGet
open_error_t openapiRadiusServerStatBadAuthGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS access-response bad auth packets received from requested server...
openapiRadiusAcctServerStatUnknownTypeGet
open_error_t openapiRadiusAcctServerStatUnknownTypeGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS packets of unknown type received from requested server on the accountin...
openapiRadiusAccountingHostNameServerSharedSecretSet
open_error_t openapiRadiusAccountingHostNameServerSharedSecretSet(openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, open_buffdesc *pSharedSecret)
Set the shared secret being used between the radius client and the accounting server.
openapiRadiusAccountingServerIPHostNameVerify
open_error_t openapiRadiusAccountingServerIPHostNameVerify(openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, OPEN_BOOL_t *pVerified)
Verify a RADIUS accounting server is a configured server.
openapiRadiusServerGlobalCurentGet
open_error_t openapiRadiusServerGlobalCurentGet(openapiClientHandle_t *client_handle, OPEN_RADIUS_SERVER_TYPE_t servType, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t *pAddrType)
Gets global selected Radius server address, server type and address type.
openapiRadiusServerStatTimeoutsGet
open_error_t openapiRadiusServerStatTimeoutsGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of authentication time-outs to requested server.
openapiRadiusServerStatAccessChallengeGet
open_error_t openapiRadiusServerStatAccessChallengeGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS access-challenge packets received from requested server.
openapiRadiusServerRetransGet
open_error_t openapiRadiusServerRetransGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pMaxRetransmit, OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t *pParamStatus)
Gets the maximum number of retransmissions parameter.
openapiRadiusAuthServerTypeGet
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.
openapiRadiusHostNameServerAddrVerify
open_error_t openapiRadiusHostNameServerAddrVerify(openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, OPEN_BOOL_t *pVerified)
Verify a RADIUS authentication server is a configured server.
OPEN_CONTROL_t
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
Definition: openapi_common.h:162
openapiRadiusAcctServerStatBadAuthGet
open_error_t openapiRadiusAcctServerStatBadAuthGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS accounting-response bad auth packets received from requested server...
openapiRadiusAccountingHostNameServerPortNumSet
open_error_t openapiRadiusAccountingHostNameServerPortNumSet(openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, uint32_t port)
Sets the port number of the accounting server being used.
openapiRadiusAcctServerStatReqGet
open_error_t openapiRadiusAcctServerStatReqGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS accounting-request packets sent to requested server.
openapiRadiusServerNameSet
open_error_t openapiRadiusServerNameSet(openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, open_buffdesc *pServerName)
Sets server name attribute to the Auth server.
openapiRadiusAuthServerPortNumSet
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.
openapiRadiusServerStatMalformedAccessResponseGet
open_error_t openapiRadiusServerStatMalformedAccessResponseGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of malformed RADIUS access-response packets received from requested server...
openapiRadiusServerStatPendingReqGet
open_error_t openapiRadiusServerStatPendingReqGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS access-request packets destined for this server that have not yet timed...
OPEN_BOOL_t
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
Definition: openapi_common.h:178
openapiRadiusAcctServerStatResponseGet
open_error_t openapiRadiusAcctServerStatResponseGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS accounting-response packets received from requested server...
openapiRadiusServerTimeOutGet
open_error_t openapiRadiusServerTimeOutGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pTimeOut, OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t *pParamStatus)
Gets the value of time-out duration parameter.
openapiRadiusServerAddressMaxLengthGet
uint32_t openapiRadiusServerAddressMaxLengthGet(openapiClientHandle_t *client_handle)
Get the maximum size allowed for the RADIUS servers address parameter.
openapiRadiusServerAcctHostNameGet
open_error_t openapiRadiusServerAcctHostNameGet(openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, open_buffdesc *pServerName)
Gets server name of specified accounting server.
openapiRadiusHostNameServerSharedSecretKeyTypeSet
open_error_t openapiRadiusHostNameServerSharedSecretKeyTypeSet(openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t paramStatus, OPEN_BOOL_t keyType)
Set the shared secret being used between the radius client and the radius server. ...
openapiRadiusServerStatAccessRetransGet
open_error_t openapiRadiusServerStatAccessRetransGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS access-request packets retransmitted to requested server.
openapiRadiusServerStatAccessAcceptGet
open_error_t openapiRadiusServerStatAccessAcceptGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS access-request packets received from requested server.
openapiRadiusSharedSecretMaxLengthGet
uint32_t openapiRadiusSharedSecretMaxLengthGet(openapiClientHandle_t *client_handle)
Get the maximum size allowed for the RADIUS shared secret.
OPEN_IP_ADDRESS_TYPE_t
OPEN_IP_ADDRESS_TYPE_t
OpEN uses this enumeration to define IP address types.
Definition: openapi_common.h:355
openapiRadiusEncryptedSharedSecretSizeGet
uint32_t openapiRadiusEncryptedSharedSecretSizeGet(openapiClientHandle_t *client_handle)
Get the size for an encrypted RADIUS shared secret.
openapiRadiusAuthServerRemove
open_error_t openapiRadiusAuthServerRemove(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType)
Remove a RADIUS authentication server.
openapiRadiusServerStatAccessRejectGet
open_error_t openapiRadiusServerStatAccessRejectGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS access-reject packets received from requested server.
openapi_common.h
openapiRadiusServerNextIPHostNameGet
open_error_t openapiRadiusServerNextIPHostNameGet(openapiClientHandle_t *client_handle, open_buffdesc *pCurServerAddr, open_buffdesc *pNextServerAddr, OPEN_IP_ADDRESS_TYPE_t *pAddrType)
Get the configured next server in the list after the specified server.
openapiRadiusAccountingModeSet
open_error_t openapiRadiusAccountingModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t accntMode)
Sets radius-accounting mode parameter.
openapiRadiusAccountingHostNameServerPortNumGet
open_error_t openapiRadiusAccountingHostNameServerPortNumGet(openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, uint32_t *pPort)
Get the port number of the accounting server being used.
openapiRadiusAcctServerStatPendingReqGet
open_error_t openapiRadiusAcctServerStatPendingReqGet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
Retrieve the number of RADIUS accounting-request packets destined for this server that have not yet t...
openapiRadiusServerTimeOutSet
open_error_t openapiRadiusServerTimeOutSet(openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t timeOut, OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t paramStatus)
Sets the time-out duration parameter.
open_inet_addr_s
Definition: openapi_common.h:296
openapiRadiusAuthServerPortNumGet
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.