dtls13_record_decrypt.h
Go to the documentation of this file.
1 /**
2  * @file dtls13_record_decrypt.h
3  * @brief DTLS 1.3 record decryption
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2026 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 2.6.2
29  **/
30 
31 #ifndef _DTLS13_RECORD_DECRYPT_H
32 #define _DTLS13_RECORD_DECRYPT_H
33 
34 //Dependencies
35 #include "tls/tls.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //DTLS 1.3 related functions
44 error_t dtls13ReadPlaintextRecord(TlsContext *context, uint8_t *record);
45 error_t dtls13ReadCiphertextRecord(TlsContext *context, uint8_t *record);
46 
48  TlsEncryptionEngine *decryptionEngine, const uint8_t *nonce,
49  size_t nonceLen, const uint8_t *aad, size_t aadLen, uint8_t *data,
50  size_t *dataLen, uint8_t *type);
51 
53  TlsEncryptionEngine *decryptionEngine, const uint8_t *nonce,
54  size_t nonceLen, const uint8_t *aad, size_t aadLen, uint8_t *data,
55  size_t dataLen, uint8_t *tag);
56 
58  TlsEncryptionEngine *decryptionEngine, const uint8_t *nonce,
59  size_t nonceLen, const uint8_t *aad, size_t aadLen, const uint8_t *data,
60  size_t dataLen, uint8_t *mac);
61 
63  uint8_t *record);
64 
66  const uint8_t *record, DtlsSequenceNumber *seqNum);
67 
68 //C++ guard
69 #ifdef __cplusplus
70 }
71 #endif
72 
73 #endif
error_t dtls13ReadRecord(TlsContext *context)
Receive a DTLS 1.3 record.
uint8_t data[]
Definition: ethernet.h:224
error_t dtls13DecryptAeadRecord(TlsContext *context, TlsEncryptionEngine *decryptionEngine, const uint8_t *nonce, size_t nonceLen, const uint8_t *aad, size_t aadLen, uint8_t *data, size_t dataLen, uint8_t *tag)
Record decryption (AEAD cipher)
error_t dtls13ReadPlaintextRecord(TlsContext *context, uint8_t *record)
Receive a DTLSPlaintext record.
uint8_t type
Definition: coap_common.h:176
#define TlsContext
Definition: tls.h:36
error_t
Error codes.
Definition: error.h:43
uint32_t seqNum
Definition: tcp.h:348
error_t dtls13DecryptSequenceNumber(TlsEncryptionEngine *decryptionEngine, uint8_t *record)
Decrypt sequence number.
error_t dtls13ReadCiphertextRecord(TlsContext *context, uint8_t *record)
Receive a DTLSCiphertext record.
uint32_t dataLen
Definition: sftp_common.h:229
error_t dtls13DecryptRecord(TlsContext *context, TlsEncryptionEngine *decryptionEngine, const uint8_t *nonce, size_t nonceLen, const uint8_t *aad, size_t aadLen, uint8_t *data, size_t *dataLen, uint8_t *type)
Decrypt an incoming DTLS 1.3 record.
error_t dtls13VerifyMac(TlsContext *context, TlsEncryptionEngine *decryptionEngine, const uint8_t *nonce, size_t nonceLen, const uint8_t *aad, size_t aadLen, const uint8_t *data, size_t dataLen, uint8_t *mac)
Check message authentication code.
DtlsSequenceNumber
Definition: dtls_misc.h:148
TLS (Transport Layer Security)
#define TlsEncryptionEngine
Definition: tls.h:40
void dtls13ReconstructSequenceNumber(TlsEncryptionEngine *decryptionEngine, const uint8_t *record, DtlsSequenceNumber *seqNum)
Sequence number reconstruction.
uint8_t nonce[]
Definition: ntp_common.h:239