Microchip® Advanced Software Framework

tstrAuth1xTls Struct Reference

#include <m2m_wifi.h>

Data Fields

bool bPrependDomain
 
bool bUnencryptedUserName
 
uint8pu8Certificate
 
uint8pu8Domain
 
uint8pu8PrivateKey_Exp
 
uint8pu8PrivateKey_Mod
 
uint8pu8UserName
 
uint16 u16CertificateLen
 
uint16 u16DomainLen
 
uint16 u16PrivateKeyLen
 
uint16 u16UserNameLen
 

bool tstrAuth1xTls::bPrependDomain

Determines whether Domain is prepended or appended to UserName in EAP identity responses. true: Domain is prepended to UserName - [Domain][UserName]. false: Domain is appended to UserName - [UserName][Domain].

Referenced by m2m_wifi_connect_1x_tls().

bool tstrAuth1xTls::bUnencryptedUserName

Determines whether UserName or "anonymous" is sent (unencrypted) in the initial EAP identity response. Domain is sent in both cases.
true: UserName is sent in the initial EAP identity response (required for EAP-TLS). false: "anonymous" is sent in the initial EAP identity response. This setting is recommended for tunneled methods such as EAP-PEAP/TLS.

Referenced by m2m_wifi_connect_1x_tls().

uint8* tstrAuth1xTls::pu8Certificate

Pointer to TLS client certificate corresponding to PrivateKey. This will be used during TLS client authentication.

Referenced by m2m_wifi_connect_1x_tls().

uint8* tstrAuth1xTls::pu8Domain

Pointer to Domain of authentication server (printable ASCII), including '@' or '\' separator character as appropriate. Use NULL if there is no domain information. The Domain will be either prepended or appended to the UserName, depending on the setting of field bPrependDomain.
Example 1: if [Domain] is "@my_domain" and bPrependDomain is false, then the EAP identity response is "[UserName]@my_domain".
Example 2: if [Domain] is "my_domain\" and bPrependDomain is true, then the EAP identity response is "my_domain\[UserName]".

Referenced by m2m_wifi_connect_1x_tls().

uint8* tstrAuth1xTls::pu8PrivateKey_Exp

Pointer to PrivateKey exponent (raw data). This will be used during TLS client authentication.

Referenced by m2m_wifi_connect_1x_tls().

uint8* tstrAuth1xTls::pu8PrivateKey_Mod

Pointer to PrivateKey modulus (raw data). This will be used during TLS client authentication.

Referenced by m2m_wifi_connect_1x_tls().

uint8* tstrAuth1xTls::pu8UserName

Pointer to UserName (ASCII). This will be sent (encrypted) in the tunneled EAP identity response. If bUnencryptedUserName is true then it will also be sent (unencrypted) in the initial EAP identity response.

Referenced by m2m_wifi_connect_1x_tls().

uint16 tstrAuth1xTls::u16CertificateLen

Length of Certificate (in bytes). Permitted values are between 0 and M2M_AUTH_1X_CERT_LEN_MAX.

Referenced by m2m_wifi_connect_1x_tls().

uint16 tstrAuth1xTls::u16DomainLen

Length of Domain (in ASCII characters), including '@' or '\' separator character as appropriate. Permitted values are such that u16DomainLen + u16UserNameLen is between 0 and M2M_AUTH_1X_USER_LEN_MAX.

Referenced by m2m_wifi_connect_1x_tls().

uint16 tstrAuth1xTls::u16PrivateKeyLen

Length of PrivateKey_Mod (in bytes). Permitted values are between 0 and M2M_AUTH_1X_PRIVATEKEY_LEN_MAX, typically 128 or 256. PrivateKey_Exp must be the same length as modulus, pre-padded with 0s if necessary.

Referenced by m2m_wifi_connect_1x_tls().

uint16 tstrAuth1xTls::u16UserNameLen

Length of UserName (in ASCII characters). Permitted values are such that u16DomainLen + u16UserNameLen is between 0 and M2M_AUTH_1X_USER_LEN_MAX.

Referenced by m2m_wifi_connect_1x_tls().