blob: 25e1d8d67832a66846004c1494e1db8365faeaa0 [file] [log] [blame]
Paul Bakker8123e9d2011-01-06 15:37:30 +00001/**
2 * \file cipher.h
Paul Bakker9af723c2014-05-01 13:03:14 +02003 *
Rose Zadik826f2642018-04-19 14:01:29 +01004 * \brief This file contains an abstraction interface for use with the cipher
5 * primitives provided by the library. It provides a common interface to all of
6 * the available cipher operations.
Paul Bakker8123e9d2011-01-06 15:37:30 +00007 *
8 * \author Adriaan de Jong <dejong@fox-it.com>
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020012 * SPDX-License-Identifier: Apache-2.0
13 *
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
15 * not use this file except in compliance with the License.
16 * You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing, software
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 * See the License for the specific language governing permissions and
24 * limitations under the License.
Paul Bakker8123e9d2011-01-06 15:37:30 +000025 */
26
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#ifndef MBEDTLS_CIPHER_H
28#define MBEDTLS_CIPHER_H
Mateusz Starzyk846f0212021-05-19 19:44:07 +020029#include "mbedtls/private_access.h"
Paul Bakker8123e9d2011-01-06 15:37:30 +000030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020031#if !defined(MBEDTLS_CONFIG_FILE)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010032#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020033#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020034#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020035#endif
Manuel Pégourié-Gonnard43a47802013-09-03 16:35:53 +020036
Rich Evans00ab4702015-02-06 13:43:58 +000037#include <stddef.h>
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010038#include "mbedtls/platform_util.h"
Rich Evans00ab4702015-02-06 13:43:58 +000039
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +020040#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020041#define MBEDTLS_CIPHER_MODE_AEAD
Manuel Pégourié-Gonnard43a47802013-09-03 16:35:53 +020042#endif
43
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020044#if defined(MBEDTLS_CIPHER_MODE_CBC)
45#define MBEDTLS_CIPHER_MODE_WITH_PADDING
Manuel Pégourié-Gonnard989ed382013-09-13 14:41:45 +020046#endif
47
Simon Butcherc7965732018-07-27 17:13:39 +010048#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER) || \
49 defined(MBEDTLS_CHACHA20_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#define MBEDTLS_CIPHER_MODE_STREAM
Manuel Pégourié-Gonnardb8ca7232014-12-02 10:09:10 +010051#endif
52
Manuel Pégourié-Gonnard0223ab92015-10-05 11:40:01 +010053#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
54 !defined(inline) && !defined(__cplusplus)
Paul Bakker569df2c2011-06-21 07:48:07 +000055#define inline __inline
Manuel Pégourié-Gonnard20af64d2015-07-07 18:33:39 +020056#endif
Paul Bakkeraf5c85f2011-04-18 03:47:52 +000057
Rose Zadik9ba6b622018-01-24 12:59:19 +000058#define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080 /**< The selected feature is not available. */
59#define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100 /**< Bad input parameters. */
60#define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180 /**< Failed to allocate memory. */
61#define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200 /**< Input data contains invalid padding and is rejected. */
62#define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280 /**< Decryption of block requires a full block. */
63#define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300 /**< Authentication failed (for AEAD modes). */
64#define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380 /**< The context is invalid. For example, because it was freed. */
Ron Eldor9924bdc2018-10-04 10:59:13 +030065
Rose Zadik9ba6b622018-01-24 12:59:19 +000066#define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01 /**< Cipher accepts IVs of variable length. */
67#define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02 /**< Cipher accepts keys of variable length. */
Manuel Pégourié-Gonnard81754a02014-06-23 11:33:18 +020068
Paul Bakker407a0da2013-06-27 14:29:21 +020069#ifdef __cplusplus
70extern "C" {
71#endif
72
Hanno Beckerbbca8c52017-09-25 14:53:51 +010073/**
Rose Zadik02f73a62018-03-26 18:02:32 +010074 * \brief Supported cipher types.
Hanno Beckerbbca8c52017-09-25 14:53:51 +010075 *
Rose Zadik826f2642018-04-19 14:01:29 +010076 * \warning RC4 and DES are considered weak ciphers and their use
Rose Zadikb5607bf2018-04-16 10:34:51 +010077 * constitutes a security risk. Arm recommends considering stronger
78 * ciphers instead.
Hanno Beckerbbca8c52017-09-25 14:53:51 +010079 */
Paul Bakker8123e9d2011-01-06 15:37:30 +000080typedef enum {
Rose Zadik4c368e82018-04-19 14:24:11 +010081 MBEDTLS_CIPHER_ID_NONE = 0, /**< Placeholder to mark the end of cipher ID lists. */
82 MBEDTLS_CIPHER_ID_NULL, /**< The identity cipher, treated as a stream cipher. */
Rose Zadik02f73a62018-03-26 18:02:32 +010083 MBEDTLS_CIPHER_ID_AES, /**< The AES cipher. */
84 MBEDTLS_CIPHER_ID_DES, /**< The DES cipher. */
Rose Zadik93f99192018-04-19 14:41:33 +010085 MBEDTLS_CIPHER_ID_3DES, /**< The Triple DES cipher. */
Rose Zadik02f73a62018-03-26 18:02:32 +010086 MBEDTLS_CIPHER_ID_CAMELLIA, /**< The Camellia cipher. */
87 MBEDTLS_CIPHER_ID_BLOWFISH, /**< The Blowfish cipher. */
Rose Zadik826f2642018-04-19 14:01:29 +010088 MBEDTLS_CIPHER_ID_ARC4, /**< The RC4 cipher. */
Manuel Pégourié-Gonnarda3712be2018-05-22 15:58:50 +020089 MBEDTLS_CIPHER_ID_ARIA, /**< The Aria cipher. */
Manuel Pégourié-Gonnardb500f8b2018-05-08 12:43:48 +020090 MBEDTLS_CIPHER_ID_CHACHA20, /**< The ChaCha20 cipher. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020091} mbedtls_cipher_id_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +000092
Hanno Beckerbbca8c52017-09-25 14:53:51 +010093/**
Rose Zadik02f73a62018-03-26 18:02:32 +010094 * \brief Supported {cipher type, cipher mode} pairs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +010095 *
Rose Zadik826f2642018-04-19 14:01:29 +010096 * \warning RC4 and DES are considered weak ciphers and their use
Rose Zadikb5607bf2018-04-16 10:34:51 +010097 * constitutes a security risk. Arm recommends considering stronger
Hanno Beckerbbca8c52017-09-25 14:53:51 +010098 * ciphers instead.
99 */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000100typedef enum {
Rose Zadik4c368e82018-04-19 14:24:11 +0100101 MBEDTLS_CIPHER_NONE = 0, /**< Placeholder to mark the end of cipher-pair lists. */
Rose Zadikc441f742018-04-19 14:38:20 +0100102 MBEDTLS_CIPHER_NULL, /**< The identity stream cipher. */
Rose Zadik02f73a62018-03-26 18:02:32 +0100103 MBEDTLS_CIPHER_AES_128_ECB, /**< AES cipher with 128-bit ECB mode. */
104 MBEDTLS_CIPHER_AES_192_ECB, /**< AES cipher with 192-bit ECB mode. */
105 MBEDTLS_CIPHER_AES_256_ECB, /**< AES cipher with 256-bit ECB mode. */
106 MBEDTLS_CIPHER_AES_128_CBC, /**< AES cipher with 128-bit CBC mode. */
107 MBEDTLS_CIPHER_AES_192_CBC, /**< AES cipher with 192-bit CBC mode. */
108 MBEDTLS_CIPHER_AES_256_CBC, /**< AES cipher with 256-bit CBC mode. */
109 MBEDTLS_CIPHER_AES_128_CFB128, /**< AES cipher with 128-bit CFB128 mode. */
110 MBEDTLS_CIPHER_AES_192_CFB128, /**< AES cipher with 192-bit CFB128 mode. */
111 MBEDTLS_CIPHER_AES_256_CFB128, /**< AES cipher with 256-bit CFB128 mode. */
112 MBEDTLS_CIPHER_AES_128_CTR, /**< AES cipher with 128-bit CTR mode. */
113 MBEDTLS_CIPHER_AES_192_CTR, /**< AES cipher with 192-bit CTR mode. */
114 MBEDTLS_CIPHER_AES_256_CTR, /**< AES cipher with 256-bit CTR mode. */
115 MBEDTLS_CIPHER_AES_128_GCM, /**< AES cipher with 128-bit GCM mode. */
116 MBEDTLS_CIPHER_AES_192_GCM, /**< AES cipher with 192-bit GCM mode. */
117 MBEDTLS_CIPHER_AES_256_GCM, /**< AES cipher with 256-bit GCM mode. */
118 MBEDTLS_CIPHER_CAMELLIA_128_ECB, /**< Camellia cipher with 128-bit ECB mode. */
119 MBEDTLS_CIPHER_CAMELLIA_192_ECB, /**< Camellia cipher with 192-bit ECB mode. */
120 MBEDTLS_CIPHER_CAMELLIA_256_ECB, /**< Camellia cipher with 256-bit ECB mode. */
121 MBEDTLS_CIPHER_CAMELLIA_128_CBC, /**< Camellia cipher with 128-bit CBC mode. */
122 MBEDTLS_CIPHER_CAMELLIA_192_CBC, /**< Camellia cipher with 192-bit CBC mode. */
123 MBEDTLS_CIPHER_CAMELLIA_256_CBC, /**< Camellia cipher with 256-bit CBC mode. */
124 MBEDTLS_CIPHER_CAMELLIA_128_CFB128, /**< Camellia cipher with 128-bit CFB128 mode. */
125 MBEDTLS_CIPHER_CAMELLIA_192_CFB128, /**< Camellia cipher with 192-bit CFB128 mode. */
126 MBEDTLS_CIPHER_CAMELLIA_256_CFB128, /**< Camellia cipher with 256-bit CFB128 mode. */
127 MBEDTLS_CIPHER_CAMELLIA_128_CTR, /**< Camellia cipher with 128-bit CTR mode. */
128 MBEDTLS_CIPHER_CAMELLIA_192_CTR, /**< Camellia cipher with 192-bit CTR mode. */
129 MBEDTLS_CIPHER_CAMELLIA_256_CTR, /**< Camellia cipher with 256-bit CTR mode. */
130 MBEDTLS_CIPHER_CAMELLIA_128_GCM, /**< Camellia cipher with 128-bit GCM mode. */
131 MBEDTLS_CIPHER_CAMELLIA_192_GCM, /**< Camellia cipher with 192-bit GCM mode. */
132 MBEDTLS_CIPHER_CAMELLIA_256_GCM, /**< Camellia cipher with 256-bit GCM mode. */
133 MBEDTLS_CIPHER_DES_ECB, /**< DES cipher with ECB mode. */
134 MBEDTLS_CIPHER_DES_CBC, /**< DES cipher with CBC mode. */
135 MBEDTLS_CIPHER_DES_EDE_ECB, /**< DES cipher with EDE ECB mode. */
136 MBEDTLS_CIPHER_DES_EDE_CBC, /**< DES cipher with EDE CBC mode. */
137 MBEDTLS_CIPHER_DES_EDE3_ECB, /**< DES cipher with EDE3 ECB mode. */
138 MBEDTLS_CIPHER_DES_EDE3_CBC, /**< DES cipher with EDE3 CBC mode. */
139 MBEDTLS_CIPHER_BLOWFISH_ECB, /**< Blowfish cipher with ECB mode. */
140 MBEDTLS_CIPHER_BLOWFISH_CBC, /**< Blowfish cipher with CBC mode. */
141 MBEDTLS_CIPHER_BLOWFISH_CFB64, /**< Blowfish cipher with CFB64 mode. */
142 MBEDTLS_CIPHER_BLOWFISH_CTR, /**< Blowfish cipher with CTR mode. */
Rose Zadik826f2642018-04-19 14:01:29 +0100143 MBEDTLS_CIPHER_ARC4_128, /**< RC4 cipher with 128-bit mode. */
Rose Zadik02f73a62018-03-26 18:02:32 +0100144 MBEDTLS_CIPHER_AES_128_CCM, /**< AES cipher with 128-bit CCM mode. */
145 MBEDTLS_CIPHER_AES_192_CCM, /**< AES cipher with 192-bit CCM mode. */
146 MBEDTLS_CIPHER_AES_256_CCM, /**< AES cipher with 256-bit CCM mode. */
147 MBEDTLS_CIPHER_CAMELLIA_128_CCM, /**< Camellia cipher with 128-bit CCM mode. */
148 MBEDTLS_CIPHER_CAMELLIA_192_CCM, /**< Camellia cipher with 192-bit CCM mode. */
149 MBEDTLS_CIPHER_CAMELLIA_256_CCM, /**< Camellia cipher with 256-bit CCM mode. */
Manuel Pégourié-Gonnarda3712be2018-05-22 15:58:50 +0200150 MBEDTLS_CIPHER_ARIA_128_ECB, /**< Aria cipher with 128-bit key and ECB mode. */
151 MBEDTLS_CIPHER_ARIA_192_ECB, /**< Aria cipher with 192-bit key and ECB mode. */
152 MBEDTLS_CIPHER_ARIA_256_ECB, /**< Aria cipher with 256-bit key and ECB mode. */
153 MBEDTLS_CIPHER_ARIA_128_CBC, /**< Aria cipher with 128-bit key and CBC mode. */
154 MBEDTLS_CIPHER_ARIA_192_CBC, /**< Aria cipher with 192-bit key and CBC mode. */
155 MBEDTLS_CIPHER_ARIA_256_CBC, /**< Aria cipher with 256-bit key and CBC mode. */
156 MBEDTLS_CIPHER_ARIA_128_CFB128, /**< Aria cipher with 128-bit key and CFB-128 mode. */
157 MBEDTLS_CIPHER_ARIA_192_CFB128, /**< Aria cipher with 192-bit key and CFB-128 mode. */
158 MBEDTLS_CIPHER_ARIA_256_CFB128, /**< Aria cipher with 256-bit key and CFB-128 mode. */
159 MBEDTLS_CIPHER_ARIA_128_CTR, /**< Aria cipher with 128-bit key and CTR mode. */
160 MBEDTLS_CIPHER_ARIA_192_CTR, /**< Aria cipher with 192-bit key and CTR mode. */
161 MBEDTLS_CIPHER_ARIA_256_CTR, /**< Aria cipher with 256-bit key and CTR mode. */
162 MBEDTLS_CIPHER_ARIA_128_GCM, /**< Aria cipher with 128-bit key and GCM mode. */
163 MBEDTLS_CIPHER_ARIA_192_GCM, /**< Aria cipher with 192-bit key and GCM mode. */
164 MBEDTLS_CIPHER_ARIA_256_GCM, /**< Aria cipher with 256-bit key and GCM mode. */
165 MBEDTLS_CIPHER_ARIA_128_CCM, /**< Aria cipher with 128-bit key and CCM mode. */
166 MBEDTLS_CIPHER_ARIA_192_CCM, /**< Aria cipher with 192-bit key and CCM mode. */
167 MBEDTLS_CIPHER_ARIA_256_CCM, /**< Aria cipher with 256-bit key and CCM mode. */
Simon Butcher6873c842018-04-29 13:03:20 +0100168 MBEDTLS_CIPHER_AES_128_OFB, /**< AES 128-bit cipher in OFB mode. */
169 MBEDTLS_CIPHER_AES_192_OFB, /**< AES 192-bit cipher in OFB mode. */
170 MBEDTLS_CIPHER_AES_256_OFB, /**< AES 256-bit cipher in OFB mode. */
Jaeden Ameroc6539902018-04-30 17:17:41 +0100171 MBEDTLS_CIPHER_AES_128_XTS, /**< AES 128-bit cipher in XTS block mode. */
172 MBEDTLS_CIPHER_AES_256_XTS, /**< AES 256-bit cipher in XTS block mode. */
Manuel Pégourié-Gonnardb500f8b2018-05-08 12:43:48 +0200173 MBEDTLS_CIPHER_CHACHA20, /**< ChaCha20 stream cipher. */
174 MBEDTLS_CIPHER_CHACHA20_POLY1305, /**< ChaCha20-Poly1305 AEAD cipher. */
Jack Lloydffdf2882019-03-07 17:00:32 -0500175 MBEDTLS_CIPHER_AES_128_KW, /**< AES cipher with 128-bit NIST KW mode. */
176 MBEDTLS_CIPHER_AES_192_KW, /**< AES cipher with 192-bit NIST KW mode. */
177 MBEDTLS_CIPHER_AES_256_KW, /**< AES cipher with 256-bit NIST KW mode. */
178 MBEDTLS_CIPHER_AES_128_KWP, /**< AES cipher with 128-bit NIST KWP mode. */
179 MBEDTLS_CIPHER_AES_192_KWP, /**< AES cipher with 192-bit NIST KWP mode. */
180 MBEDTLS_CIPHER_AES_256_KWP, /**< AES cipher with 256-bit NIST KWP mode. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200181} mbedtls_cipher_type_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000182
Rose Zadik9ba6b622018-01-24 12:59:19 +0000183/** Supported cipher modes. */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000184typedef enum {
Hanno Beckere5a04502018-11-08 16:57:42 +0000185 MBEDTLS_MODE_NONE = 0, /**< None. */
186 MBEDTLS_MODE_ECB, /**< The ECB cipher mode. */
187 MBEDTLS_MODE_CBC, /**< The CBC cipher mode. */
188 MBEDTLS_MODE_CFB, /**< The CFB cipher mode. */
189 MBEDTLS_MODE_OFB, /**< The OFB cipher mode. */
190 MBEDTLS_MODE_CTR, /**< The CTR cipher mode. */
191 MBEDTLS_MODE_GCM, /**< The GCM cipher mode. */
192 MBEDTLS_MODE_STREAM, /**< The stream cipher mode. */
193 MBEDTLS_MODE_CCM, /**< The CCM cipher mode. */
194 MBEDTLS_MODE_XTS, /**< The XTS cipher mode. */
Manuel Pégourié-Gonnardf57bf8b2018-06-18 11:14:09 +0200195 MBEDTLS_MODE_CHACHAPOLY, /**< The ChaCha-Poly cipher mode. */
Jack Lloydffdf2882019-03-07 17:00:32 -0500196 MBEDTLS_MODE_KW, /**< The SP800-38F KW mode */
197 MBEDTLS_MODE_KWP, /**< The SP800-38F KWP mode */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198} mbedtls_cipher_mode_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000199
Rose Zadik9ba6b622018-01-24 12:59:19 +0000200/** Supported cipher padding types. */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000201typedef enum {
Rose Zadik9ba6b622018-01-24 12:59:19 +0000202 MBEDTLS_PADDING_PKCS7 = 0, /**< PKCS7 padding (default). */
203 MBEDTLS_PADDING_ONE_AND_ZEROS, /**< ISO/IEC 7816-4 padding. */
204 MBEDTLS_PADDING_ZEROS_AND_LEN, /**< ANSI X.923 padding. */
Rose Zadik02f73a62018-03-26 18:02:32 +0100205 MBEDTLS_PADDING_ZEROS, /**< Zero padding (not reversible). */
206 MBEDTLS_PADDING_NONE, /**< Never pad (full blocks only). */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200207} mbedtls_cipher_padding_t;
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200208
Rose Zadik9ba6b622018-01-24 12:59:19 +0000209/** Type of operation. */
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200210typedef enum {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211 MBEDTLS_OPERATION_NONE = -1,
212 MBEDTLS_DECRYPT = 0,
213 MBEDTLS_ENCRYPT,
214} mbedtls_operation_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000215
216enum {
Rose Zadik9ba6b622018-01-24 12:59:19 +0000217 /** Undefined key length. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200218 MBEDTLS_KEY_LENGTH_NONE = 0,
Rose Zadik9ba6b622018-01-24 12:59:19 +0000219 /** Key length, in bits (including parity), for DES keys. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 MBEDTLS_KEY_LENGTH_DES = 64,
Rose Zadik9ba6b622018-01-24 12:59:19 +0000221 /** Key length in bits, including parity, for DES in two-key EDE. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200222 MBEDTLS_KEY_LENGTH_DES_EDE = 128,
Rose Zadik9ba6b622018-01-24 12:59:19 +0000223 /** Key length in bits, including parity, for DES in three-key EDE. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200224 MBEDTLS_KEY_LENGTH_DES_EDE3 = 192,
Paul Bakker8123e9d2011-01-06 15:37:30 +0000225};
226
Rose Zadik9ba6b622018-01-24 12:59:19 +0000227/** Maximum length of any IV, in Bytes. */
Hanno Becker15889832020-09-08 11:29:11 +0100228/* This should ideally be derived automatically from list of ciphers.
229 * This should be kept in sync with MBEDTLS_SSL_MAX_IV_LENGTH defined
Chris Jones3848e312021-03-11 16:17:59 +0000230 * in library/ssl_misc.h. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200231#define MBEDTLS_MAX_IV_LENGTH 16
Hanno Becker27a26882020-08-07 11:30:05 +0100232
Rose Zadik9ba6b622018-01-24 12:59:19 +0000233/** Maximum block size of any cipher, in Bytes. */
Hanno Becker15889832020-09-08 11:29:11 +0100234/* This should ideally be derived automatically from list of ciphers.
235 * This should be kept in sync with MBEDTLS_SSL_MAX_BLOCK_LENGTH defined
Chris Jones3848e312021-03-11 16:17:59 +0000236 * in library/ssl_misc.h. */
Manuel Pégourié-Gonnard32902e62018-05-10 12:30:19 +0200237#define MBEDTLS_MAX_BLOCK_LENGTH 16
Manuel Pégourié-Gonnard0b58c152013-10-24 17:17:54 +0200238
Hanno Becker27a26882020-08-07 11:30:05 +0100239/** Maximum key length, in Bytes. */
240/* This should ideally be derived automatically from list of ciphers.
241 * For now, only check whether XTS is enabled which uses 64 Byte keys,
Hanno Becker15889832020-09-08 11:29:11 +0100242 * and use 32 Bytes as an upper bound for the maximum key length otherwise.
243 * This should be kept in sync with MBEDTLS_SSL_MAX_BLOCK_LENGTH defined
Chris Jones3848e312021-03-11 16:17:59 +0000244 * in library/ssl_misc.h, which however deliberately ignores the case of XTS
Hanno Becker15889832020-09-08 11:29:11 +0100245 * since the latter isn't used in SSL/TLS. */
Hanno Becker27a26882020-08-07 11:30:05 +0100246#if defined(MBEDTLS_CIPHER_MODE_XTS)
247#define MBEDTLS_MAX_KEY_LENGTH 64
248#else
249#define MBEDTLS_MAX_KEY_LENGTH 32
250#endif /* MBEDTLS_CIPHER_MODE_XTS */
251
Paul Bakker8123e9d2011-01-06 15:37:30 +0000252/**
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100253 * Base cipher information (opaque struct).
Paul Bakker343a8702011-06-09 14:27:58 +0000254 */
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100255typedef struct mbedtls_cipher_base_t mbedtls_cipher_base_t;
Paul Bakker343a8702011-06-09 14:27:58 +0000256
257/**
Simon Butcher327398a2016-10-05 14:09:11 +0100258 * CMAC context (opaque struct).
259 */
260typedef struct mbedtls_cmac_context_t mbedtls_cmac_context_t;
261
262/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000263 * Cipher information. Allows calling cipher functions
264 * in a generic way.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000265 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200266typedef struct mbedtls_cipher_info_t
267{
Rose Zadik9ba6b622018-01-24 12:59:19 +0000268 /** Full cipher identifier. For example,
269 * MBEDTLS_CIPHER_AES_256_CBC.
270 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200271 mbedtls_cipher_type_t MBEDTLS_PRIVATE(type);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000272
Rose Zadik9ba6b622018-01-24 12:59:19 +0000273 /** The cipher mode. For example, MBEDTLS_MODE_CBC. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200274 mbedtls_cipher_mode_t MBEDTLS_PRIVATE(mode);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000275
Rose Zadik9ba6b622018-01-24 12:59:19 +0000276 /** The cipher key length, in bits. This is the
277 * default length for variable sized ciphers.
278 * Includes parity bits for ciphers like DES.
279 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200280 unsigned int MBEDTLS_PRIVATE(key_bitlen);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000281
Rose Zadik9ba6b622018-01-24 12:59:19 +0000282 /** Name of the cipher. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200283 const char * MBEDTLS_PRIVATE(name);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000284
Rose Zadik9ba6b622018-01-24 12:59:19 +0000285 /** IV or nonce size, in Bytes.
286 * For ciphers that accept variable IV sizes,
287 * this is the recommended size.
288 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200289 unsigned int MBEDTLS_PRIVATE(iv_size);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000290
Rose Zadikb5607bf2018-04-16 10:34:51 +0100291 /** Bitflag comprised of MBEDTLS_CIPHER_VARIABLE_IV_LEN and
292 * MBEDTLS_CIPHER_VARIABLE_KEY_LEN indicating whether the
293 * cipher supports variable IV or variable key sizes, respectively.
294 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200295 int MBEDTLS_PRIVATE(flags);
Manuel Pégourié-Gonnarda235b5b2013-09-03 13:25:52 +0200296
Rose Zadik9ba6b622018-01-24 12:59:19 +0000297 /** The block size, in Bytes. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200298 unsigned int MBEDTLS_PRIVATE(block_size);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000299
Rose Zadik9ba6b622018-01-24 12:59:19 +0000300 /** Struct for base cipher information and functions. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200301 const mbedtls_cipher_base_t *MBEDTLS_PRIVATE(base);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200303} mbedtls_cipher_info_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000304
305/**
Paul Bakker20281562011-11-11 10:34:04 +0000306 * Generic cipher context.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000307 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200308typedef struct mbedtls_cipher_context_t
309{
Rose Zadik9ba6b622018-01-24 12:59:19 +0000310 /** Information about the associated cipher. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200311 const mbedtls_cipher_info_t *MBEDTLS_PRIVATE(cipher_info);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000312
Rose Zadik9ba6b622018-01-24 12:59:19 +0000313 /** Key length to use. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200314 int MBEDTLS_PRIVATE(key_bitlen);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000315
Rose Zadik9ba6b622018-01-24 12:59:19 +0000316 /** Operation that the key of the context has been
317 * initialized for.
318 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200319 mbedtls_operation_t MBEDTLS_PRIVATE(operation);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000320
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200321#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Rose Zadik9ba6b622018-01-24 12:59:19 +0000322 /** Padding functions to use, if relevant for
323 * the specific cipher mode.
324 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200325 void (*MBEDTLS_PRIVATE(add_padding))( unsigned char *output, size_t olen, size_t data_len );
326 int (*MBEDTLS_PRIVATE(get_padding))( unsigned char *input, size_t ilen, size_t *data_len );
Manuel Pégourié-Gonnardb8ca7232014-12-02 10:09:10 +0100327#endif
Manuel Pégourié-Gonnardac56a1a2013-07-25 12:31:10 +0200328
Rose Zadik9ba6b622018-01-24 12:59:19 +0000329 /** Buffer for input that has not been processed yet. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200330 unsigned char MBEDTLS_PRIVATE(unprocessed_data)[MBEDTLS_MAX_BLOCK_LENGTH];
Paul Bakker8123e9d2011-01-06 15:37:30 +0000331
Rose Zadik9ba6b622018-01-24 12:59:19 +0000332 /** Number of Bytes that have not been processed yet. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200333 size_t MBEDTLS_PRIVATE(unprocessed_len);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000334
Jaeden Ameroc6539902018-04-30 17:17:41 +0100335 /** Current IV or NONCE_COUNTER for CTR-mode, data unit (or sector) number
336 * for XTS-mode. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200337 unsigned char MBEDTLS_PRIVATE(iv)[MBEDTLS_MAX_IV_LENGTH];
Paul Bakker8123e9d2011-01-06 15:37:30 +0000338
Rose Zadik9ba6b622018-01-24 12:59:19 +0000339 /** IV size in Bytes, for ciphers with variable-length IVs. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200340 size_t MBEDTLS_PRIVATE(iv_size);
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200341
Rose Zadik9ba6b622018-01-24 12:59:19 +0000342 /** The cipher-specific context. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200343 void *MBEDTLS_PRIVATE(cipher_ctx);
Simon Butcher327398a2016-10-05 14:09:11 +0100344
345#if defined(MBEDTLS_CMAC_C)
Rose Zadik9ba6b622018-01-24 12:59:19 +0000346 /** CMAC-specific context. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200347 mbedtls_cmac_context_t *MBEDTLS_PRIVATE(cmac_ctx);
Simon Butcher327398a2016-10-05 14:09:11 +0100348#endif
Hanno Becker1cb36532018-11-09 16:20:29 +0000349
350#if defined(MBEDTLS_USE_PSA_CRYPTO)
351 /** Indicates whether the cipher operations should be performed
352 * by Mbed TLS' own crypto library or an external implementation
353 * of the PSA Crypto API.
Hanno Becker7909c4c2018-11-20 11:34:34 +0000354 * This is unset if the cipher context was established through
355 * mbedtls_cipher_setup(), and set if it was established through
Hanno Becker1cb36532018-11-09 16:20:29 +0000356 * mbedtls_cipher_setup_psa().
357 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200358 unsigned char MBEDTLS_PRIVATE(psa_enabled);
Hanno Becker1cb36532018-11-09 16:20:29 +0000359#endif /* MBEDTLS_USE_PSA_CRYPTO */
360
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200361} mbedtls_cipher_context_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000362
Paul Bakker8123e9d2011-01-06 15:37:30 +0000363/**
Hanno Beckerd7503a72018-11-08 15:55:24 +0000364 * \brief This function retrieves the list of ciphers supported
365 * by the generic cipher module.
Paul Bakker72f62662011-01-16 21:27:44 +0000366 *
Hanno Beckerd7503a72018-11-08 15:55:24 +0000367 * For any cipher identifier in the returned list, you can
368 * obtain the corresponding generic cipher information structure
369 * via mbedtls_cipher_info_from_type(), which can then be used
370 * to prepare a cipher context via mbedtls_cipher_setup().
371 *
372 *
373 * \return A statically-allocated array of cipher identifiers
374 * of type cipher_type_t. The last entry is zero.
Paul Bakker72f62662011-01-16 21:27:44 +0000375 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200376const int *mbedtls_cipher_list( void );
Paul Bakker72f62662011-01-16 21:27:44 +0000377
378/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000379 * \brief This function retrieves the cipher-information
380 * structure associated with the given cipher name.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000381 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500382 * \param cipher_name Name of the cipher to search for. This must not be
383 * \c NULL.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000384 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000385 * \return The cipher information structure associated with the
Rose Zadik02f73a62018-03-26 18:02:32 +0100386 * given \p cipher_name.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500387 * \return \c NULL if the associated cipher information is not found.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200389const mbedtls_cipher_info_t *mbedtls_cipher_info_from_string( const char *cipher_name );
Paul Bakker8123e9d2011-01-06 15:37:30 +0000390
391/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000392 * \brief This function retrieves the cipher-information
393 * structure associated with the given cipher type.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000394 *
395 * \param cipher_type Type of the cipher to search for.
396 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000397 * \return The cipher information structure associated with the
Rose Zadikb5607bf2018-04-16 10:34:51 +0100398 * given \p cipher_type.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500399 * \return \c NULL if the associated cipher information is not found.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000400 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200401const mbedtls_cipher_info_t *mbedtls_cipher_info_from_type( const mbedtls_cipher_type_t cipher_type );
Paul Bakker8123e9d2011-01-06 15:37:30 +0000402
403/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000404 * \brief This function retrieves the cipher-information
405 * structure associated with the given cipher ID,
406 * key size and mode.
Paul Bakkerf46b6952013-09-09 00:08:26 +0200407 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000408 * \param cipher_id The ID of the cipher to search for. For example,
409 * #MBEDTLS_CIPHER_ID_AES.
410 * \param key_bitlen The length of the key in bits.
411 * \param mode The cipher mode. For example, #MBEDTLS_MODE_CBC.
Paul Bakkerf46b6952013-09-09 00:08:26 +0200412 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000413 * \return The cipher information structure associated with the
Rose Zadik02f73a62018-03-26 18:02:32 +0100414 * given \p cipher_id.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500415 * \return \c NULL if the associated cipher information is not found.
Paul Bakkerf46b6952013-09-09 00:08:26 +0200416 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200417const mbedtls_cipher_info_t *mbedtls_cipher_info_from_values( const mbedtls_cipher_id_t cipher_id,
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +0200418 int key_bitlen,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200419 const mbedtls_cipher_mode_t mode );
Paul Bakkerf46b6952013-09-09 00:08:26 +0200420
421/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000422 * \brief This function initializes a \p cipher_context as NONE.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500423 *
424 * \param ctx The context to be initialized. This must not be \c NULL.
Paul Bakker84bbeb52014-07-01 14:53:22 +0200425 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200426void mbedtls_cipher_init( mbedtls_cipher_context_t *ctx );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200427
428/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000429 * \brief This function frees and clears the cipher-specific
430 * context of \p ctx. Freeing \p ctx itself remains the
431 * responsibility of the caller.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500432 *
433 * \param ctx The context to be freed. If this is \c NULL, the
434 * function has no effect, otherwise this must point to an
435 * initialized context.
Paul Bakker84bbeb52014-07-01 14:53:22 +0200436 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200437void mbedtls_cipher_free( mbedtls_cipher_context_t *ctx );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200438
Rose Zadik9ba6b622018-01-24 12:59:19 +0000439
Paul Bakker84bbeb52014-07-01 14:53:22 +0200440/**
Manuel Pégourié-Gonnarde9cac0e2021-05-27 12:59:11 +0200441 * \brief This function prepares a cipher context for
Hanno Beckerb1f08722018-11-09 16:09:19 +0000442 * use with the given cipher primitive.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000443 *
Manuel Pégourié-Gonnardc42a0be2021-05-31 11:13:35 +0200444 * \note After calling this function, you should call
445 * mbedtls_cipher_setkey() and, if the mode uses padding,
446 * mbedtls_cipher_set_padding_mode(), then for each
447 * message to encrypt or decrypt with this key, either:
448 * - mbedtls_cipher_crypt() for one-shot processing with
449 * non-AEAD modes;
450 * - mbedtls_cipher_auth_encrypt_ext() or
451 * mbedtls_cipher_auth_decrypt_ext() for one-shot
452 * processing with AEAD modes or NIST_KW;
453 * - for multi-part processing, see the documentation of
454 * mbedtls_cipher_reset().
455 *
Manuel Pégourié-Gonnarde9cac0e2021-05-27 12:59:11 +0200456 * \param ctx The context to prepare. This must be initialized by
457 * a call to mbedtls_cipher_init() first.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000458 * \param cipher_info The cipher to use.
Paul Bakker84bbeb52014-07-01 14:53:22 +0200459 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100460 * \return \c 0 on success.
Rose Zadik4c368e82018-04-19 14:24:11 +0100461 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
462 * parameter-verification failure.
Rose Zadik02f73a62018-03-26 18:02:32 +0100463 * \return #MBEDTLS_ERR_CIPHER_ALLOC_FAILED if allocation of the
Rose Zadik4c368e82018-04-19 14:24:11 +0100464 * cipher-specific context fails.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000465 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000466int mbedtls_cipher_setup( mbedtls_cipher_context_t *ctx,
467 const mbedtls_cipher_info_t *cipher_info );
Paul Bakker8123e9d2011-01-06 15:37:30 +0000468
Hanno Becker098c9de2018-11-09 16:10:57 +0000469#if defined(MBEDTLS_USE_PSA_CRYPTO)
470/**
471 * \brief This function initializes a cipher context for
472 * PSA-based use with the given cipher primitive.
473 *
474 * \note See #MBEDTLS_USE_PSA_CRYPTO for information on PSA.
475 *
476 * \param ctx The context to initialize. May not be \c NULL.
477 * \param cipher_info The cipher to use.
Hanno Beckerf1336402018-11-12 16:26:27 +0000478 * \param taglen For AEAD ciphers, the length in bytes of the
479 * authentication tag to use. Subsequent uses of
TRodziewicz18efb732021-04-29 23:12:19 +0200480 * mbedtls_cipher_auth_encrypt_ext() or
481 * mbedtls_cipher_auth_decrypt_ext() must provide
Hanno Beckerf1336402018-11-12 16:26:27 +0000482 * the same tag length.
483 * For non-AEAD ciphers, the value must be \c 0.
Hanno Becker098c9de2018-11-09 16:10:57 +0000484 *
485 * \return \c 0 on success.
486 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
487 * parameter-verification failure.
488 * \return #MBEDTLS_ERR_CIPHER_ALLOC_FAILED if allocation of the
489 * cipher-specific context fails.
490 */
491int mbedtls_cipher_setup_psa( mbedtls_cipher_context_t *ctx,
Hanno Beckerf1336402018-11-12 16:26:27 +0000492 const mbedtls_cipher_info_t *cipher_info,
493 size_t taglen );
Hanno Becker098c9de2018-11-09 16:10:57 +0000494#endif /* MBEDTLS_USE_PSA_CRYPTO */
495
Paul Bakker8123e9d2011-01-06 15:37:30 +0000496/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000497 * \brief This function returns the block size of the given cipher.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000498 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500499 * \param ctx The context of the cipher. This must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000500 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500501 * \return The block size of the underlying cipher.
502 * \return \c 0 if \p ctx has not been initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000503 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000504static inline unsigned int mbedtls_cipher_get_block_size(
505 const mbedtls_cipher_context_t *ctx )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000506{
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500507 MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, 0 );
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200508 if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000509 return 0;
510
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200511 return ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(block_size);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000512}
513
514/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000515 * \brief This function returns the mode of operation for
516 * the cipher. For example, MBEDTLS_MODE_CBC.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000517 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500518 * \param ctx The context of the cipher. This must be initialized.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000519 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100520 * \return The mode of operation.
521 * \return #MBEDTLS_MODE_NONE if \p ctx has not been initialized.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000522 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000523static inline mbedtls_cipher_mode_t mbedtls_cipher_get_cipher_mode(
524 const mbedtls_cipher_context_t *ctx )
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000525{
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500526 MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, MBEDTLS_MODE_NONE );
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200527 if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200528 return MBEDTLS_MODE_NONE;
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000529
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200530 return ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(mode);
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000531}
532
533/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000534 * \brief This function returns the size of the IV or nonce
535 * of the cipher, in Bytes.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000536 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500537 * \param ctx The context of the cipher. This must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000538 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100539 * \return The recommended IV size if no IV has been set.
Rose Zadik4c368e82018-04-19 14:24:11 +0100540 * \return \c 0 for ciphers not using an IV or a nonce.
Rose Zadikb5607bf2018-04-16 10:34:51 +0100541 * \return The actual size if an IV has been set.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000542 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000543static inline int mbedtls_cipher_get_iv_size(
544 const mbedtls_cipher_context_t *ctx )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000545{
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500546 MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, 0 );
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200547 if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000548 return 0;
549
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200550 if( ctx->MBEDTLS_PRIVATE(iv_size) != 0 )
551 return (int) ctx->MBEDTLS_PRIVATE(iv_size);
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200552
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200553 return (int) ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(iv_size);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000554}
555
556/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000557 * \brief This function returns the type of the given cipher.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000558 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500559 * \param ctx The context of the cipher. This must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000560 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100561 * \return The type of the cipher.
562 * \return #MBEDTLS_CIPHER_NONE if \p ctx has not been initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000563 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000564static inline mbedtls_cipher_type_t mbedtls_cipher_get_type(
565 const mbedtls_cipher_context_t *ctx )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000566{
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500567 MBEDTLS_INTERNAL_VALIDATE_RET(
568 ctx != NULL, MBEDTLS_CIPHER_NONE );
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200569 if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570 return MBEDTLS_CIPHER_NONE;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000571
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200572 return ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(type);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000573}
574
575/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000576 * \brief This function returns the name of the given cipher
577 * as a string.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000578 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500579 * \param ctx The context of the cipher. This must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000580 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100581 * \return The name of the cipher.
582 * \return NULL if \p ctx has not been not initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000583 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000584static inline const char *mbedtls_cipher_get_name(
585 const mbedtls_cipher_context_t *ctx )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000586{
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500587 MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, 0 );
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200588 if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000589 return 0;
590
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200591 return ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(name);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000592}
593
594/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000595 * \brief This function returns the key length of the cipher.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000596 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500597 * \param ctx The context of the cipher. This must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000598 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100599 * \return The key length of the cipher in bits.
600 * \return #MBEDTLS_KEY_LENGTH_NONE if ctx \p has not been
Rose Zadik9ba6b622018-01-24 12:59:19 +0000601 * initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000602 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000603static inline int mbedtls_cipher_get_key_bitlen(
604 const mbedtls_cipher_context_t *ctx )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000605{
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500606 MBEDTLS_INTERNAL_VALIDATE_RET(
607 ctx != NULL, MBEDTLS_KEY_LENGTH_NONE );
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200608 if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200609 return MBEDTLS_KEY_LENGTH_NONE;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000610
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200611 return (int) ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(key_bitlen);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000612}
613
614/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000615 * \brief This function returns the operation of the given cipher.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000616 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500617 * \param ctx The context of the cipher. This must be initialized.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000618 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100619 * \return The type of operation: #MBEDTLS_ENCRYPT or #MBEDTLS_DECRYPT.
620 * \return #MBEDTLS_OPERATION_NONE if \p ctx has not been initialized.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000621 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000622static inline mbedtls_operation_t mbedtls_cipher_get_operation(
623 const mbedtls_cipher_context_t *ctx )
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000624{
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500625 MBEDTLS_INTERNAL_VALIDATE_RET(
626 ctx != NULL, MBEDTLS_OPERATION_NONE );
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200627 if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200628 return MBEDTLS_OPERATION_NONE;
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000629
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200630 return ctx->MBEDTLS_PRIVATE(operation);
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000631}
632
633/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000634 * \brief This function sets the key to use with the given context.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000635 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500636 * \param ctx The generic cipher context. This must be initialized and
637 * bound to a cipher information structure.
638 * \param key The key to use. This must be a readable buffer of at
639 * least \p key_bitlen Bits.
640 * \param key_bitlen The key length to use, in Bits.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000641 * \param operation The operation that the key will be used for:
642 * #MBEDTLS_ENCRYPT or #MBEDTLS_DECRYPT.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000643 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100644 * \return \c 0 on success.
Rose Zadik4c368e82018-04-19 14:24:11 +0100645 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
646 * parameter-verification failure.
Rose Zadikb5607bf2018-04-16 10:34:51 +0100647 * \return A cipher-specific error code on failure.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000648 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000649int mbedtls_cipher_setkey( mbedtls_cipher_context_t *ctx,
650 const unsigned char *key,
651 int key_bitlen,
652 const mbedtls_operation_t operation );
Paul Bakker8123e9d2011-01-06 15:37:30 +0000653
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200654#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Paul Bakker8123e9d2011-01-06 15:37:30 +0000655/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000656 * \brief This function sets the padding mode, for cipher modes
657 * that use padding.
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200658 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000659 * The default passing mode is PKCS7 padding.
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200660 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500661 * \param ctx The generic cipher context. This must be initialized and
662 * bound to a cipher information structure.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000663 * \param mode The padding mode.
664 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100665 * \return \c 0 on success.
Rose Zadik02f73a62018-03-26 18:02:32 +0100666 * \return #MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE
667 * if the selected padding mode is not supported.
668 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA if the cipher mode
Paul Bakker1a45d912013-08-14 12:04:26 +0200669 * does not support padding.
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200670 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000671int mbedtls_cipher_set_padding_mode( mbedtls_cipher_context_t *ctx,
672 mbedtls_cipher_padding_t mode );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200673#endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200674
675/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000676 * \brief This function sets the initialization vector (IV)
677 * or nonce.
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200678 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100679 * \note Some ciphers do not use IVs nor nonce. For these
680 * ciphers, this function has no effect.
681 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500682 * \param ctx The generic cipher context. This must be initialized and
683 * bound to a cipher information structure.
684 * \param iv The IV to use, or NONCE_COUNTER for CTR-mode ciphers. This
685 * must be a readable buffer of at least \p iv_len Bytes.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000686 * \param iv_len The IV length for ciphers with variable-size IV.
687 * This parameter is discarded by ciphers with fixed-size IV.
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200688 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100689 * \return \c 0 on success.
Rose Zadik4c368e82018-04-19 14:24:11 +0100690 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
691 * parameter-verification failure.
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200692 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693int mbedtls_cipher_set_iv( mbedtls_cipher_context_t *ctx,
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500694 const unsigned char *iv,
695 size_t iv_len );
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200696
697/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000698 * \brief This function resets the cipher state.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000699 *
Manuel Pégourié-Gonnardc42a0be2021-05-31 11:13:35 +0200700 * \note With non-AEAD ciphers, the order of calls for each message
701 * is as follows:
702 * 1. mbedtls_cipher_set_iv() if the mode uses an IV/nonce.
703 * 2. mbedtls_cipher_reset()
704 * 3. mbedtls_cipher_update() one or more times
705 * 4. mbedtls_cipher_finish()
706 * .
Manuel Pégourié-Gonnard42eba1a2021-05-31 12:14:02 +0200707 * This sequence can be repeated to encrypt or decrypt multiple
Manuel Pégourié-Gonnardc42a0be2021-05-31 11:13:35 +0200708 * messages with the same key.
709 *
710 * \note With AEAD ciphers, the order of calls for each message
711 * is as follows:
712 * 1. mbedtls_cipher_set_iv() if the mode uses an IV/nonce.
713 * 2. mbedtls_cipher_reset()
714 * 3. mbedtls_cipher_update_ad()
715 * 4. mbedtls_cipher_update() one or more times
716 * 5. mbedtls_cipher_finish()
717 * 6. mbedtls_cipher_check_tag() (for decryption) or
718 * mbedtls_cipher_write_tag() (for encryption).
719 * .
Manuel Pégourié-Gonnard42eba1a2021-05-31 12:14:02 +0200720 * This sequence can be repeated to encrypt or decrypt multiple
Manuel Pégourié-Gonnardc42a0be2021-05-31 11:13:35 +0200721 * messages with the same key.
722 *
723 * \param ctx The generic cipher context. This must be bound to a key.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000724 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100725 * \return \c 0 on success.
Rose Zadik4c368e82018-04-19 14:24:11 +0100726 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
727 * parameter-verification failure.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200729int mbedtls_cipher_reset( mbedtls_cipher_context_t *ctx );
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200730
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +0200731#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200732/**
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500733 * \brief This function adds additional data for AEAD ciphers.
734 * Currently supported with GCM and ChaCha20+Poly1305.
735 * This must be called exactly once, after
736 * mbedtls_cipher_reset().
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200737 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500738 * \param ctx The generic cipher context. This must be initialized.
739 * \param ad The additional data to use. This must be a readable
740 * buffer of at least \p ad_len Bytes.
Andrzej Kurek02f39ac2019-02-08 06:50:55 -0500741 * \param ad_len The length of \p ad in Bytes.
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200742 *
Andrzej Kurek57f04e52019-02-08 06:44:43 -0500743 * \return \c 0 on success.
744 * \return A specific error code on failure.
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746int mbedtls_cipher_update_ad( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200747 const unsigned char *ad, size_t ad_len );
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +0200748#endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000749
750/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000751 * \brief The generic cipher update function. It encrypts or
752 * decrypts using the given cipher context. Writes as
753 * many block-sized blocks of data as possible to output.
754 * Any data that cannot be written immediately is either
755 * added to the next block, or flushed when
756 * mbedtls_cipher_finish() is called.
757 * Exception: For MBEDTLS_MODE_ECB, expects a single block
758 * in size. For example, 16 Bytes for AES.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000759 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500760 * \param ctx The generic cipher context. This must be initialized and
761 * bound to a key.
762 * \param input The buffer holding the input data. This must be a
763 * readable buffer of at least \p ilen Bytes.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000764 * \param ilen The length of the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500765 * \param output The buffer for the output data. This must be able to
766 * hold at least `ilen + block_size`. This must not be the
767 * same buffer as \p input.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000768 * \param olen The length of the output data, to be updated with the
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500769 * actual number of Bytes written. This must not be
770 * \c NULL.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000771 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100772 * \return \c 0 on success.
Rose Zadik4c368e82018-04-19 14:24:11 +0100773 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
774 * parameter-verification failure.
Rose Zadik02f73a62018-03-26 18:02:32 +0100775 * \return #MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE on an
776 * unsupported mode for a cipher.
Rose Zadikb5607bf2018-04-16 10:34:51 +0100777 * \return A cipher-specific error code on failure.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000778 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000779int mbedtls_cipher_update( mbedtls_cipher_context_t *ctx,
780 const unsigned char *input,
781 size_t ilen, unsigned char *output,
782 size_t *olen );
Paul Bakker8123e9d2011-01-06 15:37:30 +0000783
784/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000785 * \brief The generic cipher finalization function. If data still
786 * needs to be flushed from an incomplete block, the data
787 * contained in it is padded to the size of
788 * the last block, and written to the \p output buffer.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000789 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500790 * \param ctx The generic cipher context. This must be initialized and
791 * bound to a key.
792 * \param output The buffer to write data to. This needs to be a writable
793 * buffer of at least \p block_size Bytes.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000794 * \param olen The length of the data written to the \p output buffer.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500795 * This may not be \c NULL.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000796 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100797 * \return \c 0 on success.
Rose Zadik4c368e82018-04-19 14:24:11 +0100798 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
799 * parameter-verification failure.
800 * \return #MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED on decryption
801 * expecting a full block but not receiving one.
Rose Zadik02f73a62018-03-26 18:02:32 +0100802 * \return #MBEDTLS_ERR_CIPHER_INVALID_PADDING on invalid padding
803 * while decrypting.
Rose Zadikb5607bf2018-04-16 10:34:51 +0100804 * \return A cipher-specific error code on failure.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000805 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200806int mbedtls_cipher_finish( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200807 unsigned char *output, size_t *olen );
808
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +0200809#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200810/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000811 * \brief This function writes a tag for AEAD ciphers.
Daniel King8fe47012016-05-17 20:33:28 -0300812 * Currently supported with GCM and ChaCha20+Poly1305.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500813 * This must be called after mbedtls_cipher_finish().
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200814 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500815 * \param ctx The generic cipher context. This must be initialized,
816 * bound to a key, and have just completed a cipher
817 * operation through mbedtls_cipher_finish() the tag for
818 * which should be written.
819 * \param tag The buffer to write the tag to. This must be a writable
820 * buffer of at least \p tag_len Bytes.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000821 * \param tag_len The length of the tag to write.
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200822 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100823 * \return \c 0 on success.
824 * \return A specific error code on failure.
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200825 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200826int mbedtls_cipher_write_tag( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200827 unsigned char *tag, size_t tag_len );
828
829/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000830 * \brief This function checks the tag for AEAD ciphers.
Daniel King8fe47012016-05-17 20:33:28 -0300831 * Currently supported with GCM and ChaCha20+Poly1305.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500832 * This must be called after mbedtls_cipher_finish().
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200833 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500834 * \param ctx The generic cipher context. This must be initialized.
835 * \param tag The buffer holding the tag. This must be a readable
836 * buffer of at least \p tag_len Bytes.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000837 * \param tag_len The length of the tag to check.
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200838 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100839 * \return \c 0 on success.
840 * \return A specific error code on failure.
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200841 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200842int mbedtls_cipher_check_tag( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200843 const unsigned char *tag, size_t tag_len );
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +0200844#endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000845
Paul Bakker8123e9d2011-01-06 15:37:30 +0000846/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000847 * \brief The generic all-in-one encryption/decryption function,
848 * for all ciphers except AEAD constructs.
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +0200849 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500850 * \param ctx The generic cipher context. This must be initialized.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000851 * \param iv The IV to use, or NONCE_COUNTER for CTR-mode ciphers.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500852 * This must be a readable buffer of at least \p iv_len
853 * Bytes.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000854 * \param iv_len The IV length for ciphers with variable-size IV.
855 * This parameter is discarded by ciphers with fixed-size
856 * IV.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500857 * \param input The buffer holding the input data. This must be a
858 * readable buffer of at least \p ilen Bytes.
859 * \param ilen The length of the input data in Bytes.
860 * \param output The buffer for the output data. This must be able to
861 * hold at least `ilen + block_size`. This must not be the
862 * same buffer as \p input.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000863 * \param olen The length of the output data, to be updated with the
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500864 * actual number of Bytes written. This must not be
865 * \c NULL.
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +0200866 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000867 * \note Some ciphers do not use IVs nor nonce. For these
868 * ciphers, use \p iv = NULL and \p iv_len = 0.
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +0200869 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100870 * \return \c 0 on success.
Rose Zadik4c368e82018-04-19 14:24:11 +0100871 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
872 * parameter-verification failure.
873 * \return #MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED on decryption
874 * expecting a full block but not receiving one.
Rose Zadik02f73a62018-03-26 18:02:32 +0100875 * \return #MBEDTLS_ERR_CIPHER_INVALID_PADDING on invalid padding
876 * while decrypting.
Rose Zadikb5607bf2018-04-16 10:34:51 +0100877 * \return A cipher-specific error code on failure.
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +0200878 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200879int mbedtls_cipher_crypt( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +0200880 const unsigned char *iv, size_t iv_len,
881 const unsigned char *input, size_t ilen,
882 unsigned char *output, size_t *olen );
883
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +0100884#if defined(MBEDTLS_CIPHER_MODE_AEAD) || defined(MBEDTLS_NIST_KW_C)
885/**
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +0100886 * \brief The authenticated encryption (AEAD/NIST_KW) function.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +0100887 *
888 * \note For AEAD modes, the tag will be appended to the
889 * ciphertext, as recommended by RFC 5116.
890 * (NIST_KW doesn't have a separate tag.)
891 *
892 * \param ctx The generic cipher context. This must be initialized and
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +0100893 * bound to a key, with an AEAD algorithm or NIST_KW.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +0100894 * \param iv The nonce to use. This must be a readable buffer of
895 * at least \p iv_len Bytes and may be \c NULL if \p
896 * iv_len is \c 0.
Manuel Pégourié-Gonnardb23e31d2020-12-07 09:57:35 +0100897 * \param iv_len The length of the nonce. For AEAD ciphers, this must
898 * satisfy the constraints imposed by the cipher used.
899 * For NIST_KW, this must be \c 0.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +0100900 * \param ad The additional data to authenticate. This must be a
901 * readable buffer of at least \p ad_len Bytes, and may
902 * be \c NULL is \p ad_len is \c 0.
903 * \param ad_len The length of \p ad. For NIST_KW, this must be \c 0.
904 * \param input The buffer holding the input data. This must be a
905 * readable buffer of at least \p ilen Bytes, and may be
906 * \c NULL if \p ilen is \c 0.
907 * \param ilen The length of the input data.
908 * \param output The buffer for the output data. This must be a
909 * writable buffer of at least \p output_len Bytes, and
910 * must not be \c NULL.
911 * \param output_len The length of the \p output buffer in Bytes. For AEAD
912 * ciphers, this must be at least \p ilen + \p tag_len.
913 * For NIST_KW, this must be at least \p ilen + 8
914 * (rounded up to a multiple of 8 if KWP is used);
915 * \p ilen + 15 is always a safe value.
916 * \param olen This will be filled with the actual number of Bytes
917 * written to the \p output buffer. This must point to a
918 * writable object of type \c size_t.
919 * \param tag_len The desired length of the authentication tag. For AEAD
920 * ciphers, this must match the constraints imposed by
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +0100921 * the cipher used, and in particular must not be \c 0.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +0100922 * For NIST_KW, this must be \c 0.
923 *
924 * \return \c 0 on success.
925 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
926 * parameter-verification failure.
927 * \return A cipher-specific error code on failure.
928 */
929int mbedtls_cipher_auth_encrypt_ext( mbedtls_cipher_context_t *ctx,
930 const unsigned char *iv, size_t iv_len,
931 const unsigned char *ad, size_t ad_len,
932 const unsigned char *input, size_t ilen,
933 unsigned char *output, size_t output_len,
934 size_t *olen, size_t tag_len );
935
936/**
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +0100937 * \brief The authenticated encryption (AEAD/NIST_KW) function.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +0100938 *
939 * \note If the data is not authentic, then the output buffer
940 * is zeroed out to prevent the unauthentic plaintext being
941 * used, making this interface safer.
942 *
943 * \note For AEAD modes, the tag must be appended to the
944 * ciphertext, as recommended by RFC 5116.
945 * (NIST_KW doesn't have a separate tag.)
946 *
947 * \param ctx The generic cipher context. This must be initialized and
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +0100948 * bound to a key, with an AEAD algorithm or NIST_KW.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +0100949 * \param iv The nonce to use. This must be a readable buffer of
950 * at least \p iv_len Bytes and may be \c NULL if \p
951 * iv_len is \c 0.
Manuel Pégourié-Gonnardb23e31d2020-12-07 09:57:35 +0100952 * \param iv_len The length of the nonce. For AEAD ciphers, this must
953 * satisfy the constraints imposed by the cipher used.
954 * For NIST_KW, this must be \c 0.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +0100955 * \param ad The additional data to authenticate. This must be a
956 * readable buffer of at least \p ad_len Bytes, and may
957 * be \c NULL is \p ad_len is \c 0.
958 * \param ad_len The length of \p ad. For NIST_KW, this must be \c 0.
959 * \param input The buffer holding the input data. This must be a
960 * readable buffer of at least \p ilen Bytes, and may be
961 * \c NULL if \p ilen is \c 0.
962 * \param ilen The length of the input data. For AEAD ciphers this
963 * must be at least \p tag_len. For NIST_KW this must be
964 * at least \c 8.
965 * \param output The buffer for the output data. This must be a
966 * writable buffer of at least \p output_len Bytes, and
967 * may be \c NULL if \p output_len is \c 0.
968 * \param output_len The length of the \p output buffer in Bytes. For AEAD
969 * ciphers, this must be at least \p ilen - \p tag_len.
970 * For NIST_KW, this must be at least \p ilen - 8.
971 * \param olen This will be filled with the actual number of Bytes
972 * written to the \p output buffer. This must point to a
973 * writable object of type \c size_t.
974 * \param tag_len The actual length of the authentication tag. For AEAD
975 * ciphers, this must match the constraints imposed by
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +0100976 * the cipher used, and in particular must not be \c 0.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +0100977 * For NIST_KW, this must be \c 0.
978 *
979 * \return \c 0 on success.
980 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
981 * parameter-verification failure.
982 * \return #MBEDTLS_ERR_CIPHER_AUTH_FAILED if data is not authentic.
983 * \return A cipher-specific error code on failure.
984 */
985int mbedtls_cipher_auth_decrypt_ext( mbedtls_cipher_context_t *ctx,
986 const unsigned char *iv, size_t iv_len,
987 const unsigned char *ad, size_t ad_len,
988 const unsigned char *input, size_t ilen,
989 unsigned char *output, size_t output_len,
990 size_t *olen, size_t tag_len );
991#endif /* MBEDTLS_CIPHER_MODE_AEAD || MBEDTLS_NIST_KW_C */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000992#ifdef __cplusplus
993}
994#endif
995
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996#endif /* MBEDTLS_CIPHER_H */