Tizen Native API
|
Functions | |
int | wifi_ap_set_eap_passphrase (wifi_ap_h ap, const char *user_name, const char *password) |
Sets the passphrase of EAP. | |
int | wifi_ap_get_eap_passphrase (wifi_ap_h ap, char **user_name, bool *is_password_set) |
Gets the passphrase of EAP. | |
int | wifi_ap_get_eap_ca_cert_file (wifi_ap_h ap, char **file) |
Gets the CA Certificate of EAP. | |
int | wifi_ap_set_eap_ca_cert_file (wifi_ap_h ap, const char *file) |
Sets the CA Certificate of EAP. | |
int | wifi_ap_get_eap_client_cert_file (wifi_ap_h ap, char **file) |
Gets the Client Certificate of EAP. | |
int | wifi_ap_set_eap_client_cert_file (wifi_ap_h ap, const char *file) |
Sets the CA Certificate of EAP. | |
int | wifi_ap_get_eap_private_key_file (wifi_ap_h ap, char **file) |
Gets the private key file of EAP. | |
int | wifi_ap_set_eap_private_key_info (wifi_ap_h ap, const char *file, const char *password) |
Sets the private key information of EAP. | |
int | wifi_ap_get_eap_type (wifi_ap_h ap, wifi_eap_type_e *type) |
Gets the EAP type of Wi-Fi. | |
int | wifi_ap_set_eap_type (wifi_ap_h ap, wifi_eap_type_e type) |
Sets the EAP type of Wi-Fi. | |
int | wifi_ap_get_eap_auth_type (wifi_ap_h ap, wifi_eap_auth_type_e *type) |
Gets the type of EAP phase2 authentication of Wi-Fi. | |
int | wifi_ap_set_eap_auth_type (wifi_ap_h ap, wifi_eap_auth_type_e type) |
Sets the type of EAP phase2 authentication of Wi-Fi. |
The EAP API provides functions for managing the EAP information.
Required Header
#include <wifi.h>
Overview
The EAP API provides functions for managing the EAP information. You can manage the EAP information using the functions.
Related Features
This API is related with the following features:
It is recommended to design feature related codes in your application for reliability.
You can check if a device supports the related features for this API by using System Information, thereby controlling the procedure of your application.
To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
More details on featuring your application can be found from Feature List.
Enumeration Type Documentation
enum wifi_eap_auth_type_e |
Enumeration for EAP phase2 authentication type.
- Since :
- 2.3
- Enumerator:
enum wifi_eap_type_e |
Function Documentation
int wifi_ap_get_eap_auth_type | ( | wifi_ap_h | ap, |
wifi_eap_auth_type_e * | type | ||
) |
Gets the type of EAP phase2 authentication of Wi-Fi.
- Since :
- 2.3
- Parameters:
-
[in] ap The access point handle [out] type The type of EAP phase2 authentication
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
WIFI_ERROR_NONE Successful WIFI_ERROR_INVALID_PARAMETER Invalid parameter WIFI_ERROR_INVALID_OPERATION Invalid operation WIFI_ERROR_OPERATION_FAILED Operation failed WIFI_ERROR_NOT_SUPPORTED Not supported
int wifi_ap_get_eap_ca_cert_file | ( | wifi_ap_h | ap, |
char ** | file | ||
) |
Gets the CA Certificate of EAP.
- Since :
- 2.3
- Remarks:
- This function is valid only if the EAP type is WIFI_EAP_TYPE_TLS. You must release file using free().
- Parameters:
-
[in] ap The access point handle [out] file The file path of CA Certificate
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
WIFI_ERROR_NONE Successful WIFI_ERROR_INVALID_PARAMETER Invalid parameter WIFI_ERROR_OUT_OF_MEMORY Out of memory WIFI_ERROR_INVALID_OPERATION Invalid operation WIFI_ERROR_NOT_SUPPORTED Not supported
int wifi_ap_get_eap_client_cert_file | ( | wifi_ap_h | ap, |
char ** | file | ||
) |
Gets the Client Certificate of EAP.
- Since :
- 2.3
- Remarks:
- This function is valid only if the EAP type is WIFI_EAP_TYPE_TLS. You must release file using free().
- Parameters:
-
[in] ap The access point handle [out] file The file path of Client Certificate
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
WIFI_ERROR_NONE Successful WIFI_ERROR_INVALID_PARAMETER Invalid parameter WIFI_ERROR_OUT_OF_MEMORY Out of memory WIFI_ERROR_INVALID_OPERATION Invalid operation WIFI_ERROR_NOT_SUPPORTED Not supported
int wifi_ap_get_eap_passphrase | ( | wifi_ap_h | ap, |
char ** | user_name, | ||
bool * | is_password_set | ||
) |
Gets the passphrase of EAP.
- Since :
- 2.3
- Remarks:
- This function is valid only if the EAP type is WIFI_EAP_TYPE_PEAP or WIFI_EAP_TYPE_TTLS. You must release user_name using free().
- Parameters:
-
[in] ap The access point handle [out] user_name The user name [out] is_password_set ture
if password is set, otherwiseflase
if password is not set.
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
WIFI_ERROR_NONE Successful WIFI_ERROR_INVALID_PARAMETER Invalid parameter WIFI_ERROR_OUT_OF_MEMORY Out of memory WIFI_ERROR_INVALID_OPERATION Invalid operation WIFI_ERROR_NOT_SUPPORTED Not supported
int wifi_ap_get_eap_private_key_file | ( | wifi_ap_h | ap, |
char ** | file | ||
) |
Gets the private key file of EAP.
- Since :
- 2.3
- Remarks:
- This function is valid only if the EAP type is WIFI_EAP_TYPE_TLS. You must release file using free().
- Parameters:
-
[in] ap The access point handle [out] file The file path of private key
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
WIFI_ERROR_NONE Successful WIFI_ERROR_INVALID_PARAMETER Invalid parameter WIFI_ERROR_OUT_OF_MEMORY Out of memory WIFI_ERROR_INVALID_OPERATION Invalid operation WIFI_ERROR_NOT_SUPPORTED Not supported
int wifi_ap_get_eap_type | ( | wifi_ap_h | ap, |
wifi_eap_type_e * | type | ||
) |
Gets the EAP type of Wi-Fi.
- Since :
- 2.3
- Parameters:
-
[in] ap The access point handle [out] type The type of EAP
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
WIFI_ERROR_NONE Successful WIFI_ERROR_INVALID_PARAMETER Invalid parameter WIFI_ERROR_INVALID_OPERATION Invalid operation WIFI_ERROR_OPERATION_FAILED Operation failed WIFI_ERROR_NOT_SUPPORTED Not supported
int wifi_ap_set_eap_auth_type | ( | wifi_ap_h | ap, |
wifi_eap_auth_type_e | type | ||
) |
Sets the type of EAP phase2 authentication of Wi-Fi.
- Since :
- 2.3
- Parameters:
-
[in] ap The access point handle [in] type The type of EAP phase2 authentication
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
WIFI_ERROR_NONE Successful WIFI_ERROR_INVALID_PARAMETER Invalid parameter WIFI_ERROR_INVALID_OPERATION Invalid operation WIFI_ERROR_NOT_SUPPORTED Not supported
int wifi_ap_set_eap_ca_cert_file | ( | wifi_ap_h | ap, |
const char * | file | ||
) |
Sets the CA Certificate of EAP.
- Since :
- 2.3
- Remarks:
- This function is valid only if the EAP type is WIFI_EAP_TYPE_TLS.
- Parameters:
-
[in] ap The access point handle [in] file The file path of CA Certificate
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
WIFI_ERROR_NONE Successful WIFI_ERROR_INVALID_PARAMETER Invalid parameter WIFI_ERROR_INVALID_OPERATION Invalid operation WIFI_ERROR_NOT_SUPPORTED Not supported
int wifi_ap_set_eap_client_cert_file | ( | wifi_ap_h | ap, |
const char * | file | ||
) |
Sets the CA Certificate of EAP.
- Since :
- 2.3
- Remarks:
- This function is valid only if the EAP type is WIFI_EAP_TYPE_TLS.
- Parameters:
-
[in] ap The access point handle [in] file The file path of Client Certificate
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
WIFI_ERROR_NONE Successful WIFI_ERROR_INVALID_PARAMETER Invalid parameter WIFI_ERROR_INVALID_OPERATION Invalid operation WIFI_ERROR_NOT_SUPPORTED Not supported
int wifi_ap_set_eap_passphrase | ( | wifi_ap_h | ap, |
const char * | user_name, | ||
const char * | password | ||
) |
Sets the passphrase of EAP.
You can set one of user_name and password as NULL
. In this case, the value of a parameter which is set as NULL
will be the previous value. But it is not allowed that both user_name and password are set as NULL
.
- Since :
- 2.3
- Remarks:
- This function is valid only if the EAP type is WIFI_EAP_TYPE_PEAP or WIFI_EAP_TYPE_TTLS.
- Parameters:
-
[in] ap The access point handle [in] user_name The user name
This value can beNULL
.[in] password The password
This value can beNULL
.
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
WIFI_ERROR_NONE Successful WIFI_ERROR_INVALID_PARAMETER Invalid parameter WIFI_ERROR_INVALID_OPERATION Invalid operation WIFI_ERROR_NOT_SUPPORTED Not supported
int wifi_ap_set_eap_private_key_info | ( | wifi_ap_h | ap, |
const char * | file, | ||
const char * | password | ||
) |
Sets the private key information of EAP.
- Since :
- 2.3
- Remarks:
- This function is valid only if the EAP type is WIFI_EAP_TYPE_TLS.
- Parameters:
-
[in] ap The access point handle [in] file The file path of private key [in] password The password
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
WIFI_ERROR_NONE Successful WIFI_ERROR_INVALID_PARAMETER Invalid parameter WIFI_ERROR_INVALID_OPERATION Invalid operation WIFI_ERROR_NOT_SUPPORTED Not supported
int wifi_ap_set_eap_type | ( | wifi_ap_h | ap, |
wifi_eap_type_e | type | ||
) |
Sets the EAP type of Wi-Fi.
- Since :
- 2.3
- Parameters:
-
[in] ap The access point handle [in] type The type of EAP
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
WIFI_ERROR_NONE Successful WIFI_ERROR_INVALID_PARAMETER Invalid parameter WIFI_ERROR_INVALID_OPERATION Invalid operation WIFI_ERROR_NOT_SUPPORTED Not supported