tfEapGetOption
Table of Contents >> Optional Protocols >> PPP Interface
#include <trsocket.h> |
int tfEapGetOption | ( |
ttUserInterface interfaceHandle, | |
int optionName, | |
char TM_FAR * optionValuePtr, | |
int TM_FAR * optionLengthPtr | |
); |
Function Description
This function retrieves the EAP data described in the table below. See tfEapSetOption() for further discussion.
Parameters
- interfaceHandle
- The interface handle to set the option on.
- optionName
- Name of the option. (See below.)
- optionValuePtr
- Storage for the option value. May be NULL, if all you seek is the length (set *optionLengthPtr = 0 on input). (See below.)
- optionLengthPtr
- Length of the storage on input. Length of the option on output.(See below.)
Group | Option Name | Type/Length | Meaning |
---|---|---|---|
EAP‑TLS method | TM_EAPTLS_TIMEOUT | int | (Authenticator only) Get the remaining retransmission interval (seconds). |
TM_EAPTLS_RETRIES | int | (Authenticator only) Get the remaining retransmission downcount. | |
TM_EAPTLS_SESSION_INDEX | int | This is the value returned by tfSslNewSession(). It defines the TLS parameters to be used (cipher suites, certificates and other TLS options). Treck uses the term session ID to describe this value. | |
TM_EAPTLS_SESSION_BYTES | 0 - 32 bytes | From 0 to 32 random bytes supplied by the server during the TLS handshake and saved. The value may be used to shorten a subsequent TLS handshake with the same server if the server caches the session parameters. This is the Resume feature specified in the TLS/SSL RFCs. The TLS/SSL specification uses the term session identifier to describe this value. | |
TM_EAPTLS_TLS_ERROR | int | The last error code set during Treck TLS handshake processing. | |
TM_EAPTLS_KEY_SESSION_ID | variable | The EAP-TLS specification uses the term Session-Id to describe this value. It is binary data derived from the client and server nonces used in the TLS handshake. | |
TM_EAPTLS_CERT_PEER_ID | variable | The EAP-TLS specification uses the term peer identity or Peer-Id to describe this value. It is ASN.1 encoded data extracted from the peer certificate used in the TLS handshake. | |
TM_EAPTLS_CERT_SERVER_ID | variable | The EAP-TLS specification uses the term server identity or Server-Id to describe this value. It is ASN.1 encoded data extracted from the server certificate used in the TLS handshake. | |
TM_EAPTLS_MSK_BYTES | variable | The Master Session Key (MSK) exported from the EAP-TLS method (described in section 2.3 of RFC 5216, EAP-TLS, and in RFC 5247, EAP Key Management Framework). By default, the length is 64 bytes but you may tfEapSetOption() any non-negative length.
This option will return an error if you define TM_DISABLE_EAPTLS_KEY_GEN in trsystem.h. | |
TM_EAPTLS_EMSK_BYTES | variable | The Extended Master Session Key (EMSK) exported from the EAP-TLS method (described in section 2.3 of RFC 5216, EAP-TLS, and in RFC 5247, EAP Key Management Framework). By default, the length is 64 bytes but you may tfEapSetOption() any non-negative length.
This option will return an error if you define TM_DISABLE_EAPTLS_KEY_GEN in trsystem.h. | |
TM_EAPTLS_IV_BYTES | variable | The cipher Initialization Vector (IV) exported from the EAP-TLS method (described in section 2.3 of RFC 5216, EAP-TLS, and in RFC 5247, EAP Key Management Framework). By default, the length is 64 bytes but you may tfEapSetOption() any non-negative length.
This option will return an error if you define TM_DISABLE_EAPTLS_KEY_GEN in trsystem.h. |
Returns
- TM_ENOERROR
- Success.
- TM_EINVAL
- Invalid parameter.
- TM_ENOPROTOOPT
- The device does not support EAP.