Functions | |
VOID | CuCmd_SetPrivacyAuth (THandle hCuCmd, ConParm_t parm[], U16 nParms) |
Modifies the authentication type. | |
VOID | CuCmd_SetPrivacyEap (THandle hCuCmd, ConParm_t parm[], U16 nParms) |
Modifies the EAP protocol. | |
VOID | CuCmd_SetPrivacyEncryption (THandle hCuCmd, ConParm_t parm[], U16 nParms) |
Modifies the encryption type. | |
VOID | CuCmd_SetPrivacyKeyType (THandle hCuCmd, ConParm_t parm[], U16 nParms) |
Modifies the key type. | |
VOID | CuCmd_SetPrivacyMixedMode (THandle hCuCmd, ConParm_t parm[], U16 nParms) |
Modifies the mixed mode. | |
VOID | CuCmd_SetPrivacyAnyWpaMode (THandle hCuCmd, ConParm_t parm[], U16 nParms) |
Modifies the Any WPA mode. | |
VOID | CuCmd_SetPrivacyCredentials (THandle hCuCmd, ConParm_t parm[], U16 nParms) |
Modifies the privacy credentials. | |
VOID | CuCmd_SetPrivacyPskPassPhrase (THandle hCuCmd, ConParm_t parm[], U16 nParms) |
Modifies the private shared key (PSK). | |
VOID | CuCmd_SetPrivacyCertificate (THandle hCuCmd, ConParm_t parm[], U16 nParms) |
Modifies the certificate path. | |
VOID | CuCmd_StopSuppl (THandle hCuCmd, ConParm_t parm[], U16 nParms) |
Stops the supplicant. | |
VOID | CuCmd_ChangeSupplDebugLevels (THandle hCuCmd, ConParm_t parm[], U16 nParms) |
Modifies the supplicant debug levels. | |
VOID | CuCmd_AddPrivacyKey (THandle hCuCmd, ConParm_t parm[], U16 nParms) |
Modifies the WEP key. | |
VOID | CuCmd_RemovePrivacyKey (THandle hCuCmd, ConParm_t parm[], U16 nParms) |
Removes the WEP key. | |
VOID | CuCmd_GetPrivacyDefaultKey (THandle hCuCmd, ConParm_t parm[], U16 nParms) |
Shows the WEP default key ID. |
VOID CuCmd_AddPrivacyKey | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Modifies the WEP key.
This function configures a static WEP key. This key is used for data encryption when the authentication type is a legacy one (open system, shared key or auto switch).
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The WEP key (0 - 64 characters; default = empty. If hex format is chosen, the length must be even). parm[1] The key index (0 3; default = 0). A maximum of four keys can be configured. The AP can encrypt data in each of the four configured keys. The key ID used by the AP for the frame encryption is indicated in the frames clear part. The station uses this ID indication in order to choose the correct key to decrypt the frame. parm[2] Default key (0 1; default = 0). If 0, this key is used only for decrypting data received from the AP. If 1, this key is used both for decrypting data received from the AP and for encrypting data sent to the AP. parm[3] If nParms equals 3, then this value is empty. By default, the key format is set to hex. If nParms equals 4, it represents the key format (a five-character string having the values "hex" or "text"; default = "hex"). |
[in] | nParms | The number of parameters, which can be one of the following: 3 - No key format is given. The key is configured on the supplicant in hex format. 4 - A key format is given. The key is configured on the supplicant in the given format. |
VOID CuCmd_ChangeSupplDebugLevels | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Modifies the supplicant debug levels.
This function configures the supplicant debug level.
The supplicant has its own function that prints debug messages to the screen.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The debug level (0 4; default = 0) The level can have one of the following values: 0 - MSG_MSGDUMP; all supplicant messages are printed. 1 - MSG_DEBUG; only messages from the level DEBUG and up are printed. 2 - MSG_INFO; only messages from the level INFORMATION and up are printed. 3 - MSG_WARNING; only messages from the level WARNING and up are printed. 4 - MSG_ERROR; only messages from the level ERROR are printed. parm[1] Defines whether the keys and password are printed (0 1; default = 0). If 1, the keys and passwords are printed by the supplicant. parm[2] Defines whether the print messages are preceded with a timestamp (0 1;, default = 0). If 1, the print messages are preceded by a timestamp. |
[in] | nParms | Always 3 |
VOID CuCmd_GetPrivacyDefaultKey | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Shows the WEP default key ID.
This function gets the WEP default key ID and prints it.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] Not used; should be 0 |
[in] | nParms | Not used; should be 0 |
VOID CuCmd_RemovePrivacyKey | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Removes the WEP key.
This function removes a previously configured WEP key. This key is no longer used for data encryption / decryption.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The key index (0 3; default = 0) The AP can encrypt data in each of the four configured keys. The key ID used by the AP for the frame encryption is indicated in the frames clear part. The station uses this ID indication in order to choose the correct key to decrypt the frame. |
[in] | nParms | Always 1 |
VOID CuCmd_SetPrivacyAnyWpaMode | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Modifies the Any WPA mode.
This function configures the Any WPA mode.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The Any WPA mode (0 1; default 0). Any WPA mode can have one of the following values: 0 - Any WPA mode is disabled. The station does not associate to an AP that supports both WPA and WPA2, if the station supports only WPA or WPA2. 1 - Any WPA mode is enabled. The station associates to an AP that supports both WPA and WPA2, if the station supports only WPA or WPA2. |
[in] | nParms | The number of parameters, which can be one of the following: 0 - No Any WPA mode is given. The function prints the available Any WPA mode values and the currently configured Any WPA mode. 1 - The Any WPA mode is configured. |
VOID CuCmd_SetPrivacyAuth | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Modifies the authentication type.
This function configures the authentication type. The authentication is performed between the station and the AP or between the station and the RADIUS server. The station may only receive and transmit data from / to the AP if authentication is successful. There are three ways to obtain these keys:
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The authentication type (0 7; default = 0). The following authentication types can be configured: 0 - 802.11 legacy open-system authentication. 1 - 802.11 legacy shared-key authentication. 2 - 802.11 legacy open-system and shared-key authentication are supported. 3 - WPA authentication using a RADIUS server with key management (used only when a supplicant is loaded). 4 - WPA authentication using a pre-shared key with key management (used only when a supplicant is loaded). 6 - WPA2 authentication using a RADIUS server with key management (used only when a supplicant is loaded). 7 - WPA2 authentication using a pre-shared key with key management (used only when a supplicant is loaded). |
[in] | nParms | The number of parameters, which can be one of the following: 0 - No authentication type is given. The function prints the available authentication type values and the current authentication type configured. 1 - The authentication type is configured. |
VOID CuCmd_SetPrivacyCertificate | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Modifies the certificate path.
This function configures the certificate path.
The certificate is sent to the RADIUS server in the authentication process, if the authentication method is certificate-based.
They RADIUS server uses the certificate received from the station to validate the station's identity.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The certificate path (0 - 32 characters; default = empty). The certificate file should be placed in this location. |
[in] | nParms | Always 1 |
VOID CuCmd_SetPrivacyCredentials | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Modifies the privacy credentials.
This function configures the privacy credentials. The credentials are the user name and password used in the authentication process with the RADIUS server.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The user name (0 - 32 characters). This user name is sent to the RADIUS server in the authentication process. parm[1] If nParms equals 1, then this value is empty. If nParms equals 2, this value represents the password (0 - 32 characters). The station uses this password to prove its identity to the RADIUS server in the authentication process. |
[in] | nParms | The number of parameters, which can be one of the following: 1 - Only a user name is given. This user name is configured on the supplicant. 2 - A user name and password are given. Both are configured on the supplicant. |
VOID CuCmd_SetPrivacyEap | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Modifies the EAP protocol.
This function configures the EAP protocol. The EAP protocol is used in WPA / WPA2 authentication phases when working with a RADIUS server. This function should be called only when working with a supplicant.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The EAP protocol (0 9; default = 0). The following EAP protocol types can be configured: 0 - None 1 - MD5 challenge 2 - Generic token card 3 - TLS 4 - LEAP 5 - TTLS 6 - PEAP 7 - MS CHAP V2 8 - FAST |
[in] | nParms | The number of parameters, which can be one of the following: 0 - No EAP protocol is given. The function prints the available EAP protocol values. 1 - The EAP protocol is configured. |
VOID CuCmd_SetPrivacyEncryption | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Modifies the encryption type.
This function configures the encryption type. The encryption type is the cipher suite used to encrypt the transmitted data.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The encryption type (0 - 3;, default = 0). The following encryption types can be configured: 0 - None 1 - WEP 2 - TKIP (used only when a supplicant is loaded) 3 - AES (used only when a supplicant is loaded) |
[in] | nParms | The number of parameters, which can be one of the following: 0 - No encryption type is given. The function prints the available encryption type values and the currently configured encryption type. 1 - The encryption type is configured. |
VOID CuCmd_SetPrivacyKeyType | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Modifies the key type.
This function configures the key type.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The key type (0 1; default = 0). The following key types can be configured: 0 - Static. The keys are fixed in advance and do not change during the run. 1 - Dynamic. The keys are generated / delivered to the station on the fly. |
[in] | nParms | The number of parameters, which can be one of the following: 0 - No key type is given. The function prints the available key type values and the currently configured key type. 1 - The key type is configured. |
VOID CuCmd_SetPrivacyMixedMode | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Modifies the mixed mode.
This function configures the mixed mode.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The mixed mode (0 1; default = 0). Mixed mode can have one of the following values: 0 - Mixed mode is disabled. The station only associates an AP that has a privacy bit (sent in beacons and probe responses) that matches the station privacy status. 1 - Mixed mode is enabled. The station also associates an AP that has a privacy bit (sent in beacons and probe responses) that does not match the station privacy status, if the AP supports the station's privacy configuration. |
[in] | nParms | The number of parameters, which can be one of the following: 0 - No mixed mode is given. The function prints the available mixed mode values and the currently configured mixed mode. 1 - The mixed mode is configured. |
VOID CuCmd_SetPrivacyPskPassPhrase | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Modifies the private shared key (PSK).
This function configures the PSK.
The PSK is used when no authentication with the RADIUS server takes place, and only key distribution is performed.
In this case, both the AP and the station are configured with the same PSK. They use the PSK for secure derivation and distribution of the keys used for data encryption.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The pre-shared key (8 - 64 characters; default = empty. If hex format is chosen, the length must be 64). This pre-shared key is configured on the AP too. parm[1] If nParms equals 1, then this value is empty. The key format is set to text by default. If nParms equals 2, this value represents the key format (a five-character string having the values "hex" or "text"; default = "text"). |
[in] | nParms | The number of parameters, which can be one of the following: 1 - Only a key is given. The key is configured on the supplicant in text format. 2 - A key and format are given. The key is configured on the supplicant in the given format. |
VOID CuCmd_StopSuppl | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Stops the supplicant.
This function terminates the supplicant process.
[in] | hCuCmd | Handle for the command module |
[in] | parm | Not used; should be 0 |
[in] | nParms | Not used; should be 0 |