Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Enumerations | |
enum | OPEN_RADIUS_SERVER_ENTRY_TYPE_t { OPEN_RADIUS_SERVER_ENTRY_TYPE_PRIMARY = 1, OPEN_RADIUS_SERVER_ENTRY_TYPE_SECONDARY = 2 } |
Designates a server as primary or secondary. More... | |
Functions | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
open_error_t | openapiRadiusAuthServerRemove (openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType) |
Remove a RADIUS authentication server. More... | |
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. More... | |
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. More... | |
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. More... | |
uint32_t | openapiRadiusEncryptedSharedSecretSizeGet (openapiClientHandle_t *client_handle) |
Get the size for an encrypted RADIUS shared secret. More... | |
uint32_t | openapiRadiusServerAddressMaxLengthGet (openapiClientHandle_t *client_handle) |
Get the maximum size allowed for the RADIUS servers address parameter. More... | |
uint32_t | openapiRadiusServerNameMaxLengthGet (openapiClientHandle_t *client_handle) |
Get the maximum size allowed for the RADIUS servers name parameter. More... | |
uint32_t | openapiRadiusSharedSecretMaxLengthGet (openapiClientHandle_t *client_handle) |
Get the maximum size allowed for the RADIUS shared secret. More... | |
Designates a server as primary or secondary.
Definition at line 44 of file openapi_radius.h.
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.
[in] | client_handle | Client handle from registration API |
[in] | serverAddress | DNS name/IP address of the server |
[in] | addressType | indicates whether serverAddress contains a DNS name or a IP address |
[in] | serverName | name identifying the server in the configuration |
OPEN_E_NONE | server added |
OPEN_E_FAIL | adding server failed |
OPEN_E_PARAM | invalid parameter passed |
OPEN_E_INTERNAL | internal error has occurred |
OpEN API Version: 1.14
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.
[in] | client_handle | Client handle from registration API |
[out] | mode | OPEN_FALSE indicates attribute 4 not configured, OPEN_TRUE indicates attribute 4 configured |
[out] | ipAddr | the IP address to send, only IPv4 addresses supported |
OPEN_E_NONE | get succeeded |
OPEN_E_FAIL | get failed |
OPEN_E_PARAM | invalid parameter passed |
OPEN_E_INTERNAL | internal error has occurred |
OpEN API Version: 1.14
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.
[in] | client_handle | Client handle from registration API |
[in] | mode | set to OPEN_FALSE to unconfigure attribute 4, set to OPEN_TRUE to set attribute 4 |
[in] | ipAddr | the IP address to send, only IPv4 addresses supported |
OPEN_E_NONE | set succeeded |
OPEN_E_FAIL | set failed |
OPEN_E_PARAM | invalid parameter passed |
OPEN_E_INTERNAL | internal error has occurred |
OpEN API Version: 1.14
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.
[in] | client_handle | Client handle from registration API |
[in] | serverAddress | DNS name/IP address of the server |
[in] | addressType | indicates whether serverAddress contains a DNS name or a IP address |
[out] | portNumber | server's port number |
OPEN_E_NONE | get succeeded |
OPEN_E_FAIL | get failed |
OPEN_E_PARAM | invalid parameter passed |
OPEN_E_INTERNAL | internal error has occurred |
OpEN API Version: 1.14
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.
[in] | client_handle | Client handle from registration API |
[in] | serverAddress | DNS name/IP address of the server |
[in] | addressType | indicates whether serverAddress contains a DNS name or a IP address |
[in] | portNumber | server's port number |
OPEN_E_NONE | set succeeded |
OPEN_E_FAIL | set failed |
OPEN_E_PARAM | invalid parameter passed |
OPEN_E_INTERNAL | internal error has occurred |
OpEN API Version: 1.14
open_error_t openapiRadiusAuthServerRemove | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | serverAddress, | ||
OPEN_IP_ADDRESS_TYPE_t | addressType | ||
) |
Remove a RADIUS authentication server.
[in] | client_handle | Client handle from registration API |
[in] | serverAddress | DNS name/IP address of the server |
[in] | addressType | indicates whether serverAddress contains a DNS name or a IP address |
OPEN_E_NONE | server removed |
OPEN_E_FAIL | removing server failed |
OPEN_E_PARAM | invalid parameter passed |
OPEN_E_INTERNAL | internal error has occurred |
OpEN API Version: 1.14
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.
The shared secret is specified in encrypted form.
[in] | client_handle | Client handle from registration API |
[in] | serverAddress | DNS name/IP address of the server |
[in] | encryptedSecret | encrypted secret |
OPEN_E_NONE | set succeeded |
OPEN_E_FAIL | set failed |
OPEN_E_PARAM | invalid parameter passed |
OPEN_E_INTERNAL | internal error has occurred |
OpEN API Version: 1.14
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.
[in] | client_handle | Client handle from registration API |
[in] | serverAddress | DNS name/IP address of the server |
[in] | addressType | indicates whether serverAddress contains a DNS name or a IP address |
[out] | serverType | server's type |
OPEN_E_NONE | get succeeded |
OPEN_E_FAIL | get failed |
OPEN_E_PARAM | invalid parameter passed |
OPEN_E_INTERNAL | internal error has occurred |
OpEN API Version: 1.14
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.
[in] | client_handle | Client handle from registration API |
[in] | serverAddress | DNS name/IP address of the server |
[in] | addressType | indicates whether serverAddress contains a DNS name or a IP address |
[in] | serverType | server's type |
OPEN_E_NONE | set succeeded |
OPEN_E_FAIL | set failed |
OPEN_E_PARAM | invalid parameter passed |
OPEN_E_INTERNAL | internal error has occurred |
OpEN API Version: 1.14
uint32_t openapiRadiusEncryptedSharedSecretSizeGet | ( | openapiClientHandle_t * | client_handle | ) |
Get the size for an encrypted RADIUS shared secret.
This is used as the string length including the terminating NULL. Encrypted shared secrets are a series of hexadecimal digits represented in ASCIIZ string format.
[in] | client_handle | Client handle from registration API |
OpEN API Version: 1.14
uint32_t openapiRadiusServerAddressMaxLengthGet | ( | openapiClientHandle_t * | client_handle | ) |
Get the maximum size allowed for the RADIUS servers address parameter.
This is used as the string length including the terminating NULL.
[in] | client_handle | Client handle from registration API |
OpEN API Version: 1.14
uint32_t openapiRadiusServerNameMaxLengthGet | ( | openapiClientHandle_t * | client_handle | ) |
Get the maximum size allowed for the RADIUS servers name parameter.
This is used as the string length including the terminating NULL.
[in] | client_handle | Client handle from registration API |
OpEN API Version: 1.14
uint32_t openapiRadiusSharedSecretMaxLengthGet | ( | openapiClientHandle_t * | client_handle | ) |
Get the maximum size allowed for the RADIUS shared secret.
This is used as the string length including the terminating NULL.
[in] | client_handle | Client handle from registration API |
OpEN API Version: 1.14