Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
_TlsContext Struct Reference
TLS context. More...
#include <tls.h>
Data Fields | |
| TlsState | state |
| TLS handshake finite state machine. | |
| TlsConnectionEnd | entity |
| Client or server operation. | |
| TlsIoHandle | handle |
| Handle for I/O operations. | |
| TlsIoSendCallback | sendCallback |
| Send callback function. | |
| TlsIoReceiveCallback | receiveCallback |
| Receive callback function. | |
| const PrngAlgo * | prngAlgo |
| Pseudo-random number generator to be used. | |
| void * | prngContext |
| Pseudo-random number generator context. | |
| const uint16_t * | cipherSuites |
| List of supported cipher suites. | |
| uint_t | numCipherSuites |
| Number of cipher suites in the list. | |
| char_t * | serverName |
| Fully qualified DNS hostname of the server. | |
| char_t * | protocolList |
| List of supported ALPN protocols. | |
| char_t * | psk |
| Pre-shared key. | |
| size_t | pskLen |
| Length of the pre-shared key, in bytes. | |
| char_t * | pskIdentity |
| PSK identity. | |
| char_t * | pskIdentityHint |
| PSK identity hint. | |
| TlsPskCallback | pskCallback |
| PSK callback function. | |
| DhContext | dhContext |
| Diffie-Hellman context. | |
| EcdhContext | ecdhContext |
| ECDH context. | |
| const char_t * | trustedCaList |
| List of trusted CA (PEM format) | |
| size_t | trustedCaListLen |
| Number of trusted CA in the list. | |
| TlsCertificateType | peerCertType |
| Peer's certificate type. | |
| RsaPublicKey | peerRsaPublicKey |
| Peer's RSA public key. | |
| DsaPublicKey | peerDsaPublicKey |
| Peer's DSA public key. | |
| EcDomainParameters | peerEcParams |
| Peer's EC domain parameters. | |
| EcPoint | peerEcPublicKey |
| Peer's EC public key. | |
| TlsCache * | cache |
| TLS session cache. | |
| uint8_t | sessionId [32] |
| Session identifier. | |
| size_t | sessionIdLen |
| Length of the session identifier. | |
| uint16_t | clientVersion |
| Latest version supported by the client. | |
| uint16_t | version |
| Negotiated TLS version. | |
| uint16_t | cipherSuite |
| Negotiated cipher suite. | |
| uint8_t | compressionMethod |
| Negotiated compression algorithm. | |
| uint16_t | namedCurve |
| Named curve. | |
| TlsHashAlgo | signHashAlgo |
| Hash algorithm used for signing. | |
| TlsKeyExchMethod | keyExchMethod |
| Key exchange method. | |
| const CipherAlgo * | cipherAlgo |
| Bulk cipher algorithm. | |
| CipherMode | cipherMode |
| Cipher mode of operation. | |
| const HashAlgo * | hashAlgo |
| Hash algorithm for MAC operations. | |
| const HashAlgo * | prfHashAlgo |
| Hash algorithm for PRF operations. | |
| size_t | macKeyLen |
| Number of bytes that are used for generating MAC keys. | |
| size_t | encKeyLen |
| Number of bytes that are used for generating encryption keys. | |
| size_t | fixedIvLen |
| Amount of data needed to be generated for the IV. | |
| size_t | recordIvLen |
| Length of the IV. | |
| size_t | authTagLen |
| Length of the authentication tag. | |
| size_t | verifyDataLen |
| Length of the verify data. | |
| Md5Context * | handshakeMd5Context |
| MD5 context used to compute verify data. | |
| Sha1Context * | handshakeSha1Context |
| SHA-1 context used to compute verify data. | |
| HashContext * | handshakeHashContext |
| Hash context used to compute verify data (TLS 1.2) | |
| uint8_t | verifyData [64] |
| Verify data. | |
| bool_t | ecPointFormatExtFound |
| The EcPointFormats extension has been received. | |
| TlsClientAuthMode | clientAuthMode |
| Client authentication mode. | |
| bool_t | clientCertRequested |
| This flag tells whether the client certificate is requested. | |
| bool_t | resume |
| The connection is established by resuming a session. | |
| bool_t | changeCipherSpecSent |
| A ChangeCipherSpec message has been sent. | |
| bool_t | changeCipherSpecReceived |
| A ChangeCipherSpec message has been received from the peer. | |
| bool_t | fatalAlertSent |
| A fatal alert message has been sent. | |
| bool_t | fatalAlertReceived |
| A fatal alert message has been received from the peer. | |
| bool_t | closeNotifySent |
| A closure alert has been sent. | |
| bool_t | closeNotifyReceived |
| A closure alert has been received from the peer. | |
| HmacContext | hmacContext |
| HMAC context. | |
| void * | writeCipherContext |
| Bulk cipher context for write operations. | |
| void * | readCipherContext |
| Bulk cipher context for read operations. | |
| GcmContext * | writeGcmContext |
| GCM context for write operations. | |
| GcmContext * | readGcmContext |
| GCM context for read operations. | |
| uint8_t * | txBuffer |
| TX buffer. | |
| size_t | txBufferSize |
| TX buffer size. | |
| TlsContentType | txBufferType |
| Type of data that resides in the TX buffer. | |
| size_t | txBufferLen |
| Number of bytes that are pending to be sent. | |
| size_t | txBufferPos |
| Current position in TX buffer. | |
| size_t | txRecordMaxLen |
| Maximum plaintext fragment length. | |
| size_t | txRecordLen |
| Length of the TLS record. | |
| size_t | txRecordPos |
| Current position in the TLS record. | |
| uint8_t * | rxBuffer |
| RX buffer. | |
| size_t | rxBufferSize |
| RX buffer size. | |
| TlsContentType | rxBufferType |
| Type of data that resides in the RX buffer. | |
| size_t | rxBufferLen |
| Number of bytes available for reading. | |
| size_t | rxBufferPos |
| Current position in RX buffer. | |
| size_t | rxRecordMaxLen |
| Maximum plaintext fragment length. | |
| size_t | rxRecordLen |
| Length of the TLS record. | |
| size_t | rxRecordPos |
| Current position in the TLS record. | |
| uint8_t | premasterSecret [TLS_MAX_PREMASTER_SECRET_SIZE] |
| Premaster secret. | |
| size_t | premasterSecretLen |
| Length of the premaster secret. | |
| uint8_t | masterSecret [48] |
| Master secret. | |
| uint8_t | keyBlock [192] |
| Key material. | |
| uint8_t * | writeMacKey |
| Write MAC key. | |
| uint8_t * | readMacKey |
| Read MAC key. | |
| uint8_t * | writeEncKey |
| Encryption key that serves for write operations. | |
| uint8_t * | readEncKey |
| Encryption key that serves for read operations. | |
| uint8_t * | writeIv |
| Write IV. | |
| uint8_t * | readIv |
| Read IV. | |
| TlsSequenceNumber | writeSeqNum |
| Write sequence number. | |
| TlsSequenceNumber | readSeqNum |
| Read sequence number. | |
| TlsRandom | clientRandom |
| Client random value. | |
| TlsRandom | serverRandom |
| Server random value. | |
Detailed Description
TLS context.
An opaque data structure that represents a TLS connection
Definition at line 1383 of file tls.h.
Field Documentation
| size_t authTagLen |
| bool_t changeCipherSpecReceived |
| bool_t changeCipherSpecSent |
| const CipherAlgo* cipherAlgo |
| uint16_t cipherSuite |
| const uint16_t* cipherSuites |
| bool_t clientCertRequested |
| TlsRandom clientRandom |
| uint16_t clientVersion |
| bool_t closeNotifyReceived |
| bool_t closeNotifySent |
| uint8_t compressionMethod |
| bool_t ecPointFormatExtFound |
| size_t encKeyLen |
| bool_t fatalAlertReceived |
| bool_t fatalAlertSent |
| size_t fixedIvLen |
| size_t macKeyLen |
| uint8_t masterSecret[48] |
| uint16_t namedCurve |
| uint_t numCipherSuites |
| uint8_t premasterSecret[TLS_MAX_PREMASTER_SECRET_SIZE] |
| size_t premasterSecretLen |
| const HashAlgo* prfHashAlgo |
| void* prngContext |
| char_t* protocolList |
| char_t* pskIdentity |
| char_t* pskIdentityHint |
| void* readCipherContext |
| uint8_t* readEncKey |
| uint8_t* readMacKey |
| size_t recordIvLen |
| bool_t resume |
| size_t rxBufferLen |
| size_t rxBufferPos |
| size_t rxBufferSize |
| size_t rxRecordLen |
| size_t rxRecordMaxLen |
| size_t rxRecordPos |
| char_t* serverName |
| TlsRandom serverRandom |
| size_t sessionIdLen |
| const char_t* trustedCaList |
| size_t trustedCaListLen |
| size_t txBufferLen |
| size_t txBufferPos |
| size_t txBufferSize |
| size_t txRecordLen |
| size_t txRecordMaxLen |
| size_t txRecordPos |
| uint8_t verifyData[64] |
| size_t verifyDataLen |
| void* writeCipherContext |
| uint8_t* writeEncKey |
| uint8_t* writeMacKey |
Generated on Tue Jul 12 2022 17:10:23 by
1.7.2