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.
tls_record.h File Reference
TLS record protocol. More...
Go to the source code of this file.
Functions | |
| error_t | tlsWriteProtocolData (TlsContext *context, const void *data, size_t length, TlsContentType contentType) |
| Write protocol data. | |
| error_t | tlsReadProtocolData (TlsContext *context, void **data, size_t *length, TlsContentType *contentType) |
| Read protocol data. | |
| error_t | tlsWriteRecord (TlsContext *context, const uint8_t *data, size_t length, TlsContentType contentType) |
| Send a TLS record. | |
| error_t | tlsReadRecord (TlsContext *context, uint8_t *data, size_t size, size_t *length, TlsContentType *contentType) |
| Receive a TLS record. | |
| error_t | tlsEncryptRecord (TlsContext *context, TlsRecord *record) |
| Encrypt an outgoing TLS record. | |
| error_t | tlsDecryptRecord (TlsContext *context, TlsRecord *record) |
| Decrypt an incoming TLS record. | |
| void | tlsIncSequenceNumber (TlsSequenceNumber seqNum) |
| Increment sequence number. | |
Detailed Description
TLS record protocol.
License
Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.
This file is part of CycloneSSL Open.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- Version:
- 1.7.6
Definition in file tls_record.h.
Function Documentation
| error_t tlsDecryptRecord | ( | TlsContext * | context, |
| TlsRecord * | record | ||
| ) |
Decrypt an incoming TLS record.
- Parameters:
-
[in] context Pointer to the TLS context [in,out] record TLS record to be decrypted
- Returns:
- Error code
Definition at line 844 of file tls_record.c.
| error_t tlsEncryptRecord | ( | TlsContext * | context, |
| TlsRecord * | record | ||
| ) |
Encrypt an outgoing TLS record.
- Parameters:
-
[in] context Pointer to the TLS context [in,out] record TLS record to be encrypted
- Returns:
- Error code
Definition at line 566 of file tls_record.c.
| void tlsIncSequenceNumber | ( | TlsSequenceNumber | seqNum ) |
Increment sequence number.
- Parameters:
-
[in] seqNum Sequence number to increment
Definition at line 1135 of file tls_record.c.
| error_t tlsReadProtocolData | ( | TlsContext * | context, |
| void ** | data, | ||
| size_t * | length, | ||
| TlsContentType * | contentType | ||
| ) |
Read protocol data.
- Parameters:
-
[in] context Pointer to the TLS context [out] data Pointer to the received data [out] length Number of data bytes that were received [out] contentType Higher level protocol
- Returns:
- Error code
Definition at line 146 of file tls_record.c.
| error_t tlsReadRecord | ( | TlsContext * | context, |
| uint8_t * | data, | ||
| size_t | size, | ||
| size_t * | length, | ||
| TlsContentType * | contentType | ||
| ) |
Receive a TLS record.
- Parameters:
-
[in] context Pointer to the TLS context [out] data Buffer where to store the record data [in] size Maximum acceptable size for the incoming record [out] length Length of the record data [out] contentType Record type
- Returns:
- Error code
Definition at line 417 of file tls_record.c.
| error_t tlsWriteProtocolData | ( | TlsContext * | context, |
| const void * | data, | ||
| size_t | length, | ||
| TlsContentType | contentType | ||
| ) |
Write protocol data.
- Parameters:
-
[in] context Pointer to the TLS context [in] data Pointer to the data buffer [in] length Number of data bytes to be written [in] contentType Higher level protocol
- Returns:
- Error code
Definition at line 58 of file tls_record.c.
| error_t tlsWriteRecord | ( | TlsContext * | context, |
| const uint8_t * | data, | ||
| size_t | length, | ||
| TlsContentType | contentType | ||
| ) |
Send a TLS record.
- Parameters:
-
[in] context Pointer to the TLS context [in] data Pointer to the record data [in] length Length of the record data [in] contentType Record type
- Returns:
- Error code
Definition at line 322 of file tls_record.c.
Generated on Tue Jul 12 2022 17:10:23 by
1.7.2