tls_record.h
Go to the documentation of this file.
1 /**
2  * @file tls_record.h
3  * @brief TLS record protocol
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2019 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneSSL Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 1.9.6
29  **/
30 
31 #ifndef _TLS_RECORD_H
32 #define _TLS_RECORD_H
33 
34 //Dependencies
35 #include "tls.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //TLS related functions
44  const uint8_t *data, size_t length, TlsContentType contentType);
45 
47  uint8_t **data, size_t *length, TlsContentType *contentType);
48 
49 error_t tlsWriteRecord(TlsContext *context, const uint8_t *data,
50  size_t length, TlsContentType contentType);
51 
52 error_t tlsReadRecord(TlsContext *context, uint8_t *data,
53  size_t size, size_t *length, TlsContentType *contentType);
54 
55 error_t tlsProcessRecord(TlsContext *context, TlsRecord *record);
56 
57 void tlsSetRecordType(TlsContext *context, void *record, uint8_t type);
58 uint8_t tlsGetRecordType(TlsContext *context, void *record);
59 void tlsSetRecordLength(TlsContext *context, void *record, size_t length);
60 size_t tlsGetRecordLength(TlsContext *context, void *record);
61 uint8_t *tlsGetRecordData(TlsContext *context, void *record);
62 
63 void tlsFormatAad(TlsContext *context, TlsEncryptionEngine *encryptionEngine,
64  const void *record, uint8_t *aad, size_t *aadLen);
65 
66 void tlsFormatNonce(TlsContext *context, TlsEncryptionEngine *encryptionEngine,
67  const void *record, const uint8_t *recordIv, uint8_t *nonce, size_t *nonceLen);
68 
70 
71 //C++ guard
72 #ifdef __cplusplus
73 }
74 #endif
75 
76 #endif
uint8_t length
Definition: dtls_misc.h:149
error_t tlsWriteProtocolData(TlsContext *context, const uint8_t *data, size_t length, TlsContentType contentType)
Write protocol data.
Definition: tls_record.c:55
size_t tlsGetRecordLength(TlsContext *context, void *record)
Get TLS record length.
Definition: tls_record.c:836
void tlsFormatAad(TlsContext *context, TlsEncryptionEngine *encryptionEngine, const void *record, uint8_t *aad, size_t *aadLen)
Format additional authenticated data (AAD)
Definition: tls_record.c:900
error_t tlsProcessRecord(TlsContext *context, TlsRecord *record)
Process incoming TLS record.
Definition: tls_record.c:621
char_t type
#define TlsContext
Definition: tls.h:36
error_t
Error codes.
Definition: error.h:42
error_t tlsWriteRecord(TlsContext *context, const uint8_t *data, size_t length, TlsContentType contentType)
Send a TLS record.
Definition: tls_record.c:345
void tlsSetRecordType(TlsContext *context, void *record, uint8_t type)
Set TLS record type.
Definition: tls_record.c:753
void tlsIncSequenceNumber(TlsSequenceNumber *seqNum)
Increment sequence number.
Definition: tls_record.c:1025
Encryption engine.
Definition: tls.h:1942
uint8_t * tlsGetRecordData(TlsContext *context, void *record)
Get TLS record payload.
Definition: tls_record.c:867
TlsContentType
Content type.
Definition: tls.h:914
__start_packed struct @61 TlsSequenceNumber
Sequence number.
void tlsFormatNonce(TlsContext *context, TlsEncryptionEngine *encryptionEngine, const void *record, const uint8_t *recordIv, uint8_t *nonce, size_t *nonceLen)
Format nonce.
Definition: tls_record.c:958
void tlsSetRecordLength(TlsContext *context, void *record, size_t length)
Set TLS record length.
Definition: tls_record.c:810
__start_packed struct @83 TlsRecord
TLS record.
TLS (Transport Layer Security)
DtlsSequenceNumber seqNum
Definition: dtls_misc.h:174
error_t tlsReadRecord(TlsContext *context, uint8_t *data, size_t size, size_t *length, TlsContentType *contentType)
Receive a TLS record.
Definition: tls_record.c:450
uint8_t data[]
Definition: dtls_misc.h:176
error_t tlsReadProtocolData(TlsContext *context, uint8_t **data, size_t *length, TlsContentType *contentType)
Read protocol data.
Definition: tls_record.c:158
uint8_t tlsGetRecordType(TlsContext *context, void *record)
Get TLS record type.
Definition: tls_record.c:779