Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.12.0.1
openapi_radius.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2017-2023 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 
64 typedef enum
65 {
66  OPEN_RADIUS_SERVER_CLEAR_STATS_TYPE_AUTH = 0,
67  OPEN_RADIUS_SERVER_CLEAR_STATS_TYPE_ACCT,
68  OPEN_RADIUS_SERVER_CLEAR_STATS_TYPE_ALL
69 } OPEN_RADIUS_SERVER_CLEAR_STATS_TYPE_t;
70 
71 /*****************************************************************/
83 uint32_t openapiRadiusServerAddressMaxLengthGet(openapiClientHandle_t *client_handle);
84 
85 /*****************************************************************/
97 uint32_t openapiRadiusServerNameMaxLengthGet(openapiClientHandle_t *client_handle);
98 
99 /*****************************************************************/
122 open_error_t openapiRadiusAuthServerAdd(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress,
123  OPEN_IP_ADDRESS_TYPE_t addressType, open_buffdesc *serverName);
124 
125 /*****************************************************************/
145 open_error_t openapiRadiusAuthServerRemove(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress,
146  OPEN_IP_ADDRESS_TYPE_t addressType);
147 
148 /*****************************************************************/
167 open_error_t openapiRadiusAuthServerPortNumSet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress,
168  OPEN_IP_ADDRESS_TYPE_t addressType, uint32_t portNumber);
169 
170 /*****************************************************************/
187 open_error_t openapiRadiusAuthServerPortNumGet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress,
188  OPEN_IP_ADDRESS_TYPE_t addressType, uint32_t *portNumber);
189 
190 /*****************************************************************/
209 open_error_t openapiRadiusAuthServerTypeSet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress,
210  OPEN_IP_ADDRESS_TYPE_t addressType, OPEN_RADIUS_SERVER_ENTRY_TYPE_t serverType);
211 
212 /*****************************************************************/
229 open_error_t openapiRadiusAuthServerTypeGet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress,
230  OPEN_IP_ADDRESS_TYPE_t addressType, OPEN_RADIUS_SERVER_ENTRY_TYPE_t *serverType);
231 
232 /*****************************************************************/
250 open_error_t openapiRadiusAuthServerAttribute4Set(openapiClientHandle_t *client_handle, OPEN_BOOL_t mode,
251  open_inet_addr_t *ipAddr);
252 
253 /*****************************************************************/
271 open_error_t openapiRadiusAuthServerAttribute4Get(openapiClientHandle_t *client_handle, OPEN_BOOL_t *mode,
272  open_inet_addr_t *ipAddr);
273 
274 /*****************************************************************/
286 uint32_t openapiRadiusSharedSecretMaxLengthGet(openapiClientHandle_t *client_handle);
287 
288 /*****************************************************************/
302 uint32_t openapiRadiusEncryptedSharedSecretSizeGet(openapiClientHandle_t *client_handle);
303 
304 /*****************************************************************/
323 open_error_t openapiRadiusAuthServerSharedSecretEncryptedSet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress,
324  open_buffdesc *encryptedSecret);
325 
326 /*************************************************************************/
342 open_error_t
343 openapiRadiusConfiguredServersCountGet(openapiClientHandle_t *client_handle,
344  OPEN_RADIUS_SERVER_TYPE_t servType,
345  uint32_t *pCount);
346 
347 /*************************************************************************/
367 open_error_t
368 openapiRadiusServerRetransGet(openapiClientHandle_t *client_handle,
369  open_buffdesc *pHostAddr,
370  uint32_t *pMaxRetransmit,
371  OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t *pParamStatus);
372 
373 /*************************************************************************/
396 open_error_t
397 openapiRadiusServerRetransSet(openapiClientHandle_t *client_handle,
398  open_buffdesc *pHostAddr,
399  uint32_t maxRetransmit,
400  OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t paramStatus);
401 
402 /*************************************************************************/
422 open_error_t
423 openapiRadiusServerTimeOutGet(openapiClientHandle_t *client_handle,
424  open_buffdesc *pHostAddr,
425  uint32_t *pTimeOut,
426  OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t *pParamStatus);
427 
428 /*************************************************************************/
450 open_error_t
451 openapiRadiusServerTimeOutSet(openapiClientHandle_t *client_handle,
452  open_buffdesc *pHostAddr,
453  uint32_t timeOut,
454  OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t paramStatus);
455 
456 /*************************************************************************/
473 open_error_t
474 openapiRadiusAccountingModeGet(openapiClientHandle_t *client_handle,
475  OPEN_CONTROL_t *pAccMode);
476 
477 /*************************************************************************/
493 open_error_t
494 openapiRadiusAccountingModeSet(openapiClientHandle_t *client_handle,
495  OPEN_CONTROL_t accntMode);
496 
497 /*************************************************************************/
513 open_error_t
514 openapiRadiusServerFirstIPHostNameGet(openapiClientHandle_t *client_handle,
515  open_buffdesc *pServerAddr,
516  OPEN_IP_ADDRESS_TYPE_t *pAddrType);
517 
518 /*************************************************************************/
536 open_error_t
537 openapiRadiusServerNextIPHostNameGet(openapiClientHandle_t *client_handle,
538  open_buffdesc *pCurServerAddr,
539  open_buffdesc *pNextServerAddr,
540  OPEN_IP_ADDRESS_TYPE_t *pAddrType);
541 
542 /*************************************************************************/
559 open_error_t
560 openapiRadiusServerHostNameGet(openapiClientHandle_t *client_handle,
561  open_buffdesc *pServerAddr,
562  OPEN_IP_ADDRESS_TYPE_t addrType,
563  open_buffdesc *pServerName);
564 
565 /*************************************************************************/
581 open_error_t
582 openapiRadiusServerGlobalSelectedGet(openapiClientHandle_t *client_handle,
583  open_buffdesc *pServerAddr,
584  OPEN_IP_ADDRESS_TYPE_t *pServerAddrType);
585 
586 /*************************************************************************/
604 open_error_t
605 openapiRadiusServerNameSet(openapiClientHandle_t *client_handle,
606  open_buffdesc *pServerAddr,
607  OPEN_IP_ADDRESS_TYPE_t addrType,
608  open_buffdesc *pServerName);
609 /*************************************************************************/
626 open_error_t
627 openapiRadiusNamedServerAddrGet(openapiClientHandle_t *client_handle,
628  open_buffdesc *pServerName,
629  open_buffdesc *pServerAddr,
630  OPEN_IP_ADDRESS_TYPE_t *pAddrType);
631 
632 /*************************************************************************/
648 open_error_t
649 openapiRadiusServerStatRTTGet(openapiClientHandle_t *client_handle,
650  open_buffdesc *pHostAddr,
651  uint32_t *pRoundTripTime);
652 
653 /*************************************************************************/
671 open_error_t
672 openapiRadiusServerStatAccessReqGet(openapiClientHandle_t *client_handle,
673  open_buffdesc *pHostAddr,
674  uint32_t *pPacketCount);
675 
676 /*************************************************************************/
694 open_error_t
695 openapiRadiusServerStatAccessRetransGet(openapiClientHandle_t *client_handle,
696  open_buffdesc *pHostAddr,
697  uint32_t *pPacketCount);
698 
699 /*************************************************************************/
717 open_error_t
718 openapiRadiusServerStatAccessAcceptGet(openapiClientHandle_t *client_handle,
719  open_buffdesc *pHostAddr,
720  uint32_t *pPacketCount);
721 
722 /*************************************************************************/
740 open_error_t
741 openapiRadiusServerStatAccessRejectGet(openapiClientHandle_t *client_handle,
742  open_buffdesc *pHostAddr,
743  uint32_t *pPacketCount);
744 
745 /*************************************************************************/
763 open_error_t
764 openapiRadiusServerStatAccessChallengeGet(openapiClientHandle_t *client_handle,
765  open_buffdesc *pHostAddr,
766  uint32_t *pPacketCount);
767 
768 /*************************************************************************/
789 open_error_t
790 openapiRadiusServerStatMalformedAccessResponseGet(openapiClientHandle_t *client_handle,
791  open_buffdesc *pHostAddr,
792  uint32_t *pPacketCount);
793 
794 /*************************************************************************/
813 open_error_t
814 openapiRadiusServerStatBadAuthGet(openapiClientHandle_t *client_handle,
815  open_buffdesc *pHostAddr,
816  uint32_t *pPacketCount);
817 
818 /*************************************************************************/
839 open_error_t
840 openapiRadiusServerStatPendingReqGet(openapiClientHandle_t *client_handle,
841  open_buffdesc *pHostAddr,
842  uint32_t *pPacketCount);
843 
844 /*************************************************************************/
862 open_error_t
863 openapiRadiusServerStatTimeoutsGet(openapiClientHandle_t *client_handle,
864  open_buffdesc *pHostAddr,
865  uint32_t *pPacketCount);
866 
867 /*************************************************************************/
885 open_error_t
886 openapiRadiusServerStatUnknownTypeGet(openapiClientHandle_t *client_handle,
887  open_buffdesc *pHostAddr,
888  uint32_t *pPacketCount);
889 
890 /*************************************************************************/
908 open_error_t
909 openapiRadiusServerStatPktsDroppedGet(openapiClientHandle_t *client_handle,
910  open_buffdesc *pHostAddr,
911  uint32_t *pPacketCount);
912 
913 /*************************************************************************/
931 open_error_t
932 openapiRadiusNamedAcctServerAddrGet(openapiClientHandle_t *client_handle,
933  open_buffdesc *pServerName,
934  open_buffdesc *pServerAddr,
935  OPEN_IP_ADDRESS_TYPE_t *pAddrType);
936 
937 /*************************************************************************/
955 open_error_t
956 openapiRadiusAccountingServerIPHostNameVerify(openapiClientHandle_t *client_handle,
957  open_buffdesc *pServerAddr,
958  OPEN_IP_ADDRESS_TYPE_t addrType,
959  OPEN_BOOL_t *pVerified);
960 
961 /*************************************************************************/
979 open_error_t
980 openapiRadiusServerAcctHostNameGet(openapiClientHandle_t *client_handle,
981  open_buffdesc *pServerAddr,
982  OPEN_IP_ADDRESS_TYPE_t addrType,
983  open_buffdesc *pServerName);
984 
985 /*************************************************************************/
1001 open_error_t
1002 openapiRadiusAcctServerStatRTTGet(openapiClientHandle_t *client_handle,
1003  open_buffdesc *pHostAddr,
1004  uint32_t *pRoundTripTime);
1005 
1006 /*************************************************************************/
1024 open_error_t
1025 openapiRadiusAcctServerStatReqGet(openapiClientHandle_t *client_handle,
1026  open_buffdesc *pHostAddr,
1027  uint32_t *pPacketCount);
1028 
1029 /*************************************************************************/
1047 open_error_t
1048 openapiRadiusAcctServerStatRetransGet(openapiClientHandle_t *client_handle,
1049  open_buffdesc *pHostAddr,
1050  uint32_t *pPacketCount);
1051 
1052 /*************************************************************************/
1070 open_error_t
1071 openapiRadiusAcctServerStatResponseGet(openapiClientHandle_t *client_handle,
1072  open_buffdesc *pHostAddr,
1073  uint32_t *pPacketCount);
1074 
1075 /*************************************************************************/
1096 open_error_t
1097 openapiRadiusAcctServerStatMalformedResponseGet(openapiClientHandle_t *client_handle,
1098  open_buffdesc *pHostAddr,
1099  uint32_t *pPacketCount);
1100 
1101 /*************************************************************************/
1120 open_error_t
1121 openapiRadiusAcctServerStatBadAuthGet(openapiClientHandle_t *client_handle,
1122  open_buffdesc *pHostAddr,
1123  uint32_t *pPacketCount);
1124 
1125 /*************************************************************************/
1145 open_error_t
1146 openapiRadiusAcctServerStatPendingReqGet(openapiClientHandle_t *client_handle,
1147  open_buffdesc *pHostAddr,
1148  uint32_t *pPacketCount);
1149 
1150 /*************************************************************************/
1167 open_error_t
1168 openapiRadiusAcctServerStatTimeoutsGet(openapiClientHandle_t *client_handle,
1169  open_buffdesc *pHostAddr,
1170  uint32_t *pTimeout);
1171 
1172 /*************************************************************************/
1190 open_error_t
1191 openapiRadiusAcctServerStatUnknownTypeGet(openapiClientHandle_t *client_handle,
1192  open_buffdesc *pHostAddr,
1193  uint32_t *pPacketCount);
1194 
1195 /*************************************************************************/
1214 open_error_t
1215 openapiRadiusAcctServerStatPktsDroppedGet(openapiClientHandle_t *client_handle,
1216  open_buffdesc *pHostAddr,
1217  uint32_t *pPacketCount);
1218 
1219 /*************************************************************************/
1235 open_error_t
1236 openapiRadiusAcctServerFirstIPHostNameGet(openapiClientHandle_t *client_handle,
1237  open_buffdesc *pServerAddr,
1238  OPEN_IP_ADDRESS_TYPE_t *pAddrType);
1239 
1240 /*************************************************************************/
1259 open_error_t
1260 openapiRadiusServerGlobalCurentGet(openapiClientHandle_t *client_handle,
1261  OPEN_RADIUS_SERVER_TYPE_t servType,
1262  open_buffdesc *pServerAddr,
1263  OPEN_IP_ADDRESS_TYPE_t *pAddrType);
1264 
1265 /*************************************************************************/
1283 open_error_t
1284 openapiRadiusAcctServerNextIPHostNameGet(openapiClientHandle_t *client_handle,
1285  open_buffdesc *pCurServerAddr,
1286  open_buffdesc *pNextServerAddr,
1287  OPEN_IP_ADDRESS_TYPE_t *pAddrType);
1288 
1289 /*************************************************************************/
1307 open_error_t
1308 openapiRadiusAccountingHostNameServerPortNumGet(openapiClientHandle_t *client_handle,
1309  open_buffdesc *pServerAddr,
1310  OPEN_IP_ADDRESS_TYPE_t addrType,
1311  uint32_t *pPort);
1312 
1313 /*************************************************************************/
1331 open_error_t
1332 openapiRadiusAccountingHostNameServerPortNumSet(openapiClientHandle_t *client_handle,
1333  open_buffdesc *pServerAddr,
1334  OPEN_IP_ADDRESS_TYPE_t addrType,
1335  uint32_t port);
1336 
1337 /*************************************************************************/
1354 open_error_t
1355 openapiRadiusHostNameServerAddrVerify(openapiClientHandle_t *client_handle,
1356  open_buffdesc *pServerAddr,
1357  OPEN_IP_ADDRESS_TYPE_t addrType,
1358  OPEN_BOOL_t *pVerified);
1359 
1360 /*************************************************************************/
1382 open_error_t
1383 openapiRadiusHostNameServerSharedSecretKeyTypeSet(openapiClientHandle_t *client_handle,
1384  open_buffdesc *pServerAddr,
1385  OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t paramStatus,
1386  OPEN_BOOL_t keyType);
1387 
1388 /*************************************************************************/
1408 open_error_t
1409 openapiRadiusAccountingHostNameServerSharedSecretSet(openapiClientHandle_t *client_handle,
1410  open_buffdesc *pServerAddr,
1411  OPEN_IP_ADDRESS_TYPE_t addrType,
1412  open_buffdesc *pSharedSecret);
1413 
1414 /*****************************************************************/
1436 open_error_t
1437 openapiRadiusHostNameServerIncMsgAuthModeSet(openapiClientHandle_t *client_handle,
1438  open_buffdesc *pServerAddr,
1439  OPEN_IP_ADDRESS_TYPE_t addrType,
1440  uint32_t mode);
1441 
1442 /*****************************************************************/
1463 open_error_t
1464 openapiRadiusHostNameServerIncMsgAuthModeGet(openapiClientHandle_t *client_handle,
1465  open_buffdesc *pServerAddr,
1466  OPEN_IP_ADDRESS_TYPE_t addrType,
1467  uint32_t *pMode);
1468 
1469 
1470 /*****************************************************************/
1491 open_error_t
1492 openapiRadiusHostNameServerSharedSecretConfigured(openapiClientHandle_t *client_handle,
1493  OPEN_RADIUS_SERVER_TYPE_t sType,
1494  open_buffdesc *pServerAddr,
1495  OPEN_IP_ADDRESS_TYPE_t addrType,
1496  OPEN_BOOL_t *pMode);
1497 
1498 
1499 /*****************************************************************/
1523 open_error_t
1524 openapiRadiusAcctServerAdd(openapiClientHandle_t *client_handle,
1525  open_buffdesc *pServerAddr,
1526  OPEN_IP_ADDRESS_TYPE_t addressType,
1527  open_buffdesc *pServerName);
1528 
1529 /*****************************************************************/
1549 open_error_t openapiRadiusAcctServerRemove(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress,
1550  OPEN_IP_ADDRESS_TYPE_t addressType);
1551 
1552 /*****************************************************************/
1570 open_error_t openapiRadiusStatsClear(openapiClientHandle_t *client_handle,
1571  OPEN_RADIUS_SERVER_CLEAR_STATS_TYPE_t servType);
1572 
1573 #endif
1574 
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...
OPEN_RADIUS_SERVER_TYPE_AUTH
AUTHENTICATION.
Definition: openapi_radius.h:53
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.
OPEN_RADIUS_SERVER_ENTRY_TYPE_SECONDARY
Secondary.
Definition: openapi_radius.h:47
OPEN_RADIUS_SERVER_ENTRY_TYPE_PRIMARY
Primary.
Definition: openapi_radius.h:46
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...
OPEN_RADIUS_SERVER_CLEAR_STATS_TYPE_ALL
Clear both Authentication and Accounting Statistics.
Definition: openapi_radius.h:68
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).
openapiRadiusAcctServerRemove
open_error_t openapiRadiusAcctServerRemove(openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType)
Remove a RADIUS accounting server.
open_buffdesc
Definition: openapi_common.h:138
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:131
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...
openapiRadiusHostNameServerIncMsgAuthModeSet
open_error_t openapiRadiusHostNameServerIncMsgAuthModeSet(openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, uint32_t mode)
Enable/Disable the inclusion of a Message-Authenticator attribute in each Access-Request packet to a ...
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.
openapiRadiusHostNameServerIncMsgAuthModeGet
open_error_t openapiRadiusHostNameServerIncMsgAuthModeGet(openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, uint32_t *pMode)
Enable/Disable the inclusion of a Message-Authenticator attribute in each Access-Request packet to a ...
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.
openapiRadiusAcctServerAdd
open_error_t openapiRadiusAcctServerAdd(openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addressType, open_buffdesc *pServerName)
Add a RADIUS accounting server.
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:163
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:179
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.
OPEN_RADIUS_SERVER_TYPE_UNKNOWN
Unknown.
Definition: openapi_radius.h:52
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.
OPEN_RADIUS_SERVER_TYPE_ACCT
Accounting.
Definition: openapi_radius.h:54
OPEN_RADIUS_SERVER_TYPE_t
OPEN_RADIUS_SERVER_TYPE_t
Definition: openapi_radius.h:50
openapiRadiusStatsClear
open_error_t openapiRadiusStatsClear(openapiClientHandle_t *client_handle, OPEN_RADIUS_SERVER_CLEAR_STATS_TYPE_t servType)
Clear Radius server (accounting/authorization) statistics.
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:361
openapiRadiusEncryptedSharedSecretSizeGet
uint32_t openapiRadiusEncryptedSharedSecretSizeGet(openapiClientHandle_t *client_handle)
Get the size for an encrypted RADIUS shared secret.
OPEN_RADIUS_SERVER_CLEAR_STATS_TYPE_ACCT
Clear the Accounting Statistics.
Definition: openapi_radius.h:67
OPEN_RADIUS_SERVER_CLEAR_STATS_TYPE_t
OPEN_RADIUS_SERVER_CLEAR_STATS_TYPE_t
Definition: openapi_radius.h:64
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
openapiRadiusHostNameServerSharedSecretConfigured
open_error_t openapiRadiusHostNameServerSharedSecretConfigured(openapiClientHandle_t *client_handle, OPEN_RADIUS_SERVER_TYPE_t sType, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, OPEN_BOOL_t *pMode)
Indicate if the shared secret is set.
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_RADIUS_SERVER_CLEAR_STATS_TYPE_AUTH
Clear the Authentication Statistics.
Definition: openapi_radius.h:66
open_inet_addr_s
Definition: openapi_common.h:302
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.