Tizen Native API
EAP

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:

Functions

int wifi_ap_set_eap_passphrase (wifi_ap_h ap, const char *user_name, const char *password) TIZEN_DEPRECATED_API
 Sets the passphrase of EAP.
int wifi_ap_get_eap_passphrase (wifi_ap_h ap, char **user_name, bool *is_password_set) TIZEN_DEPRECATED_API
 Gets the passphrase of EAP.
int wifi_ap_get_eap_ca_cert_file (wifi_ap_h ap, char **file) TIZEN_DEPRECATED_API
 Gets the CA Certificate of EAP.
int wifi_ap_set_eap_ca_cert_file (wifi_ap_h ap, const char *file) TIZEN_DEPRECATED_API
 Sets the CA Certificate of EAP.
int wifi_ap_get_eap_client_cert_file (wifi_ap_h ap, char **file) TIZEN_DEPRECATED_API
 Gets the Client Certificate of EAP.
int wifi_ap_set_eap_client_cert_file (wifi_ap_h ap, const char *file) TIZEN_DEPRECATED_API
 Sets the CA Certificate of EAP.
int wifi_ap_get_eap_private_key_file (wifi_ap_h ap, char **file) TIZEN_DEPRECATED_API
 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) TIZEN_DEPRECATED_API
 Sets the private key information of EAP.
int wifi_ap_get_eap_type (wifi_ap_h ap, wifi_eap_type_e *type) TIZEN_DEPRECATED_API
 Gets the EAP type of Wi-Fi.
int wifi_ap_set_eap_type (wifi_ap_h ap, wifi_eap_type_e type) TIZEN_DEPRECATED_API
 Sets the EAP type of Wi-Fi.
int wifi_ap_get_eap_auth_type (wifi_ap_h ap, wifi_eap_auth_type_e *type) TIZEN_DEPRECATED_API
 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) TIZEN_DEPRECATED_API
 Sets the type of EAP phase2 authentication of Wi-Fi.

Enumeration Type Documentation

Enumeration for EAP phase2 authentication type.

Deprecated:
Deprecated since 3.0. Use wifi_manager_eap_auth_type_e instead.
Since :
2.3
Enumerator:
WIFI_EAP_AUTH_TYPE_NONE 

EAP phase2 authentication none

WIFI_EAP_AUTH_TYPE_PAP 

EAP phase2 authentication PAP

WIFI_EAP_AUTH_TYPE_MSCHAP 

EAP phase2 authentication MSCHAP

WIFI_EAP_AUTH_TYPE_MSCHAPV2 

EAP phase2 authentication MSCHAPv2

WIFI_EAP_AUTH_TYPE_GTC 

EAP phase2 authentication GTC

WIFI_EAP_AUTH_TYPE_MD5 

EAP phase2 authentication MD5

Enumeration for EAP type.

Deprecated:
Deprecated since 3.0. Use wifi_manager_eap_type_e instead.
Since :
2.3
Enumerator:
WIFI_EAP_TYPE_PEAP 

EAP PEAP type

WIFI_EAP_TYPE_TLS 

EAP TLS type

WIFI_EAP_TYPE_TTLS 

EAP TTLS type

WIFI_EAP_TYPE_SIM 

EAP SIM type

WIFI_EAP_TYPE_AKA 

EAP AKA type


Function Documentation

Gets the type of EAP phase2 authentication of Wi-Fi.

Deprecated:
Deprecated since 3.0. Use wifi_manager_ap_get_eap_auth_type() instead.
Since :
2.3
Parameters:
[in]apThe access point handle
[out]typeThe type of EAP phase2 authentication
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_ERROR_NONESuccessful
WIFI_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_ERROR_INVALID_OPERATIONInvalid operation
WIFI_ERROR_OPERATION_FAILEDOperation failed
WIFI_ERROR_NOT_SUPPORTEDNot supported
int wifi_ap_get_eap_ca_cert_file ( wifi_ap_h  ap,
char **  file 
)

Gets the CA Certificate of EAP.

Deprecated:
Deprecated since 3.0. Use wifi_manager_ap_get_eap_ca_cert_file() instead.
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]apThe access point handle
[out]fileThe file path of CA Certificate
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_ERROR_NONESuccessful
WIFI_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_ERROR_OUT_OF_MEMORYOut of memory
WIFI_ERROR_INVALID_OPERATIONInvalid operation
WIFI_ERROR_NOT_SUPPORTEDNot supported
int wifi_ap_get_eap_client_cert_file ( wifi_ap_h  ap,
char **  file 
)

Gets the Client Certificate of EAP.

Deprecated:
Deprecated since 3.0. Use wifi_manager_ap_get_eap_client_cert_file() instead.
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]apThe access point handle
[out]fileThe file path of Client Certificate
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_ERROR_NONESuccessful
WIFI_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_ERROR_OUT_OF_MEMORYOut of memory
WIFI_ERROR_INVALID_OPERATIONInvalid operation
WIFI_ERROR_NOT_SUPPORTEDNot supported
int wifi_ap_get_eap_passphrase ( wifi_ap_h  ap,
char **  user_name,
bool *  is_password_set 
)

Gets the passphrase of EAP.

Deprecated:
Deprecated since 3.0. Use wifi_manager_ap_get_eap_passphrase() instead.
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]apThe access point handle
[out]user_nameThe user name
[out]is_password_setture if password is set, otherwise flase if password is not set.
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_ERROR_NONESuccessful
WIFI_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_ERROR_OUT_OF_MEMORYOut of memory
WIFI_ERROR_INVALID_OPERATIONInvalid operation
WIFI_ERROR_NOT_SUPPORTEDNot supported
int wifi_ap_get_eap_private_key_file ( wifi_ap_h  ap,
char **  file 
)

Gets the private key file of EAP.

Deprecated:
Deprecated since 3.0. Use wifi_manager_ap_get_eap_private_key_file() instead.
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]apThe access point handle
[out]fileThe file path of private key
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_ERROR_NONESuccessful
WIFI_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_ERROR_OUT_OF_MEMORYOut of memory
WIFI_ERROR_INVALID_OPERATIONInvalid operation
WIFI_ERROR_NOT_SUPPORTEDNot supported

Gets the EAP type of Wi-Fi.

Deprecated:
Deprecated since 3.0. Use wifi_manager_ap_get_eap_type() instead.
Since :
2.3
Parameters:
[in]apThe access point handle
[out]typeThe type of EAP
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_ERROR_NONESuccessful
WIFI_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_ERROR_INVALID_OPERATIONInvalid operation
WIFI_ERROR_OPERATION_FAILEDOperation failed
WIFI_ERROR_NOT_SUPPORTEDNot supported

Sets the type of EAP phase2 authentication of Wi-Fi.

Deprecated:
Deprecated since 3.0. Use wifi_manager_ap_set_eap_auth_type() instead.
Since :
2.3
Parameters:
[in]apThe access point handle
[in]typeThe type of EAP phase2 authentication
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_ERROR_NONESuccessful
WIFI_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_ERROR_INVALID_OPERATIONInvalid operation
WIFI_ERROR_NOT_SUPPORTEDNot supported
int wifi_ap_set_eap_ca_cert_file ( wifi_ap_h  ap,
const char *  file 
)

Sets the CA Certificate of EAP.

Deprecated:
Deprecated since 3.0. Use wifi_manager_ap_set_eap_ca_cert_file() instead.
Since :
2.3
Remarks:
This function is valid only if the EAP type is WIFI_EAP_TYPE_TLS.
Parameters:
[in]apThe access point handle
[in]fileThe file path of CA Certificate
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_ERROR_NONESuccessful
WIFI_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_ERROR_INVALID_OPERATIONInvalid operation
WIFI_ERROR_NOT_SUPPORTEDNot supported
int wifi_ap_set_eap_client_cert_file ( wifi_ap_h  ap,
const char *  file 
)

Sets the CA Certificate of EAP.

Deprecated:
Deprecated since 3.0. Use wifi_manager_ap_set_eap_client_cert_file() instead.
Since :
2.3
Remarks:
This function is valid only if the EAP type is WIFI_EAP_TYPE_TLS.
Parameters:
[in]apThe access point handle
[in]fileThe file path of Client Certificate
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_ERROR_NONESuccessful
WIFI_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_ERROR_INVALID_OPERATIONInvalid operation
WIFI_ERROR_NOT_SUPPORTEDNot supported
int wifi_ap_set_eap_passphrase ( wifi_ap_h  ap,
const char *  user_name,
const char *  password 
)

Sets the passphrase of EAP.

Deprecated:
Deprecated since 3.0. Use wifi_manager_ap_set_eap_passphrase() instead.

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]apThe access point handle
[in]user_nameThe user name
This value can be NULL.
[in]passwordThe password
This value can be NULL.
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_ERROR_NONESuccessful
WIFI_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_ERROR_INVALID_OPERATIONInvalid operation
WIFI_ERROR_NOT_SUPPORTEDNot 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.

Deprecated:
Deprecated since 3.0. Use wifi_manager_ap_set_eap_private_key_info() instead.
Since :
2.3
Remarks:
This function is valid only if the EAP type is WIFI_EAP_TYPE_TLS.
Parameters:
[in]apThe access point handle
[in]fileThe file path of private key
[in]passwordThe password
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_ERROR_NONESuccessful
WIFI_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_ERROR_INVALID_OPERATIONInvalid operation
WIFI_ERROR_NOT_SUPPORTEDNot supported

Sets the EAP type of Wi-Fi.

Deprecated:
Deprecated since 3.0. Use wifi_manager_ap_set_eap_type() instead.
Since :
2.3
Parameters:
[in]apThe access point handle
[in]typeThe type of EAP
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_ERROR_NONESuccessful
WIFI_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_ERROR_INVALID_OPERATIONInvalid operation
WIFI_ERROR_NOT_SUPPORTEDNot supported