blob: 1cafa6ec2e382204aaaaa55868e6d4dd62533596 [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
Paul Bakker8123e9d2011-01-06 15:37:30 +000029
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020030#if !defined(MBEDTLS_CONFIG_FILE)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010031#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020032#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020033#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020034#endif
Manuel Pégourié-Gonnard43a47802013-09-03 16:35:53 +020035
Rich Evans00ab4702015-02-06 13:43:58 +000036#include <stddef.h>
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010037#include "mbedtls/platform_util.h"
Rich Evans00ab4702015-02-06 13:43:58 +000038
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +020039#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020040#define MBEDTLS_CIPHER_MODE_AEAD
Manuel Pégourié-Gonnard43a47802013-09-03 16:35:53 +020041#endif
42
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020043#if defined(MBEDTLS_CIPHER_MODE_CBC)
44#define MBEDTLS_CIPHER_MODE_WITH_PADDING
Manuel Pégourié-Gonnard989ed382013-09-13 14:41:45 +020045#endif
46
Simon Butcherc7965732018-07-27 17:13:39 +010047#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER) || \
48 defined(MBEDTLS_CHACHA20_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020049#define MBEDTLS_CIPHER_MODE_STREAM
Manuel Pégourié-Gonnardb8ca7232014-12-02 10:09:10 +010050#endif
51
Manuel Pégourié-Gonnard0223ab92015-10-05 11:40:01 +010052#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
53 !defined(inline) && !defined(__cplusplus)
Paul Bakker569df2c2011-06-21 07:48:07 +000054#define inline __inline
Manuel Pégourié-Gonnard20af64d2015-07-07 18:33:39 +020055#endif
Paul Bakkeraf5c85f2011-04-18 03:47:52 +000056
Rose Zadik9ba6b622018-01-24 12:59:19 +000057#define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080 /**< The selected feature is not available. */
58#define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100 /**< Bad input parameters. */
59#define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180 /**< Failed to allocate memory. */
60#define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200 /**< Input data contains invalid padding and is rejected. */
61#define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280 /**< Decryption of block requires a full block. */
62#define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300 /**< Authentication failed (for AEAD modes). */
63#define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380 /**< The context is invalid. For example, because it was freed. */
Ron Eldor9924bdc2018-10-04 10:59:13 +030064
65/* MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED is deprecated and should not be used. */
Rose Zadik9ba6b622018-01-24 12:59:19 +000066#define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED -0x6400 /**< Cipher hardware accelerator failed. */
Paul Bakker343a8702011-06-09 14:27:58 +000067
Rose Zadik9ba6b622018-01-24 12:59:19 +000068#define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01 /**< Cipher accepts IVs of variable length. */
69#define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02 /**< Cipher accepts keys of variable length. */
Manuel Pégourié-Gonnard81754a02014-06-23 11:33:18 +020070
Paul Bakker407a0da2013-06-27 14:29:21 +020071#ifdef __cplusplus
72extern "C" {
73#endif
74
Hanno Beckerbbca8c52017-09-25 14:53:51 +010075/**
Rose Zadik02f73a62018-03-26 18:02:32 +010076 * \brief Supported cipher types.
Hanno Beckerbbca8c52017-09-25 14:53:51 +010077 *
Rose Zadik826f2642018-04-19 14:01:29 +010078 * \warning RC4 and DES are considered weak ciphers and their use
Rose Zadikb5607bf2018-04-16 10:34:51 +010079 * constitutes a security risk. Arm recommends considering stronger
80 * ciphers instead.
Hanno Beckerbbca8c52017-09-25 14:53:51 +010081 */
Paul Bakker8123e9d2011-01-06 15:37:30 +000082typedef enum {
Rose Zadik4c368e82018-04-19 14:24:11 +010083 MBEDTLS_CIPHER_ID_NONE = 0, /**< Placeholder to mark the end of cipher ID lists. */
84 MBEDTLS_CIPHER_ID_NULL, /**< The identity cipher, treated as a stream cipher. */
Rose Zadik02f73a62018-03-26 18:02:32 +010085 MBEDTLS_CIPHER_ID_AES, /**< The AES cipher. */
86 MBEDTLS_CIPHER_ID_DES, /**< The DES cipher. */
Rose Zadik93f99192018-04-19 14:41:33 +010087 MBEDTLS_CIPHER_ID_3DES, /**< The Triple DES cipher. */
Rose Zadik02f73a62018-03-26 18:02:32 +010088 MBEDTLS_CIPHER_ID_CAMELLIA, /**< The Camellia cipher. */
89 MBEDTLS_CIPHER_ID_BLOWFISH, /**< The Blowfish cipher. */
Rose Zadik826f2642018-04-19 14:01:29 +010090 MBEDTLS_CIPHER_ID_ARC4, /**< The RC4 cipher. */
Manuel Pégourié-Gonnarda3712be2018-05-22 15:58:50 +020091 MBEDTLS_CIPHER_ID_ARIA, /**< The Aria cipher. */
Manuel Pégourié-Gonnardb500f8b2018-05-08 12:43:48 +020092 MBEDTLS_CIPHER_ID_CHACHA20, /**< The ChaCha20 cipher. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020093} mbedtls_cipher_id_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +000094
Hanno Beckerbbca8c52017-09-25 14:53:51 +010095/**
Rose Zadik02f73a62018-03-26 18:02:32 +010096 * \brief Supported {cipher type, cipher mode} pairs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +010097 *
Rose Zadik826f2642018-04-19 14:01:29 +010098 * \warning RC4 and DES are considered weak ciphers and their use
Rose Zadikb5607bf2018-04-16 10:34:51 +010099 * constitutes a security risk. Arm recommends considering stronger
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100100 * ciphers instead.
101 */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000102typedef enum {
Rose Zadik4c368e82018-04-19 14:24:11 +0100103 MBEDTLS_CIPHER_NONE = 0, /**< Placeholder to mark the end of cipher-pair lists. */
Rose Zadikc441f742018-04-19 14:38:20 +0100104 MBEDTLS_CIPHER_NULL, /**< The identity stream cipher. */
Rose Zadik02f73a62018-03-26 18:02:32 +0100105 MBEDTLS_CIPHER_AES_128_ECB, /**< AES cipher with 128-bit ECB mode. */
106 MBEDTLS_CIPHER_AES_192_ECB, /**< AES cipher with 192-bit ECB mode. */
107 MBEDTLS_CIPHER_AES_256_ECB, /**< AES cipher with 256-bit ECB mode. */
108 MBEDTLS_CIPHER_AES_128_CBC, /**< AES cipher with 128-bit CBC mode. */
109 MBEDTLS_CIPHER_AES_192_CBC, /**< AES cipher with 192-bit CBC mode. */
110 MBEDTLS_CIPHER_AES_256_CBC, /**< AES cipher with 256-bit CBC mode. */
111 MBEDTLS_CIPHER_AES_128_CFB128, /**< AES cipher with 128-bit CFB128 mode. */
112 MBEDTLS_CIPHER_AES_192_CFB128, /**< AES cipher with 192-bit CFB128 mode. */
113 MBEDTLS_CIPHER_AES_256_CFB128, /**< AES cipher with 256-bit CFB128 mode. */
114 MBEDTLS_CIPHER_AES_128_CTR, /**< AES cipher with 128-bit CTR mode. */
115 MBEDTLS_CIPHER_AES_192_CTR, /**< AES cipher with 192-bit CTR mode. */
116 MBEDTLS_CIPHER_AES_256_CTR, /**< AES cipher with 256-bit CTR mode. */
117 MBEDTLS_CIPHER_AES_128_GCM, /**< AES cipher with 128-bit GCM mode. */
118 MBEDTLS_CIPHER_AES_192_GCM, /**< AES cipher with 192-bit GCM mode. */
119 MBEDTLS_CIPHER_AES_256_GCM, /**< AES cipher with 256-bit GCM mode. */
120 MBEDTLS_CIPHER_CAMELLIA_128_ECB, /**< Camellia cipher with 128-bit ECB mode. */
121 MBEDTLS_CIPHER_CAMELLIA_192_ECB, /**< Camellia cipher with 192-bit ECB mode. */
122 MBEDTLS_CIPHER_CAMELLIA_256_ECB, /**< Camellia cipher with 256-bit ECB mode. */
123 MBEDTLS_CIPHER_CAMELLIA_128_CBC, /**< Camellia cipher with 128-bit CBC mode. */
124 MBEDTLS_CIPHER_CAMELLIA_192_CBC, /**< Camellia cipher with 192-bit CBC mode. */
125 MBEDTLS_CIPHER_CAMELLIA_256_CBC, /**< Camellia cipher with 256-bit CBC mode. */
126 MBEDTLS_CIPHER_CAMELLIA_128_CFB128, /**< Camellia cipher with 128-bit CFB128 mode. */
127 MBEDTLS_CIPHER_CAMELLIA_192_CFB128, /**< Camellia cipher with 192-bit CFB128 mode. */
128 MBEDTLS_CIPHER_CAMELLIA_256_CFB128, /**< Camellia cipher with 256-bit CFB128 mode. */
129 MBEDTLS_CIPHER_CAMELLIA_128_CTR, /**< Camellia cipher with 128-bit CTR mode. */
130 MBEDTLS_CIPHER_CAMELLIA_192_CTR, /**< Camellia cipher with 192-bit CTR mode. */
131 MBEDTLS_CIPHER_CAMELLIA_256_CTR, /**< Camellia cipher with 256-bit CTR mode. */
132 MBEDTLS_CIPHER_CAMELLIA_128_GCM, /**< Camellia cipher with 128-bit GCM mode. */
133 MBEDTLS_CIPHER_CAMELLIA_192_GCM, /**< Camellia cipher with 192-bit GCM mode. */
134 MBEDTLS_CIPHER_CAMELLIA_256_GCM, /**< Camellia cipher with 256-bit GCM mode. */
135 MBEDTLS_CIPHER_DES_ECB, /**< DES cipher with ECB mode. */
136 MBEDTLS_CIPHER_DES_CBC, /**< DES cipher with CBC mode. */
137 MBEDTLS_CIPHER_DES_EDE_ECB, /**< DES cipher with EDE ECB mode. */
138 MBEDTLS_CIPHER_DES_EDE_CBC, /**< DES cipher with EDE CBC mode. */
139 MBEDTLS_CIPHER_DES_EDE3_ECB, /**< DES cipher with EDE3 ECB mode. */
140 MBEDTLS_CIPHER_DES_EDE3_CBC, /**< DES cipher with EDE3 CBC mode. */
141 MBEDTLS_CIPHER_BLOWFISH_ECB, /**< Blowfish cipher with ECB mode. */
142 MBEDTLS_CIPHER_BLOWFISH_CBC, /**< Blowfish cipher with CBC mode. */
143 MBEDTLS_CIPHER_BLOWFISH_CFB64, /**< Blowfish cipher with CFB64 mode. */
144 MBEDTLS_CIPHER_BLOWFISH_CTR, /**< Blowfish cipher with CTR mode. */
Rose Zadik826f2642018-04-19 14:01:29 +0100145 MBEDTLS_CIPHER_ARC4_128, /**< RC4 cipher with 128-bit mode. */
Rose Zadik02f73a62018-03-26 18:02:32 +0100146 MBEDTLS_CIPHER_AES_128_CCM, /**< AES cipher with 128-bit CCM mode. */
147 MBEDTLS_CIPHER_AES_192_CCM, /**< AES cipher with 192-bit CCM mode. */
148 MBEDTLS_CIPHER_AES_256_CCM, /**< AES cipher with 256-bit CCM mode. */
149 MBEDTLS_CIPHER_CAMELLIA_128_CCM, /**< Camellia cipher with 128-bit CCM mode. */
150 MBEDTLS_CIPHER_CAMELLIA_192_CCM, /**< Camellia cipher with 192-bit CCM mode. */
151 MBEDTLS_CIPHER_CAMELLIA_256_CCM, /**< Camellia cipher with 256-bit CCM mode. */
Manuel Pégourié-Gonnarda3712be2018-05-22 15:58:50 +0200152 MBEDTLS_CIPHER_ARIA_128_ECB, /**< Aria cipher with 128-bit key and ECB mode. */
153 MBEDTLS_CIPHER_ARIA_192_ECB, /**< Aria cipher with 192-bit key and ECB mode. */
154 MBEDTLS_CIPHER_ARIA_256_ECB, /**< Aria cipher with 256-bit key and ECB mode. */
155 MBEDTLS_CIPHER_ARIA_128_CBC, /**< Aria cipher with 128-bit key and CBC mode. */
156 MBEDTLS_CIPHER_ARIA_192_CBC, /**< Aria cipher with 192-bit key and CBC mode. */
157 MBEDTLS_CIPHER_ARIA_256_CBC, /**< Aria cipher with 256-bit key and CBC mode. */
158 MBEDTLS_CIPHER_ARIA_128_CFB128, /**< Aria cipher with 128-bit key and CFB-128 mode. */
159 MBEDTLS_CIPHER_ARIA_192_CFB128, /**< Aria cipher with 192-bit key and CFB-128 mode. */
160 MBEDTLS_CIPHER_ARIA_256_CFB128, /**< Aria cipher with 256-bit key and CFB-128 mode. */
161 MBEDTLS_CIPHER_ARIA_128_CTR, /**< Aria cipher with 128-bit key and CTR mode. */
162 MBEDTLS_CIPHER_ARIA_192_CTR, /**< Aria cipher with 192-bit key and CTR mode. */
163 MBEDTLS_CIPHER_ARIA_256_CTR, /**< Aria cipher with 256-bit key and CTR mode. */
164 MBEDTLS_CIPHER_ARIA_128_GCM, /**< Aria cipher with 128-bit key and GCM mode. */
165 MBEDTLS_CIPHER_ARIA_192_GCM, /**< Aria cipher with 192-bit key and GCM mode. */
166 MBEDTLS_CIPHER_ARIA_256_GCM, /**< Aria cipher with 256-bit key and GCM mode. */
167 MBEDTLS_CIPHER_ARIA_128_CCM, /**< Aria cipher with 128-bit key and CCM mode. */
168 MBEDTLS_CIPHER_ARIA_192_CCM, /**< Aria cipher with 192-bit key and CCM mode. */
169 MBEDTLS_CIPHER_ARIA_256_CCM, /**< Aria cipher with 256-bit key and CCM mode. */
Simon Butcher6873c842018-04-29 13:03:20 +0100170 MBEDTLS_CIPHER_AES_128_OFB, /**< AES 128-bit cipher in OFB mode. */
171 MBEDTLS_CIPHER_AES_192_OFB, /**< AES 192-bit cipher in OFB mode. */
172 MBEDTLS_CIPHER_AES_256_OFB, /**< AES 256-bit cipher in OFB mode. */
Jaeden Ameroc6539902018-04-30 17:17:41 +0100173 MBEDTLS_CIPHER_AES_128_XTS, /**< AES 128-bit cipher in XTS block mode. */
174 MBEDTLS_CIPHER_AES_256_XTS, /**< AES 256-bit cipher in XTS block mode. */
Manuel Pégourié-Gonnardb500f8b2018-05-08 12:43:48 +0200175 MBEDTLS_CIPHER_CHACHA20, /**< ChaCha20 stream cipher. */
176 MBEDTLS_CIPHER_CHACHA20_POLY1305, /**< ChaCha20-Poly1305 AEAD cipher. */
Jack Lloydffdf2882019-03-07 17:00:32 -0500177 MBEDTLS_CIPHER_AES_128_KW, /**< AES cipher with 128-bit NIST KW mode. */
178 MBEDTLS_CIPHER_AES_192_KW, /**< AES cipher with 192-bit NIST KW mode. */
179 MBEDTLS_CIPHER_AES_256_KW, /**< AES cipher with 256-bit NIST KW mode. */
180 MBEDTLS_CIPHER_AES_128_KWP, /**< AES cipher with 128-bit NIST KWP mode. */
181 MBEDTLS_CIPHER_AES_192_KWP, /**< AES cipher with 192-bit NIST KWP mode. */
182 MBEDTLS_CIPHER_AES_256_KWP, /**< AES cipher with 256-bit NIST KWP mode. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200183} mbedtls_cipher_type_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000184
Rose Zadik9ba6b622018-01-24 12:59:19 +0000185/** Supported cipher modes. */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000186typedef enum {
Hanno Beckere5a04502018-11-08 16:57:42 +0000187 MBEDTLS_MODE_NONE = 0, /**< None. */
188 MBEDTLS_MODE_ECB, /**< The ECB cipher mode. */
189 MBEDTLS_MODE_CBC, /**< The CBC cipher mode. */
190 MBEDTLS_MODE_CFB, /**< The CFB cipher mode. */
191 MBEDTLS_MODE_OFB, /**< The OFB cipher mode. */
192 MBEDTLS_MODE_CTR, /**< The CTR cipher mode. */
193 MBEDTLS_MODE_GCM, /**< The GCM cipher mode. */
194 MBEDTLS_MODE_STREAM, /**< The stream cipher mode. */
195 MBEDTLS_MODE_CCM, /**< The CCM cipher mode. */
196 MBEDTLS_MODE_XTS, /**< The XTS cipher mode. */
Manuel Pégourié-Gonnardf57bf8b2018-06-18 11:14:09 +0200197 MBEDTLS_MODE_CHACHAPOLY, /**< The ChaCha-Poly cipher mode. */
Jack Lloydffdf2882019-03-07 17:00:32 -0500198 MBEDTLS_MODE_KW, /**< The SP800-38F KW mode */
199 MBEDTLS_MODE_KWP, /**< The SP800-38F KWP mode */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200200} mbedtls_cipher_mode_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000201
Rose Zadik9ba6b622018-01-24 12:59:19 +0000202/** Supported cipher padding types. */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000203typedef enum {
Rose Zadik9ba6b622018-01-24 12:59:19 +0000204 MBEDTLS_PADDING_PKCS7 = 0, /**< PKCS7 padding (default). */
205 MBEDTLS_PADDING_ONE_AND_ZEROS, /**< ISO/IEC 7816-4 padding. */
206 MBEDTLS_PADDING_ZEROS_AND_LEN, /**< ANSI X.923 padding. */
Rose Zadik02f73a62018-03-26 18:02:32 +0100207 MBEDTLS_PADDING_ZEROS, /**< Zero padding (not reversible). */
208 MBEDTLS_PADDING_NONE, /**< Never pad (full blocks only). */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209} mbedtls_cipher_padding_t;
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200210
Rose Zadik9ba6b622018-01-24 12:59:19 +0000211/** Type of operation. */
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200212typedef enum {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200213 MBEDTLS_OPERATION_NONE = -1,
214 MBEDTLS_DECRYPT = 0,
215 MBEDTLS_ENCRYPT,
216} mbedtls_operation_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000217
218enum {
Rose Zadik9ba6b622018-01-24 12:59:19 +0000219 /** Undefined key length. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 MBEDTLS_KEY_LENGTH_NONE = 0,
Rose Zadik9ba6b622018-01-24 12:59:19 +0000221 /** Key length, in bits (including parity), for DES keys. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200222 MBEDTLS_KEY_LENGTH_DES = 64,
Rose Zadik9ba6b622018-01-24 12:59:19 +0000223 /** Key length in bits, including parity, for DES in two-key EDE. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200224 MBEDTLS_KEY_LENGTH_DES_EDE = 128,
Rose Zadik9ba6b622018-01-24 12:59:19 +0000225 /** Key length in bits, including parity, for DES in three-key EDE. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200226 MBEDTLS_KEY_LENGTH_DES_EDE3 = 192,
Paul Bakker8123e9d2011-01-06 15:37:30 +0000227};
228
Rose Zadik9ba6b622018-01-24 12:59:19 +0000229/** Maximum length of any IV, in Bytes. */
Hanno Becker15889832020-09-08 11:29:11 +0100230/* This should ideally be derived automatically from list of ciphers.
231 * This should be kept in sync with MBEDTLS_SSL_MAX_IV_LENGTH defined
232 * in ssl_internal.h. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200233#define MBEDTLS_MAX_IV_LENGTH 16
Hanno Becker27a26882020-08-07 11:30:05 +0100234
Rose Zadik9ba6b622018-01-24 12:59:19 +0000235/** Maximum block size of any cipher, in Bytes. */
Hanno Becker15889832020-09-08 11:29:11 +0100236/* This should ideally be derived automatically from list of ciphers.
237 * This should be kept in sync with MBEDTLS_SSL_MAX_BLOCK_LENGTH defined
238 * in ssl_internal.h. */
Manuel Pégourié-Gonnard32902e62018-05-10 12:30:19 +0200239#define MBEDTLS_MAX_BLOCK_LENGTH 16
Manuel Pégourié-Gonnard0b58c152013-10-24 17:17:54 +0200240
Hanno Becker27a26882020-08-07 11:30:05 +0100241/** Maximum key length, in Bytes. */
242/* This should ideally be derived automatically from list of ciphers.
243 * For now, only check whether XTS is enabled which uses 64 Byte keys,
Hanno Becker15889832020-09-08 11:29:11 +0100244 * and use 32 Bytes as an upper bound for the maximum key length otherwise.
245 * This should be kept in sync with MBEDTLS_SSL_MAX_BLOCK_LENGTH defined
246 * in ssl_internal.h, which however deliberately ignores the case of XTS
247 * since the latter isn't used in SSL/TLS. */
Hanno Becker27a26882020-08-07 11:30:05 +0100248#if defined(MBEDTLS_CIPHER_MODE_XTS)
249#define MBEDTLS_MAX_KEY_LENGTH 64
250#else
251#define MBEDTLS_MAX_KEY_LENGTH 32
252#endif /* MBEDTLS_CIPHER_MODE_XTS */
253
Paul Bakker8123e9d2011-01-06 15:37:30 +0000254/**
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100255 * Base cipher information (opaque struct).
Paul Bakker343a8702011-06-09 14:27:58 +0000256 */
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100257typedef struct mbedtls_cipher_base_t mbedtls_cipher_base_t;
Paul Bakker343a8702011-06-09 14:27:58 +0000258
259/**
Simon Butcher327398a2016-10-05 14:09:11 +0100260 * CMAC context (opaque struct).
261 */
262typedef struct mbedtls_cmac_context_t mbedtls_cmac_context_t;
263
264/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000265 * Cipher information. Allows calling cipher functions
266 * in a generic way.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000267 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200268typedef struct mbedtls_cipher_info_t
269{
Rose Zadik9ba6b622018-01-24 12:59:19 +0000270 /** Full cipher identifier. For example,
271 * MBEDTLS_CIPHER_AES_256_CBC.
272 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200273 mbedtls_cipher_type_t type;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000274
Rose Zadik9ba6b622018-01-24 12:59:19 +0000275 /** The cipher mode. For example, MBEDTLS_MODE_CBC. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276 mbedtls_cipher_mode_t mode;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000277
Rose Zadik9ba6b622018-01-24 12:59:19 +0000278 /** The cipher key length, in bits. This is the
279 * default length for variable sized ciphers.
280 * Includes parity bits for ciphers like DES.
281 */
Manuel Pégourié-Gonnard898e0aa2015-06-18 15:28:12 +0200282 unsigned int key_bitlen;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000283
Rose Zadik9ba6b622018-01-24 12:59:19 +0000284 /** Name of the cipher. */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000285 const char * name;
286
Rose Zadik9ba6b622018-01-24 12:59:19 +0000287 /** IV or nonce size, in Bytes.
288 * For ciphers that accept variable IV sizes,
289 * this is the recommended size.
290 */
Paul Bakker23986e52011-04-24 08:57:21 +0000291 unsigned int iv_size;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000292
Rose Zadikb5607bf2018-04-16 10:34:51 +0100293 /** Bitflag comprised of MBEDTLS_CIPHER_VARIABLE_IV_LEN and
294 * MBEDTLS_CIPHER_VARIABLE_KEY_LEN indicating whether the
295 * cipher supports variable IV or variable key sizes, respectively.
296 */
Manuel Pégourié-Gonnard81754a02014-06-23 11:33:18 +0200297 int flags;
Manuel Pégourié-Gonnarda235b5b2013-09-03 13:25:52 +0200298
Rose Zadik9ba6b622018-01-24 12:59:19 +0000299 /** The block size, in Bytes. */
Paul Bakker23986e52011-04-24 08:57:21 +0000300 unsigned int block_size;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000301
Rose Zadik9ba6b622018-01-24 12:59:19 +0000302 /** Struct for base cipher information and functions. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200303 const mbedtls_cipher_base_t *base;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000304
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200305} mbedtls_cipher_info_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000306
307/**
Paul Bakker20281562011-11-11 10:34:04 +0000308 * Generic cipher context.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000309 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200310typedef struct mbedtls_cipher_context_t
311{
Rose Zadik9ba6b622018-01-24 12:59:19 +0000312 /** Information about the associated cipher. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200313 const mbedtls_cipher_info_t *cipher_info;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000314
Rose Zadik9ba6b622018-01-24 12:59:19 +0000315 /** Key length to use. */
Manuel Pégourié-Gonnard898e0aa2015-06-18 15:28:12 +0200316 int key_bitlen;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000317
Rose Zadik9ba6b622018-01-24 12:59:19 +0000318 /** Operation that the key of the context has been
319 * initialized for.
320 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200321 mbedtls_operation_t operation;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000322
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200323#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Rose Zadik9ba6b622018-01-24 12:59:19 +0000324 /** Padding functions to use, if relevant for
325 * the specific cipher mode.
326 */
Manuel Pégourié-Gonnardac56a1a2013-07-25 12:31:10 +0200327 void (*add_padding)( unsigned char *output, size_t olen, size_t data_len );
328 int (*get_padding)( unsigned char *input, size_t ilen, size_t *data_len );
Manuel Pégourié-Gonnardb8ca7232014-12-02 10:09:10 +0100329#endif
Manuel Pégourié-Gonnardac56a1a2013-07-25 12:31:10 +0200330
Rose Zadik9ba6b622018-01-24 12:59:19 +0000331 /** Buffer for input that has not been processed yet. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200332 unsigned char unprocessed_data[MBEDTLS_MAX_BLOCK_LENGTH];
Paul Bakker8123e9d2011-01-06 15:37:30 +0000333
Rose Zadik9ba6b622018-01-24 12:59:19 +0000334 /** Number of Bytes that have not been processed yet. */
Paul Bakker23986e52011-04-24 08:57:21 +0000335 size_t unprocessed_len;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000336
Jaeden Ameroc6539902018-04-30 17:17:41 +0100337 /** Current IV or NONCE_COUNTER for CTR-mode, data unit (or sector) number
338 * for XTS-mode. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200339 unsigned char iv[MBEDTLS_MAX_IV_LENGTH];
Paul Bakker8123e9d2011-01-06 15:37:30 +0000340
Rose Zadik9ba6b622018-01-24 12:59:19 +0000341 /** IV size in Bytes, for ciphers with variable-length IVs. */
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200342 size_t iv_size;
343
Rose Zadik9ba6b622018-01-24 12:59:19 +0000344 /** The cipher-specific context. */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000345 void *cipher_ctx;
Simon Butcher327398a2016-10-05 14:09:11 +0100346
347#if defined(MBEDTLS_CMAC_C)
Rose Zadik9ba6b622018-01-24 12:59:19 +0000348 /** CMAC-specific context. */
Simon Butcher327398a2016-10-05 14:09:11 +0100349 mbedtls_cmac_context_t *cmac_ctx;
350#endif
Hanno Becker1cb36532018-11-09 16:20:29 +0000351
352#if defined(MBEDTLS_USE_PSA_CRYPTO)
353 /** Indicates whether the cipher operations should be performed
354 * by Mbed TLS' own crypto library or an external implementation
355 * of the PSA Crypto API.
Hanno Becker7909c4c2018-11-20 11:34:34 +0000356 * This is unset if the cipher context was established through
357 * mbedtls_cipher_setup(), and set if it was established through
Hanno Becker1cb36532018-11-09 16:20:29 +0000358 * mbedtls_cipher_setup_psa().
359 */
360 unsigned char psa_enabled;
361#endif /* MBEDTLS_USE_PSA_CRYPTO */
362
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200363} mbedtls_cipher_context_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000364
Paul Bakker8123e9d2011-01-06 15:37:30 +0000365/**
Hanno Beckerd7503a72018-11-08 15:55:24 +0000366 * \brief This function retrieves the list of ciphers supported
367 * by the generic cipher module.
Paul Bakker72f62662011-01-16 21:27:44 +0000368 *
Hanno Beckerd7503a72018-11-08 15:55:24 +0000369 * For any cipher identifier in the returned list, you can
370 * obtain the corresponding generic cipher information structure
371 * via mbedtls_cipher_info_from_type(), which can then be used
372 * to prepare a cipher context via mbedtls_cipher_setup().
373 *
374 *
375 * \return A statically-allocated array of cipher identifiers
376 * of type cipher_type_t. The last entry is zero.
Paul Bakker72f62662011-01-16 21:27:44 +0000377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200378const int *mbedtls_cipher_list( void );
Paul Bakker72f62662011-01-16 21:27:44 +0000379
380/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000381 * \brief This function retrieves the cipher-information
382 * structure associated with the given cipher name.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000383 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500384 * \param cipher_name Name of the cipher to search for. This must not be
385 * \c NULL.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000386 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000387 * \return The cipher information structure associated with the
Rose Zadik02f73a62018-03-26 18:02:32 +0100388 * given \p cipher_name.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500389 * \return \c NULL if the associated cipher information is not found.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000390 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200391const mbedtls_cipher_info_t *mbedtls_cipher_info_from_string( const char *cipher_name );
Paul Bakker8123e9d2011-01-06 15:37:30 +0000392
393/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000394 * \brief This function retrieves the cipher-information
395 * structure associated with the given cipher type.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000396 *
397 * \param cipher_type Type of the cipher to search for.
398 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000399 * \return The cipher information structure associated with the
Rose Zadikb5607bf2018-04-16 10:34:51 +0100400 * given \p cipher_type.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500401 * \return \c NULL if the associated cipher information is not found.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000402 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200403const mbedtls_cipher_info_t *mbedtls_cipher_info_from_type( const mbedtls_cipher_type_t cipher_type );
Paul Bakker8123e9d2011-01-06 15:37:30 +0000404
405/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000406 * \brief This function retrieves the cipher-information
407 * structure associated with the given cipher ID,
408 * key size and mode.
Paul Bakkerf46b6952013-09-09 00:08:26 +0200409 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000410 * \param cipher_id The ID of the cipher to search for. For example,
411 * #MBEDTLS_CIPHER_ID_AES.
412 * \param key_bitlen The length of the key in bits.
413 * \param mode The cipher mode. For example, #MBEDTLS_MODE_CBC.
Paul Bakkerf46b6952013-09-09 00:08:26 +0200414 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000415 * \return The cipher information structure associated with the
Rose Zadik02f73a62018-03-26 18:02:32 +0100416 * given \p cipher_id.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500417 * \return \c NULL if the associated cipher information is not found.
Paul Bakkerf46b6952013-09-09 00:08:26 +0200418 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200419const 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 +0200420 int key_bitlen,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200421 const mbedtls_cipher_mode_t mode );
Paul Bakkerf46b6952013-09-09 00:08:26 +0200422
423/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000424 * \brief This function initializes a \p cipher_context as NONE.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500425 *
426 * \param ctx The context to be initialized. This must not be \c NULL.
Paul Bakker84bbeb52014-07-01 14:53:22 +0200427 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200428void mbedtls_cipher_init( mbedtls_cipher_context_t *ctx );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200429
430/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000431 * \brief This function frees and clears the cipher-specific
432 * context of \p ctx. Freeing \p ctx itself remains the
433 * responsibility of the caller.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500434 *
435 * \param ctx The context to be freed. If this is \c NULL, the
436 * function has no effect, otherwise this must point to an
437 * initialized context.
Paul Bakker84bbeb52014-07-01 14:53:22 +0200438 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200439void mbedtls_cipher_free( mbedtls_cipher_context_t *ctx );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200440
Rose Zadik9ba6b622018-01-24 12:59:19 +0000441
Paul Bakker84bbeb52014-07-01 14:53:22 +0200442/**
Hanno Beckerb1f08722018-11-09 16:09:19 +0000443 * \brief This function initializes a cipher context for
444 * use with the given cipher primitive.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000445 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500446 * \param ctx The context to initialize. This must be initialized.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000447 * \param cipher_info The cipher to use.
Paul Bakker84bbeb52014-07-01 14:53:22 +0200448 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100449 * \return \c 0 on success.
Rose Zadik4c368e82018-04-19 14:24:11 +0100450 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
451 * parameter-verification failure.
Rose Zadik02f73a62018-03-26 18:02:32 +0100452 * \return #MBEDTLS_ERR_CIPHER_ALLOC_FAILED if allocation of the
Rose Zadik4c368e82018-04-19 14:24:11 +0100453 * cipher-specific context fails.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000454 *
455 * \internal Currently, the function also clears the structure.
456 * In future versions, the caller will be required to call
457 * mbedtls_cipher_init() on the structure first.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000458 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000459int mbedtls_cipher_setup( mbedtls_cipher_context_t *ctx,
460 const mbedtls_cipher_info_t *cipher_info );
Paul Bakker8123e9d2011-01-06 15:37:30 +0000461
Hanno Becker098c9de2018-11-09 16:10:57 +0000462#if defined(MBEDTLS_USE_PSA_CRYPTO)
463/**
464 * \brief This function initializes a cipher context for
465 * PSA-based use with the given cipher primitive.
466 *
467 * \note See #MBEDTLS_USE_PSA_CRYPTO for information on PSA.
468 *
469 * \param ctx The context to initialize. May not be \c NULL.
470 * \param cipher_info The cipher to use.
Hanno Beckerf1336402018-11-12 16:26:27 +0000471 * \param taglen For AEAD ciphers, the length in bytes of the
472 * authentication tag to use. Subsequent uses of
473 * mbedtls_cipher_auth_encrypt() or
474 * mbedtls_cipher_auth_decrypt() must provide
475 * the same tag length.
476 * For non-AEAD ciphers, the value must be \c 0.
Hanno Becker098c9de2018-11-09 16:10:57 +0000477 *
478 * \return \c 0 on success.
479 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
480 * parameter-verification failure.
481 * \return #MBEDTLS_ERR_CIPHER_ALLOC_FAILED if allocation of the
482 * cipher-specific context fails.
483 */
484int mbedtls_cipher_setup_psa( mbedtls_cipher_context_t *ctx,
Hanno Beckerf1336402018-11-12 16:26:27 +0000485 const mbedtls_cipher_info_t *cipher_info,
486 size_t taglen );
Hanno Becker098c9de2018-11-09 16:10:57 +0000487#endif /* MBEDTLS_USE_PSA_CRYPTO */
488
Paul Bakker8123e9d2011-01-06 15:37:30 +0000489/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000490 * \brief This function returns the block size of the given cipher.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000491 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500492 * \param ctx The context of the cipher. This must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000493 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500494 * \return The block size of the underlying cipher.
495 * \return \c 0 if \p ctx has not been initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000496 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000497static inline unsigned int mbedtls_cipher_get_block_size(
498 const mbedtls_cipher_context_t *ctx )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000499{
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500500 MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, 0 );
501 if( ctx->cipher_info == NULL )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000502 return 0;
503
504 return ctx->cipher_info->block_size;
505}
506
507/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000508 * \brief This function returns the mode of operation for
509 * the cipher. For example, MBEDTLS_MODE_CBC.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000510 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500511 * \param ctx The context of the cipher. This must be initialized.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000512 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100513 * \return The mode of operation.
514 * \return #MBEDTLS_MODE_NONE if \p ctx has not been initialized.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000515 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000516static inline mbedtls_cipher_mode_t mbedtls_cipher_get_cipher_mode(
517 const mbedtls_cipher_context_t *ctx )
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000518{
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500519 MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, MBEDTLS_MODE_NONE );
520 if( ctx->cipher_info == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200521 return MBEDTLS_MODE_NONE;
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000522
523 return ctx->cipher_info->mode;
524}
525
526/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000527 * \brief This function returns the size of the IV or nonce
528 * of the cipher, in Bytes.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000529 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500530 * \param ctx The context of the cipher. This must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000531 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100532 * \return The recommended IV size if no IV has been set.
Rose Zadik4c368e82018-04-19 14:24:11 +0100533 * \return \c 0 for ciphers not using an IV or a nonce.
Rose Zadikb5607bf2018-04-16 10:34:51 +0100534 * \return The actual size if an IV has been set.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000535 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000536static inline int mbedtls_cipher_get_iv_size(
537 const mbedtls_cipher_context_t *ctx )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000538{
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500539 MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, 0 );
540 if( ctx->cipher_info == NULL )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000541 return 0;
542
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200543 if( ctx->iv_size != 0 )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200544 return (int) ctx->iv_size;
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200545
Manuel Pégourié-Gonnard46c4fa12015-08-12 09:27:55 +0200546 return (int) ctx->cipher_info->iv_size;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000547}
548
549/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000550 * \brief This function returns the type of the given cipher.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000551 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500552 * \param ctx The context of the cipher. This must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000553 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100554 * \return The type of the cipher.
555 * \return #MBEDTLS_CIPHER_NONE if \p ctx has not been initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000556 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000557static inline mbedtls_cipher_type_t mbedtls_cipher_get_type(
558 const mbedtls_cipher_context_t *ctx )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000559{
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500560 MBEDTLS_INTERNAL_VALIDATE_RET(
561 ctx != NULL, MBEDTLS_CIPHER_NONE );
562 if( ctx->cipher_info == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200563 return MBEDTLS_CIPHER_NONE;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000564
565 return ctx->cipher_info->type;
566}
567
568/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000569 * \brief This function returns the name of the given cipher
570 * as a string.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000571 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500572 * \param ctx The context of the cipher. This must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000573 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100574 * \return The name of the cipher.
575 * \return NULL if \p ctx has not been not initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000576 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000577static inline const char *mbedtls_cipher_get_name(
578 const mbedtls_cipher_context_t *ctx )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000579{
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500580 MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, 0 );
581 if( ctx->cipher_info == NULL )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000582 return 0;
583
584 return ctx->cipher_info->name;
585}
586
587/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000588 * \brief This function returns the key length of the cipher.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000589 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500590 * \param ctx The context of the cipher. This must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000591 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100592 * \return The key length of the cipher in bits.
593 * \return #MBEDTLS_KEY_LENGTH_NONE if ctx \p has not been
Rose Zadik9ba6b622018-01-24 12:59:19 +0000594 * initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000595 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000596static inline int mbedtls_cipher_get_key_bitlen(
597 const mbedtls_cipher_context_t *ctx )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000598{
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500599 MBEDTLS_INTERNAL_VALIDATE_RET(
600 ctx != NULL, MBEDTLS_KEY_LENGTH_NONE );
601 if( ctx->cipher_info == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200602 return MBEDTLS_KEY_LENGTH_NONE;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000603
Manuel Pégourié-Gonnard46c4fa12015-08-12 09:27:55 +0200604 return (int) ctx->cipher_info->key_bitlen;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000605}
606
607/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000608 * \brief This function returns the operation of the given cipher.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000609 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500610 * \param ctx The context of the cipher. This must be initialized.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000611 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100612 * \return The type of operation: #MBEDTLS_ENCRYPT or #MBEDTLS_DECRYPT.
613 * \return #MBEDTLS_OPERATION_NONE if \p ctx has not been initialized.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000614 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000615static inline mbedtls_operation_t mbedtls_cipher_get_operation(
616 const mbedtls_cipher_context_t *ctx )
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000617{
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500618 MBEDTLS_INTERNAL_VALIDATE_RET(
619 ctx != NULL, MBEDTLS_OPERATION_NONE );
620 if( ctx->cipher_info == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200621 return MBEDTLS_OPERATION_NONE;
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000622
623 return ctx->operation;
624}
625
626/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000627 * \brief This function sets the key to use with the given context.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000628 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500629 * \param ctx The generic cipher context. This must be initialized and
630 * bound to a cipher information structure.
631 * \param key The key to use. This must be a readable buffer of at
632 * least \p key_bitlen Bits.
633 * \param key_bitlen The key length to use, in Bits.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000634 * \param operation The operation that the key will be used for:
635 * #MBEDTLS_ENCRYPT or #MBEDTLS_DECRYPT.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000636 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100637 * \return \c 0 on success.
Rose Zadik4c368e82018-04-19 14:24:11 +0100638 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
639 * parameter-verification failure.
Rose Zadikb5607bf2018-04-16 10:34:51 +0100640 * \return A cipher-specific error code on failure.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000641 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000642int mbedtls_cipher_setkey( mbedtls_cipher_context_t *ctx,
643 const unsigned char *key,
644 int key_bitlen,
645 const mbedtls_operation_t operation );
Paul Bakker8123e9d2011-01-06 15:37:30 +0000646
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200647#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Paul Bakker8123e9d2011-01-06 15:37:30 +0000648/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000649 * \brief This function sets the padding mode, for cipher modes
650 * that use padding.
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200651 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000652 * The default passing mode is PKCS7 padding.
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200653 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500654 * \param ctx The generic cipher context. This must be initialized and
655 * bound to a cipher information structure.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000656 * \param mode The padding mode.
657 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100658 * \return \c 0 on success.
Rose Zadik02f73a62018-03-26 18:02:32 +0100659 * \return #MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE
660 * if the selected padding mode is not supported.
661 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA if the cipher mode
Paul Bakker1a45d912013-08-14 12:04:26 +0200662 * does not support padding.
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200663 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000664int mbedtls_cipher_set_padding_mode( mbedtls_cipher_context_t *ctx,
665 mbedtls_cipher_padding_t mode );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200666#endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200667
668/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000669 * \brief This function sets the initialization vector (IV)
670 * or nonce.
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200671 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100672 * \note Some ciphers do not use IVs nor nonce. For these
673 * ciphers, this function has no effect.
674 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500675 * \param ctx The generic cipher context. This must be initialized and
676 * bound to a cipher information structure.
677 * \param iv The IV to use, or NONCE_COUNTER for CTR-mode ciphers. This
678 * must be a readable buffer of at least \p iv_len Bytes.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000679 * \param iv_len The IV length for ciphers with variable-size IV.
680 * This parameter is discarded by ciphers with fixed-size IV.
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200681 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100682 * \return \c 0 on success.
Rose Zadik4c368e82018-04-19 14:24:11 +0100683 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
684 * parameter-verification failure.
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200685 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686int mbedtls_cipher_set_iv( mbedtls_cipher_context_t *ctx,
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500687 const unsigned char *iv,
688 size_t iv_len );
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200689
690/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000691 * \brief This function resets the cipher state.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000692 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500693 * \param ctx The generic cipher context. This must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000694 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100695 * \return \c 0 on success.
Rose Zadik4c368e82018-04-19 14:24:11 +0100696 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
697 * parameter-verification failure.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000698 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200699int mbedtls_cipher_reset( mbedtls_cipher_context_t *ctx );
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200700
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +0200701#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200702/**
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500703 * \brief This function adds additional data for AEAD ciphers.
704 * Currently supported with GCM and ChaCha20+Poly1305.
705 * This must be called exactly once, after
706 * mbedtls_cipher_reset().
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200707 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500708 * \param ctx The generic cipher context. This must be initialized.
709 * \param ad The additional data to use. This must be a readable
710 * buffer of at least \p ad_len Bytes.
Andrzej Kurek02f39ac2019-02-08 06:50:55 -0500711 * \param ad_len The length of \p ad in Bytes.
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200712 *
Andrzej Kurek57f04e52019-02-08 06:44:43 -0500713 * \return \c 0 on success.
714 * \return A specific error code on failure.
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200715 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200716int mbedtls_cipher_update_ad( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200717 const unsigned char *ad, size_t ad_len );
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +0200718#endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000719
720/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000721 * \brief The generic cipher update function. It encrypts or
722 * decrypts using the given cipher context. Writes as
723 * many block-sized blocks of data as possible to output.
724 * Any data that cannot be written immediately is either
725 * added to the next block, or flushed when
726 * mbedtls_cipher_finish() is called.
727 * Exception: For MBEDTLS_MODE_ECB, expects a single block
728 * in size. For example, 16 Bytes for AES.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000729 *
Rose Zadik4c368e82018-04-19 14:24:11 +0100730 * \note If the underlying cipher is used in GCM mode, all calls
731 * to this function, except for the last one before
732 * mbedtls_cipher_finish(), must have \p ilen as a
733 * multiple of the block size of the cipher.
Rose Zadik02f73a62018-03-26 18:02:32 +0100734 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500735 * \param ctx The generic cipher context. This must be initialized and
736 * bound to a key.
737 * \param input The buffer holding the input data. This must be a
738 * readable buffer of at least \p ilen Bytes.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000739 * \param ilen The length of the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500740 * \param output The buffer for the output data. This must be able to
741 * hold at least `ilen + block_size`. This must not be the
742 * same buffer as \p input.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000743 * \param olen The length of the output data, to be updated with the
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500744 * actual number of Bytes written. This must not be
745 * \c NULL.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000746 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100747 * \return \c 0 on success.
Rose Zadik4c368e82018-04-19 14:24:11 +0100748 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
749 * parameter-verification failure.
Rose Zadik02f73a62018-03-26 18:02:32 +0100750 * \return #MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE on an
751 * unsupported mode for a cipher.
Rose Zadikb5607bf2018-04-16 10:34:51 +0100752 * \return A cipher-specific error code on failure.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000753 */
Hanno Beckerf4fb8762018-11-08 15:57:42 +0000754int mbedtls_cipher_update( mbedtls_cipher_context_t *ctx,
755 const unsigned char *input,
756 size_t ilen, unsigned char *output,
757 size_t *olen );
Paul Bakker8123e9d2011-01-06 15:37:30 +0000758
759/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000760 * \brief The generic cipher finalization function. If data still
761 * needs to be flushed from an incomplete block, the data
762 * contained in it is padded to the size of
763 * the last block, and written to the \p output buffer.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000764 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500765 * \param ctx The generic cipher context. This must be initialized and
766 * bound to a key.
767 * \param output The buffer to write data to. This needs to be a writable
768 * buffer of at least \p block_size Bytes.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000769 * \param olen The length of the data written to the \p output buffer.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500770 * This may not be \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.
775 * \return #MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED on decryption
776 * expecting a full block but not receiving one.
Rose Zadik02f73a62018-03-26 18:02:32 +0100777 * \return #MBEDTLS_ERR_CIPHER_INVALID_PADDING on invalid padding
778 * while decrypting.
Rose Zadikb5607bf2018-04-16 10:34:51 +0100779 * \return A cipher-specific error code on failure.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000780 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200781int mbedtls_cipher_finish( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200782 unsigned char *output, size_t *olen );
783
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +0200784#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200785/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000786 * \brief This function writes a tag for AEAD ciphers.
Daniel King8fe47012016-05-17 20:33:28 -0300787 * Currently supported with GCM and ChaCha20+Poly1305.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500788 * This must be called after mbedtls_cipher_finish().
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200789 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500790 * \param ctx The generic cipher context. This must be initialized,
791 * bound to a key, and have just completed a cipher
792 * operation through mbedtls_cipher_finish() the tag for
793 * which should be written.
794 * \param tag The buffer to write the tag to. This must be a writable
795 * buffer of at least \p tag_len Bytes.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000796 * \param tag_len The length of the tag to write.
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200797 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100798 * \return \c 0 on success.
799 * \return A specific error code on failure.
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200800 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200801int mbedtls_cipher_write_tag( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200802 unsigned char *tag, size_t tag_len );
803
804/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000805 * \brief This function checks the tag for AEAD ciphers.
Daniel King8fe47012016-05-17 20:33:28 -0300806 * Currently supported with GCM and ChaCha20+Poly1305.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500807 * This must be called after mbedtls_cipher_finish().
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200808 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500809 * \param ctx The generic cipher context. This must be initialized.
810 * \param tag The buffer holding the tag. This must be a readable
811 * buffer of at least \p tag_len Bytes.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000812 * \param tag_len The length of the tag to check.
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200813 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100814 * \return \c 0 on success.
815 * \return A specific error code on failure.
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200816 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200817int mbedtls_cipher_check_tag( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200818 const unsigned char *tag, size_t tag_len );
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +0200819#endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000820
Paul Bakker8123e9d2011-01-06 15:37:30 +0000821/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000822 * \brief The generic all-in-one encryption/decryption function,
823 * for all ciphers except AEAD constructs.
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +0200824 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500825 * \param ctx The generic cipher context. This must be initialized.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000826 * \param iv The IV to use, or NONCE_COUNTER for CTR-mode ciphers.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500827 * This must be a readable buffer of at least \p iv_len
828 * Bytes.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000829 * \param iv_len The IV length for ciphers with variable-size IV.
830 * This parameter is discarded by ciphers with fixed-size
831 * IV.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500832 * \param input The buffer holding the input data. This must be a
833 * readable buffer of at least \p ilen Bytes.
834 * \param ilen The length of the input data in Bytes.
835 * \param output The buffer for the output data. This must be able to
836 * hold at least `ilen + block_size`. This must not be the
837 * same buffer as \p input.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000838 * \param olen The length of the output data, to be updated with the
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500839 * actual number of Bytes written. This must not be
840 * \c NULL.
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +0200841 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000842 * \note Some ciphers do not use IVs nor nonce. For these
843 * ciphers, use \p iv = NULL and \p iv_len = 0.
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +0200844 *
Rose Zadikb5607bf2018-04-16 10:34:51 +0100845 * \return \c 0 on success.
Rose Zadik4c368e82018-04-19 14:24:11 +0100846 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
847 * parameter-verification failure.
848 * \return #MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED on decryption
849 * expecting a full block but not receiving one.
Rose Zadik02f73a62018-03-26 18:02:32 +0100850 * \return #MBEDTLS_ERR_CIPHER_INVALID_PADDING on invalid padding
851 * while decrypting.
Rose Zadikb5607bf2018-04-16 10:34:51 +0100852 * \return A cipher-specific error code on failure.
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +0200853 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200854int mbedtls_cipher_crypt( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +0200855 const unsigned char *iv, size_t iv_len,
856 const unsigned char *input, size_t ilen,
857 unsigned char *output, size_t *olen );
858
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859#if defined(MBEDTLS_CIPHER_MODE_AEAD)
Manuel Pégourié-Gonnard513c2432020-12-01 10:34:57 +0100860#if ! defined(MBEDTLS_DEPRECATED_REMOVED)
861#if defined(MBEDTLS_DEPRECATED_WARNING)
862#define MBEDTLS_DEPRECATED __attribute__((deprecated))
863#else
864#define MBEDTLS_DEPRECATED
865#endif /* MBEDTLS_DEPRECATED_WARNING */
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200866/**
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +0100867 * \brief The generic authenticated encryption (AEAD) function.
868 *
Manuel Pégourié-Gonnard513c2432020-12-01 10:34:57 +0100869 * \deprecated Superseded by mbedtls_cipher_auth_encrypt_ext().
870 *
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +0100871 * \note This function only supports AEAD algorithms, not key
872 * wrapping algorithms such as NIST_KW; for this, see
873 * mbedtls_cipher_auth_encrypt_ext().
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200874 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500875 * \param ctx The generic cipher context. This must be initialized and
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +0100876 * bound to a key associated with an AEAD algorithm.
Manuel Pégourié-Gonnard3ba84d52020-11-20 10:17:20 +0100877 * \param iv The nonce to use. This must be a readable buffer of
878 * at least \p iv_len Bytes and must not be \c NULL.
879 * \param iv_len The length of the nonce. This must satisfy the
880 * constraints imposed by the AEAD cipher used.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500881 * \param ad The additional data to authenticate. This must be a
Manuel Pégourié-Gonnard3ba84d52020-11-20 10:17:20 +0100882 * readable buffer of at least \p ad_len Bytes, and may
883 * be \c NULL is \p ad_len is \c 0.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500884 * \param ad_len The length of \p ad.
885 * \param input The buffer holding the input data. This must be a
Manuel Pégourié-Gonnard3ba84d52020-11-20 10:17:20 +0100886 * readable buffer of at least \p ilen Bytes, and may be
887 * \c NULL if \p ilen is \c 0.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500888 * \param ilen The length of the input data.
Manuel Pégourié-Gonnard3ba84d52020-11-20 10:17:20 +0100889 * \param output The buffer for the output data. This must be a
890 * writable buffer of at least \p ilen Bytes, and must
891 * not be \c NULL.
892 * \param olen This will be filled with the actual number of Bytes
893 * written to the \p output buffer. This must point to a
894 * writable object of type \c size_t.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500895 * \param tag The buffer for the authentication tag. This must be a
Manuel Pégourié-Gonnard3ba84d52020-11-20 10:17:20 +0100896 * writable buffer of at least \p tag_len Bytes. See note
897 * below regarding restrictions with PSA-based contexts.
898 * \param tag_len The desired length of the authentication tag. This
899 * must match the constraints imposed by the AEAD cipher
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +0100900 * used, and in particular must not be \c 0.
Manuel Pégourié-Gonnard3ba84d52020-11-20 10:17:20 +0100901 *
902 * \note If the context is based on PSA (that is, it was set up
903 * with mbedtls_cipher_setup_psa()), then it is required
904 * that \c tag == output + ilen. That is, the tag must be
905 * appended to the ciphertext as recommended by RFC 5116.
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200906 *
Andrzej Kurek246cc862019-02-05 04:40:53 -0500907 * \return \c 0 on success.
908 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
909 * parameter-verification failure.
910 * \return A cipher-specific error code on failure.
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200911 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200912int mbedtls_cipher_auth_encrypt( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200913 const unsigned char *iv, size_t iv_len,
914 const unsigned char *ad, size_t ad_len,
915 const unsigned char *input, size_t ilen,
916 unsigned char *output, size_t *olen,
Manuel Pégourié-Gonnard513c2432020-12-01 10:34:57 +0100917 unsigned char *tag, size_t tag_len )
918 MBEDTLS_DEPRECATED;
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200919
920/**
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +0100921 * \brief The generic authenticated decryption (AEAD) function.
922 *
Manuel Pégourié-Gonnard513c2432020-12-01 10:34:57 +0100923 * \deprecated Superseded by mbedtls_cipher_auth_decrypt_ext().
924 *
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +0100925 * \note This function only supports AEAD algorithms, not key
926 * wrapping algorithms such as NIST_KW; for this, see
Manuel Pégourié-Gonnard513c2432020-12-01 10:34:57 +0100927 * mbedtls_cipher_auth_decrypt_ext().
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200928 *
Andrzej Kurek246cc862019-02-05 04:40:53 -0500929 * \note If the data is not authentic, then the output buffer
930 * is zeroed out to prevent the unauthentic plaintext being
931 * used, making this interface safer.
Rose Zadik02f73a62018-03-26 18:02:32 +0100932 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500933 * \param ctx The generic cipher context. This must be initialized and
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +0100934 * bound to a key associated with an AEAD algorithm.
Manuel Pégourié-Gonnard3ba84d52020-11-20 10:17:20 +0100935 * \param iv The nonce to use. This must be a readable buffer of
936 * at least \p iv_len Bytes and must not be \c NULL.
937 * \param iv_len The length of the nonce. This must satisfy the
938 * constraints imposed by the AEAD cipher used.
939 * \param ad The additional data to authenticate. This must be a
940 * readable buffer of at least \p ad_len Bytes, and may
941 * be \c NULL is \p ad_len is \c 0.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500942 * \param ad_len The length of \p ad.
943 * \param input The buffer holding the input data. This must be a
Manuel Pégourié-Gonnard3ba84d52020-11-20 10:17:20 +0100944 * readable buffer of at least \p ilen Bytes, and may be
945 * \c NULL if \p ilen is \c 0.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500946 * \param ilen The length of the input data.
Manuel Pégourié-Gonnard3ba84d52020-11-20 10:17:20 +0100947 * \param output The buffer for the output data. This must be a
948 * writable buffer of at least \p ilen Bytes, and must
949 * not be \c NULL.
950 * \param olen This will be filled with the actual number of Bytes
951 * written to the \p output buffer. This must point to a
952 * writable object of type \c size_t.
953 * \param tag The buffer for the authentication tag. This must be a
954 * readable buffer of at least \p tag_len Bytes. See note
955 * below regarding restrictions with PSA-based contexts.
956 * \param tag_len The length of the authentication tag. This must match
957 * the constraints imposed by the AEAD cipher used, and in
958 * particular must not be \c 0.
959 *
960 * \note If the context is based on PSA (that is, it was set up
961 * with mbedtls_cipher_setup_psa()), then it is required
962 * that \c tag == input + len. That is, the tag must be
963 * appended to the ciphertext as recommended by RFC 5116.
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200964 *
Andrzej Kurek246cc862019-02-05 04:40:53 -0500965 * \return \c 0 on success.
966 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
967 * parameter-verification failure.
968 * \return #MBEDTLS_ERR_CIPHER_AUTH_FAILED if data is not authentic.
969 * \return A cipher-specific error code on failure.
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971int mbedtls_cipher_auth_decrypt( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200972 const unsigned char *iv, size_t iv_len,
973 const unsigned char *ad, size_t ad_len,
974 const unsigned char *input, size_t ilen,
975 unsigned char *output, size_t *olen,
Manuel Pégourié-Gonnard513c2432020-12-01 10:34:57 +0100976 const unsigned char *tag, size_t tag_len )
977 MBEDTLS_DEPRECATED;
978#undef MBEDTLS_DEPRECATED
979#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200980#endif /* MBEDTLS_CIPHER_MODE_AEAD */
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200981
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +0100982#if defined(MBEDTLS_CIPHER_MODE_AEAD) || defined(MBEDTLS_NIST_KW_C)
983/**
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +0100984 * \brief The authenticated encryption (AEAD/NIST_KW) function.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +0100985 *
986 * \note For AEAD modes, the tag will be appended to the
987 * ciphertext, as recommended by RFC 5116.
988 * (NIST_KW doesn't have a separate tag.)
989 *
990 * \param ctx The generic cipher context. This must be initialized and
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +0100991 * bound to a key, with an AEAD algorithm or NIST_KW.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +0100992 * \param iv The nonce to use. This must be a readable buffer of
993 * at least \p iv_len Bytes and may be \c NULL if \p
994 * iv_len is \c 0.
Manuel Pégourié-Gonnardb23e31d2020-12-07 09:57:35 +0100995 * \param iv_len The length of the nonce. For AEAD ciphers, this must
996 * satisfy the constraints imposed by the cipher used.
997 * For NIST_KW, this must be \c 0.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +0100998 * \param ad The additional data to authenticate. This must be a
999 * readable buffer of at least \p ad_len Bytes, and may
1000 * be \c NULL is \p ad_len is \c 0.
1001 * \param ad_len The length of \p ad. For NIST_KW, this must be \c 0.
1002 * \param input The buffer holding the input data. This must be a
1003 * readable buffer of at least \p ilen Bytes, and may be
1004 * \c NULL if \p ilen is \c 0.
1005 * \param ilen The length of the input data.
1006 * \param output The buffer for the output data. This must be a
1007 * writable buffer of at least \p output_len Bytes, and
1008 * must not be \c NULL.
1009 * \param output_len The length of the \p output buffer in Bytes. For AEAD
1010 * ciphers, this must be at least \p ilen + \p tag_len.
1011 * For NIST_KW, this must be at least \p ilen + 8
1012 * (rounded up to a multiple of 8 if KWP is used);
1013 * \p ilen + 15 is always a safe value.
1014 * \param olen This will be filled with the actual number of Bytes
1015 * written to the \p output buffer. This must point to a
1016 * writable object of type \c size_t.
1017 * \param tag_len The desired length of the authentication tag. For AEAD
1018 * ciphers, this must match the constraints imposed by
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +01001019 * the cipher used, and in particular must not be \c 0.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +01001020 * For NIST_KW, this must be \c 0.
1021 *
1022 * \return \c 0 on success.
1023 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
1024 * parameter-verification failure.
1025 * \return A cipher-specific error code on failure.
1026 */
1027int mbedtls_cipher_auth_encrypt_ext( mbedtls_cipher_context_t *ctx,
1028 const unsigned char *iv, size_t iv_len,
1029 const unsigned char *ad, size_t ad_len,
1030 const unsigned char *input, size_t ilen,
1031 unsigned char *output, size_t output_len,
1032 size_t *olen, size_t tag_len );
1033
1034/**
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +01001035 * \brief The authenticated encryption (AEAD/NIST_KW) function.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +01001036 *
1037 * \note If the data is not authentic, then the output buffer
1038 * is zeroed out to prevent the unauthentic plaintext being
1039 * used, making this interface safer.
1040 *
1041 * \note For AEAD modes, the tag must be appended to the
1042 * ciphertext, as recommended by RFC 5116.
1043 * (NIST_KW doesn't have a separate tag.)
1044 *
1045 * \param ctx The generic cipher context. This must be initialized and
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +01001046 * bound to a key, with an AEAD algorithm or NIST_KW.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +01001047 * \param iv The nonce to use. This must be a readable buffer of
1048 * at least \p iv_len Bytes and may be \c NULL if \p
1049 * iv_len is \c 0.
Manuel Pégourié-Gonnardb23e31d2020-12-07 09:57:35 +01001050 * \param iv_len The length of the nonce. For AEAD ciphers, this must
1051 * satisfy the constraints imposed by the cipher used.
1052 * For NIST_KW, this must be \c 0.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +01001053 * \param ad The additional data to authenticate. This must be a
1054 * readable buffer of at least \p ad_len Bytes, and may
1055 * be \c NULL is \p ad_len is \c 0.
1056 * \param ad_len The length of \p ad. For NIST_KW, this must be \c 0.
1057 * \param input The buffer holding the input data. This must be a
1058 * readable buffer of at least \p ilen Bytes, and may be
1059 * \c NULL if \p ilen is \c 0.
1060 * \param ilen The length of the input data. For AEAD ciphers this
1061 * must be at least \p tag_len. For NIST_KW this must be
1062 * at least \c 8.
1063 * \param output The buffer for the output data. This must be a
1064 * writable buffer of at least \p output_len Bytes, and
1065 * may be \c NULL if \p output_len is \c 0.
1066 * \param output_len The length of the \p output buffer in Bytes. For AEAD
1067 * ciphers, this must be at least \p ilen - \p tag_len.
1068 * For NIST_KW, this must be at least \p ilen - 8.
1069 * \param olen This will be filled with the actual number of Bytes
1070 * written to the \p output buffer. This must point to a
1071 * writable object of type \c size_t.
1072 * \param tag_len The actual length of the authentication tag. For AEAD
1073 * ciphers, this must match the constraints imposed by
Manuel Pégourié-Gonnardf2ffbc42020-12-01 09:57:55 +01001074 * the cipher used, and in particular must not be \c 0.
Manuel Pégourié-Gonnard9cc079d2020-11-25 12:57:47 +01001075 * For NIST_KW, this must be \c 0.
1076 *
1077 * \return \c 0 on success.
1078 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
1079 * parameter-verification failure.
1080 * \return #MBEDTLS_ERR_CIPHER_AUTH_FAILED if data is not authentic.
1081 * \return A cipher-specific error code on failure.
1082 */
1083int mbedtls_cipher_auth_decrypt_ext( mbedtls_cipher_context_t *ctx,
1084 const unsigned char *iv, size_t iv_len,
1085 const unsigned char *ad, size_t ad_len,
1086 const unsigned char *input, size_t ilen,
1087 unsigned char *output, size_t output_len,
1088 size_t *olen, size_t tag_len );
1089#endif /* MBEDTLS_CIPHER_MODE_AEAD || MBEDTLS_NIST_KW_C */
Paul Bakker8123e9d2011-01-06 15:37:30 +00001090#ifdef __cplusplus
1091}
1092#endif
1093
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001094#endif /* MBEDTLS_CIPHER_H */