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

Description

This object contains security related parameters that apply to a WiFi End Point profile [802.11-2007].

int hostIf_WiFi_EndPoint_Profile_Security::get_hostIf_WiFi_EndPoint_Profile_Security_ModeEnabled (HOSTIF_MsgData_t *stMsgData)
 This function is used to get which security mode is enabled for wireless end point. The value MUST be a member of the list reported by the Security.ModesSupported parameter. More...
 
int hostIf_WiFi_EndPoint_Profile_Security::get_hostIf_WiFi_EndPoint_Profile_Security_WEPKey (HOSTIF_MsgData_t *stMsgData)
 Get a WEP key expressed as a hexadecimal string. More...
 
int hostIf_WiFi_EndPoint_Profile_Security::get_hostIf_WiFi_EndPoint_Profile_Security_PreSharedKey (HOSTIF_MsgData_t *stMsgData)
 Get a literal PreSharedKey (PSK) expressed as a hexadecimal string. More...
 
int hostIf_WiFi_EndPoint_Profile_Security::get_hostIf_WiFi_EndPoint_Profile_Security_KeyPassphrase (HOSTIF_MsgData_t *stMsgData)
 Get a passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes. More...
 

Function Documentation

◆ get_hostIf_WiFi_EndPoint_Profile_Security_ModeEnabled()

int hostIf_WiFi_EndPoint_Profile_Security::get_hostIf_WiFi_EndPoint_Profile_Security_ModeEnabled ( HOSTIF_MsgData_t stMsgData)

This function is used to get which security mode is enabled for wireless end point. The value MUST be a member of the list reported by the Security.ModesSupported parameter.

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

◆ get_hostIf_WiFi_EndPoint_Profile_Security_WEPKey()

int hostIf_WiFi_EndPoint_Profile_Security::get_hostIf_WiFi_EndPoint_Profile_Security_WEPKey ( HOSTIF_MsgData_t stMsgData)

Get 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.
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_EndPoint_Profile_Security_PreSharedKey()

int hostIf_WiFi_EndPoint_Profile_Security::get_hostIf_WiFi_EndPoint_Profile_Security_PreSharedKey ( HOSTIF_MsgData_t stMsgData)

Get 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.

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

◆ get_hostIf_WiFi_EndPoint_Profile_Security_KeyPassphrase()

int hostIf_WiFi_EndPoint_Profile_Security::get_hostIf_WiFi_EndPoint_Profile_Security_KeyPassphrase ( HOSTIF_MsgData_t stMsgData)

Get 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.