RDK Documentation (Open Sourced RDK Components)
TR-069 Object (Device.WiFi.AccessPoint.{i}.Security.) Public APIs

Description

This module contains security related parameters that apply to a CPE acting as an Access Point [802.11-2007].

int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_ModesSupported (HOSTIF_MsgData_t *stMsgData)
 Get the comma-separated list of strings, indicate which security modes this AccessPoint instance is capable of supporting. Each list item is an enumeration of. More...
 
int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_ModeEnabled (HOSTIF_MsgData_t *stMsgData)
 Get the security mode enabled for wifi device. The value must be a member of the list reported by the ModesSupported parameter, indicates which security mode is enabled. More...
 
int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_WEPKey (HOSTIF_MsgData_t *stMsgData)
 Provide A WEP key expressed as a hexadecimal string. More...
 
int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_PreSharedKey (HOSTIF_MsgData_t *stMsgData)
 A literal PreSharedKey (PSK) expressed as a hexadecimal string. More...
 
int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_KeyPassphrase (HOSTIF_MsgData_t *stMsgData)
 Provide a passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes. More...
 
int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_RekeyingInterval (HOSTIF_MsgData_t *stMsgData)
 Get the interval (expressed in seconds) in which the keys are re-generated. More...
 
int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_RadiusServerIPAddr (HOSTIF_MsgData_t *stMsgData)
 Get the IP Address of the RADIUS server used for WLAN security. RadiusServerIPAddr is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). More...
 
int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_RadiusServerPort (HOSTIF_MsgData_t *stMsgData)
 Get the port number of the RADIUS server used for WLAN security. RadiusServerPort is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). More...
 
int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_RadiusSecret (HOSTIF_MsgData_t *stMsgData)
 The secret used for handshaking with the RADIUS server [RFC2865]. When read, this parameter returns an empty string, regardless of the actual value. More...
 

Function Documentation

◆ get_hostIf_WiFi_AccessPoint_Security_ModesSupported()

int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_ModesSupported ( HOSTIF_MsgData_t stMsgData)

Get the comma-separated list of strings, indicate which security modes this AccessPoint instance is capable of supporting. Each list item is an enumeration of.

  • None
  • WEP-64
  • WEP-128
  • WPA-Personal
  • WPA2-Personal
  • WPA-WPA2-Personal
  • WPA-Enterprise
  • WPA2-Enterprise
  • WPA-WPA2-Enterprise
Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_Security_ModeEnabled()

int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_ModeEnabled ( HOSTIF_MsgData_t stMsgData)

Get the security mode enabled for wifi device. The value must be a member of the list reported by the ModesSupported parameter, indicates which security mode is enabled.

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_Security_WEPKey()

int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_WEPKey ( HOSTIF_MsgData_t stMsgData)

Provide A WEP key expressed as a hexadecimal string.

WEPKey is used only if ModeEnabled is set to WEP-64 or WEP-128. A 5 byte WEPKey corresponds to security mode WEP-64 and a 13 byte WEPKey corresponds to security mode WEP-128.

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_Security_PreSharedKey()

int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_PreSharedKey ( HOSTIF_MsgData_t stMsgData)

A literal PreSharedKey (PSK) expressed as a hexadecimal string.

PreSharedKey is only used if ModeEnabled is set to WPA-Personal or WPA2-Personal or WPA-WPA2-Personal. If KeyPassphrase is written, then PreSharedKey is immediately generated. The ACS SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined). When read, this parameter returns an empty string, regardless of the actual value.

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_Security_KeyPassphrase()

int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_KeyPassphrase ( HOSTIF_MsgData_t stMsgData)

Provide a passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes.

If KeyPassphrase is written, then PreSharedKey is immediately generated. The ACS SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined). The key is generated as specified by WPA, which uses PBKDF2 from PKCS #5: Password-based Cryptography Specification Version 2.0 ([RFC2898]).

When read, this parameter returns an empty string, regardless of the actual value.

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_Security_RekeyingInterval()

int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_RekeyingInterval ( HOSTIF_MsgData_t stMsgData)

Get the interval (expressed in seconds) in which the keys are re-generated.

This is applicable to WPA, WPA2 and Mixed (WPA-WPA2) modes in Personal or Enterprise mode (i.e. when ModeEnabled is set to a value other than None or WEP-64 or WEP-128.

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_Security_RadiusServerIPAddr()

int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_RadiusServerIPAddr ( HOSTIF_MsgData_t stMsgData)

Get the IP Address of the RADIUS server used for WLAN security. RadiusServerIPAddr is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise).

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_Security_RadiusServerPort()

int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_RadiusServerPort ( HOSTIF_MsgData_t stMsgData)

Get the port number of the RADIUS server used for WLAN security. RadiusServerPort is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise).

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_Security_RadiusSecret()

int hostIf_WiFi_AccessPoint_Security::get_hostIf_WiFi_AccessPoint_Security_RadiusSecret ( HOSTIF_MsgData_t stMsgData)

The secret used for handshaking with the RADIUS server [RFC2865]. When read, this parameter returns an empty string, regardless of the actual value.

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.