blob: 000d18fdc6b1fc93c63f252bc6909cc3215acf30 [file] [log] [blame]
Paul Bakker8123e9d2011-01-06 15:37:30 +00001/**
2 * \file cipher.h
Paul Bakker9af723c2014-05-01 13:03:14 +02003 *
Rose Zadik02f73a62018-03-26 18:02:32 +01004 * \brief Thif file contains the generic cipher wrapper.
Paul Bakker8123e9d2011-01-06 15:37:30 +00005 *
6 * \author Adriaan de Jong <dejong@fox-it.com>
Darryl Greena40a1012018-01-05 15:33:17 +00007 */
8/*
Rose Zadik9ba6b622018-01-24 12:59:19 +00009 * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020010 * SPDX-License-Identifier: Apache-2.0
11 *
12 * Licensed under the Apache License, Version 2.0 (the "License"); you may
13 * not use this file except in compliance with the License.
14 * You may obtain a copy of the License at
15 *
16 * http://www.apache.org/licenses/LICENSE-2.0
17 *
18 * Unless required by applicable law or agreed to in writing, software
19 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
20 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 * See the License for the specific language governing permissions and
22 * limitations under the License.
Paul Bakker8123e9d2011-01-06 15:37:30 +000023 *
Rose Zadik9ba6b622018-01-24 12:59:19 +000024 * This file is part of Mbed TLS (https://tls.mbed.org)
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)
Manuel Pégourié-Gonnard43a47802013-09-03 16:35:53 +020031#include "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>
37
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020038#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C)
39#define MBEDTLS_CIPHER_MODE_AEAD
Manuel Pégourié-Gonnard43a47802013-09-03 16:35:53 +020040#endif
41
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020042#if defined(MBEDTLS_CIPHER_MODE_CBC)
43#define MBEDTLS_CIPHER_MODE_WITH_PADDING
Manuel Pégourié-Gonnard989ed382013-09-13 14:41:45 +020044#endif
45
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020046#if defined(MBEDTLS_ARC4_C)
47#define MBEDTLS_CIPHER_MODE_STREAM
Manuel Pégourié-Gonnardb8ca7232014-12-02 10:09:10 +010048#endif
49
Manuel Pégourié-Gonnard0223ab92015-10-05 11:40:01 +010050#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
51 !defined(inline) && !defined(__cplusplus)
Paul Bakker569df2c2011-06-21 07:48:07 +000052#define inline __inline
Manuel Pégourié-Gonnard20af64d2015-07-07 18:33:39 +020053#endif
Paul Bakkeraf5c85f2011-04-18 03:47:52 +000054
Rose Zadik9ba6b622018-01-24 12:59:19 +000055#define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080 /**< The selected feature is not available. */
56#define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100 /**< Bad input parameters. */
57#define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180 /**< Failed to allocate memory. */
58#define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200 /**< Input data contains invalid padding and is rejected. */
59#define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280 /**< Decryption of block requires a full block. */
60#define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300 /**< Authentication failed (for AEAD modes). */
61#define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380 /**< The context is invalid. For example, because it was freed. */
62#define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED -0x6400 /**< Cipher hardware accelerator failed. */
Paul Bakker343a8702011-06-09 14:27:58 +000063
Rose Zadik9ba6b622018-01-24 12:59:19 +000064#define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01 /**< Cipher accepts IVs of variable length. */
65#define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02 /**< Cipher accepts keys of variable length. */
Manuel Pégourié-Gonnard81754a02014-06-23 11:33:18 +020066
Paul Bakker407a0da2013-06-27 14:29:21 +020067#ifdef __cplusplus
68extern "C" {
69#endif
70
Hanno Beckerbbca8c52017-09-25 14:53:51 +010071/**
Rose Zadik02f73a62018-03-26 18:02:32 +010072 * \brief Supported cipher types.
Hanno Beckerbbca8c52017-09-25 14:53:51 +010073 *
74 * \warning ARC4 and DES are considered weak ciphers and their use
Rose Zadik02f73a62018-03-26 18:02:32 +010075 * constitutes a security risk. We recommend you consider using
76 * stronger ciphers instead.
Hanno Beckerbbca8c52017-09-25 14:53:51 +010077 */
Paul Bakker8123e9d2011-01-06 15:37:30 +000078typedef enum {
Rose Zadik02f73a62018-03-26 18:02:32 +010079 MBEDTLS_CIPHER_ID_NONE = 0, /**< None. */
80 MBEDTLS_CIPHER_ID_NULL, /**< NULL.*/
81 MBEDTLS_CIPHER_ID_AES, /**< The AES cipher. */
82 MBEDTLS_CIPHER_ID_DES, /**< The DES cipher. */
83 MBEDTLS_CIPHER_ID_3DES, /**< The 3DES cipher. */
84 MBEDTLS_CIPHER_ID_CAMELLIA, /**< The Camellia cipher. */
85 MBEDTLS_CIPHER_ID_BLOWFISH, /**< The Blowfish cipher. */
86 MBEDTLS_CIPHER_ID_ARC4, /**< The ARC4 cipher. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020087} mbedtls_cipher_id_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +000088
Hanno Beckerbbca8c52017-09-25 14:53:51 +010089/**
Rose Zadik02f73a62018-03-26 18:02:32 +010090 * \brief Supported {cipher type, cipher mode} pairs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +010091 *
92 * \warning ARC4 and DES are considered weak ciphers and their use
93 * constitutes a security risk. We recommend considering stronger
94 * ciphers instead.
95 */
Paul Bakker8123e9d2011-01-06 15:37:30 +000096typedef enum {
Rose Zadik02f73a62018-03-26 18:02:32 +010097 MBEDTLS_CIPHER_NONE = 0, /**< None. */
98 MBEDTLS_CIPHER_NULL, /**< NULL. */
99 MBEDTLS_CIPHER_AES_128_ECB, /**< AES cipher with 128-bit ECB mode. */
100 MBEDTLS_CIPHER_AES_192_ECB, /**< AES cipher with 192-bit ECB mode. */
101 MBEDTLS_CIPHER_AES_256_ECB, /**< AES cipher with 256-bit ECB mode. */
102 MBEDTLS_CIPHER_AES_128_CBC, /**< AES cipher with 128-bit CBC mode. */
103 MBEDTLS_CIPHER_AES_192_CBC, /**< AES cipher with 192-bit CBC mode. */
104 MBEDTLS_CIPHER_AES_256_CBC, /**< AES cipher with 256-bit CBC mode. */
105 MBEDTLS_CIPHER_AES_128_CFB128, /**< AES cipher with 128-bit CFB128 mode. */
106 MBEDTLS_CIPHER_AES_192_CFB128, /**< AES cipher with 192-bit CFB128 mode. */
107 MBEDTLS_CIPHER_AES_256_CFB128, /**< AES cipher with 256-bit CFB128 mode. */
108 MBEDTLS_CIPHER_AES_128_CTR, /**< AES cipher with 128-bit CTR mode. */
109 MBEDTLS_CIPHER_AES_192_CTR, /**< AES cipher with 192-bit CTR mode. */
110 MBEDTLS_CIPHER_AES_256_CTR, /**< AES cipher with 256-bit CTR mode. */
111 MBEDTLS_CIPHER_AES_128_GCM, /**< AES cipher with 128-bit GCM mode. */
112 MBEDTLS_CIPHER_AES_192_GCM, /**< AES cipher with 192-bit GCM mode. */
113 MBEDTLS_CIPHER_AES_256_GCM, /**< AES cipher with 256-bit GCM mode. */
114 MBEDTLS_CIPHER_CAMELLIA_128_ECB, /**< Camellia cipher with 128-bit ECB mode. */
115 MBEDTLS_CIPHER_CAMELLIA_192_ECB, /**< Camellia cipher with 192-bit ECB mode. */
116 MBEDTLS_CIPHER_CAMELLIA_256_ECB, /**< Camellia cipher with 256-bit ECB mode. */
117 MBEDTLS_CIPHER_CAMELLIA_128_CBC, /**< Camellia cipher with 128-bit CBC mode. */
118 MBEDTLS_CIPHER_CAMELLIA_192_CBC, /**< Camellia cipher with 192-bit CBC mode. */
119 MBEDTLS_CIPHER_CAMELLIA_256_CBC, /**< Camellia cipher with 256-bit CBC mode. */
120 MBEDTLS_CIPHER_CAMELLIA_128_CFB128, /**< Camellia cipher with 128-bit CFB128 mode. */
121 MBEDTLS_CIPHER_CAMELLIA_192_CFB128, /**< Camellia cipher with 192-bit CFB128 mode. */
122 MBEDTLS_CIPHER_CAMELLIA_256_CFB128, /**< Camellia cipher with 256-bit CFB128 mode. */
123 MBEDTLS_CIPHER_CAMELLIA_128_CTR, /**< Camellia cipher with 128-bit CTR mode. */
124 MBEDTLS_CIPHER_CAMELLIA_192_CTR, /**< Camellia cipher with 192-bit CTR mode. */
125 MBEDTLS_CIPHER_CAMELLIA_256_CTR, /**< Camellia cipher with 256-bit CTR mode. */
126 MBEDTLS_CIPHER_CAMELLIA_128_GCM, /**< Camellia cipher with 128-bit GCM mode. */
127 MBEDTLS_CIPHER_CAMELLIA_192_GCM, /**< Camellia cipher with 192-bit GCM mode. */
128 MBEDTLS_CIPHER_CAMELLIA_256_GCM, /**< Camellia cipher with 256-bit GCM mode. */
129 MBEDTLS_CIPHER_DES_ECB, /**< DES cipher with ECB mode. */
130 MBEDTLS_CIPHER_DES_CBC, /**< DES cipher with CBC mode. */
131 MBEDTLS_CIPHER_DES_EDE_ECB, /**< DES cipher with EDE ECB mode. */
132 MBEDTLS_CIPHER_DES_EDE_CBC, /**< DES cipher with EDE CBC mode. */
133 MBEDTLS_CIPHER_DES_EDE3_ECB, /**< DES cipher with EDE3 ECB mode. */
134 MBEDTLS_CIPHER_DES_EDE3_CBC, /**< DES cipher with EDE3 CBC mode. */
135 MBEDTLS_CIPHER_BLOWFISH_ECB, /**< Blowfish cipher with ECB mode. */
136 MBEDTLS_CIPHER_BLOWFISH_CBC, /**< Blowfish cipher with CBC mode. */
137 MBEDTLS_CIPHER_BLOWFISH_CFB64, /**< Blowfish cipher with CFB64 mode. */
138 MBEDTLS_CIPHER_BLOWFISH_CTR, /**< Blowfish cipher with CTR mode. */
139 MBEDTLS_CIPHER_ARC4_128, /**< ARC4 cipher with 128-bit mode. */
140 MBEDTLS_CIPHER_AES_128_CCM, /**< AES cipher with 128-bit CCM mode. */
141 MBEDTLS_CIPHER_AES_192_CCM, /**< AES cipher with 192-bit CCM mode. */
142 MBEDTLS_CIPHER_AES_256_CCM, /**< AES cipher with 256-bit CCM mode. */
143 MBEDTLS_CIPHER_CAMELLIA_128_CCM, /**< Camellia cipher with 128-bit CCM mode. */
144 MBEDTLS_CIPHER_CAMELLIA_192_CCM, /**< Camellia cipher with 192-bit CCM mode. */
145 MBEDTLS_CIPHER_CAMELLIA_256_CCM, /**< Camellia cipher with 256-bit CCM mode. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200146} mbedtls_cipher_type_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000147
Rose Zadik9ba6b622018-01-24 12:59:19 +0000148/** Supported cipher modes. */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000149typedef enum {
Rose Zadik02f73a62018-03-26 18:02:32 +0100150 MBEDTLS_MODE_NONE = 0, /**< None. */
151 MBEDTLS_MODE_ECB, /**< The ECB cipher mode. */
152 MBEDTLS_MODE_CBC, /**< The CBC cipher mode. */
153 MBEDTLS_MODE_CFB, /**< The CFB cipher mode. */
154 MBEDTLS_MODE_OFB, /**< Unused. */
155 MBEDTLS_MODE_CTR, /**< The CTR cipher mode. */
156 MBEDTLS_MODE_GCM, /**< The GCM cipher mode. */
157 MBEDTLS_MODE_STREAM, /**< The stream cipher mode. */
158 MBEDTLS_MODE_CCM, /**< The CCM cipher mode. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200159} mbedtls_cipher_mode_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000160
Rose Zadik9ba6b622018-01-24 12:59:19 +0000161/** Supported cipher padding types. */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000162typedef enum {
Rose Zadik9ba6b622018-01-24 12:59:19 +0000163 MBEDTLS_PADDING_PKCS7 = 0, /**< PKCS7 padding (default). */
164 MBEDTLS_PADDING_ONE_AND_ZEROS, /**< ISO/IEC 7816-4 padding. */
165 MBEDTLS_PADDING_ZEROS_AND_LEN, /**< ANSI X.923 padding. */
Rose Zadik02f73a62018-03-26 18:02:32 +0100166 MBEDTLS_PADDING_ZEROS, /**< Zero padding (not reversible). */
167 MBEDTLS_PADDING_NONE, /**< Never pad (full blocks only). */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200168} mbedtls_cipher_padding_t;
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200169
Rose Zadik9ba6b622018-01-24 12:59:19 +0000170/** Type of operation. */
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200171typedef enum {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200172 MBEDTLS_OPERATION_NONE = -1,
173 MBEDTLS_DECRYPT = 0,
174 MBEDTLS_ENCRYPT,
175} mbedtls_operation_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000176
177enum {
Rose Zadik9ba6b622018-01-24 12:59:19 +0000178 /** Undefined key length. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200179 MBEDTLS_KEY_LENGTH_NONE = 0,
Rose Zadik9ba6b622018-01-24 12:59:19 +0000180 /** Key length, in bits (including parity), for DES keys. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200181 MBEDTLS_KEY_LENGTH_DES = 64,
Rose Zadik9ba6b622018-01-24 12:59:19 +0000182 /** Key length in bits, including parity, for DES in two-key EDE. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200183 MBEDTLS_KEY_LENGTH_DES_EDE = 128,
Rose Zadik9ba6b622018-01-24 12:59:19 +0000184 /** Key length in bits, including parity, for DES in three-key EDE. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200185 MBEDTLS_KEY_LENGTH_DES_EDE3 = 192,
Paul Bakker8123e9d2011-01-06 15:37:30 +0000186};
187
Rose Zadik9ba6b622018-01-24 12:59:19 +0000188/** Maximum length of any IV, in Bytes. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200189#define MBEDTLS_MAX_IV_LENGTH 16
Rose Zadik9ba6b622018-01-24 12:59:19 +0000190/** Maximum block size of any cipher, in Bytes. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200191#define MBEDTLS_MAX_BLOCK_LENGTH 16
Manuel Pégourié-Gonnard0b58c152013-10-24 17:17:54 +0200192
Paul Bakker8123e9d2011-01-06 15:37:30 +0000193/**
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100194 * Base cipher information (opaque struct).
Paul Bakker343a8702011-06-09 14:27:58 +0000195 */
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100196typedef struct mbedtls_cipher_base_t mbedtls_cipher_base_t;
Paul Bakker343a8702011-06-09 14:27:58 +0000197
198/**
Simon Butcher327398a2016-10-05 14:09:11 +0100199 * CMAC context (opaque struct).
200 */
201typedef struct mbedtls_cmac_context_t mbedtls_cmac_context_t;
202
203/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000204 * Cipher information. Allows calling cipher functions
205 * in a generic way.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000206 */
207typedef struct {
Rose Zadik9ba6b622018-01-24 12:59:19 +0000208 /** Full cipher identifier. For example,
209 * MBEDTLS_CIPHER_AES_256_CBC.
210 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211 mbedtls_cipher_type_t type;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000212
Rose Zadik9ba6b622018-01-24 12:59:19 +0000213 /** The cipher mode. For example, MBEDTLS_MODE_CBC. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200214 mbedtls_cipher_mode_t mode;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000215
Rose Zadik9ba6b622018-01-24 12:59:19 +0000216 /** The cipher key length, in bits. This is the
217 * default length for variable sized ciphers.
218 * Includes parity bits for ciphers like DES.
219 */
Manuel Pégourié-Gonnard898e0aa2015-06-18 15:28:12 +0200220 unsigned int key_bitlen;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000221
Rose Zadik9ba6b622018-01-24 12:59:19 +0000222 /** Name of the cipher. */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000223 const char * name;
224
Rose Zadik9ba6b622018-01-24 12:59:19 +0000225 /** IV or nonce size, in Bytes.
226 * For ciphers that accept variable IV sizes,
227 * this is the recommended size.
228 */
Paul Bakker23986e52011-04-24 08:57:21 +0000229 unsigned int iv_size;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000230
Rose Zadik02f73a62018-03-26 18:02:32 +0100231 /** Flags to set. For example, if the cipher
232 supports variable IV sizes or variable key sizes. */
Manuel Pégourié-Gonnard81754a02014-06-23 11:33:18 +0200233 int flags;
Manuel Pégourié-Gonnarda235b5b2013-09-03 13:25:52 +0200234
Rose Zadik9ba6b622018-01-24 12:59:19 +0000235 /** The block size, in Bytes. */
Paul Bakker23986e52011-04-24 08:57:21 +0000236 unsigned int block_size;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000237
Rose Zadik9ba6b622018-01-24 12:59:19 +0000238 /** Struct for base cipher information and functions. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200239 const mbedtls_cipher_base_t *base;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241} mbedtls_cipher_info_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000242
243/**
Paul Bakker20281562011-11-11 10:34:04 +0000244 * Generic cipher context.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000245 */
246typedef struct {
Rose Zadik9ba6b622018-01-24 12:59:19 +0000247 /** Information about the associated cipher. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200248 const mbedtls_cipher_info_t *cipher_info;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000249
Rose Zadik9ba6b622018-01-24 12:59:19 +0000250 /** Key length to use. */
Manuel Pégourié-Gonnard898e0aa2015-06-18 15:28:12 +0200251 int key_bitlen;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000252
Rose Zadik9ba6b622018-01-24 12:59:19 +0000253 /** Operation that the key of the context has been
254 * initialized for.
255 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200256 mbedtls_operation_t operation;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000257
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200258#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Rose Zadik9ba6b622018-01-24 12:59:19 +0000259 /** Padding functions to use, if relevant for
260 * the specific cipher mode.
261 */
Manuel Pégourié-Gonnardac56a1a2013-07-25 12:31:10 +0200262 void (*add_padding)( unsigned char *output, size_t olen, size_t data_len );
263 int (*get_padding)( unsigned char *input, size_t ilen, size_t *data_len );
Manuel Pégourié-Gonnardb8ca7232014-12-02 10:09:10 +0100264#endif
Manuel Pégourié-Gonnardac56a1a2013-07-25 12:31:10 +0200265
Rose Zadik9ba6b622018-01-24 12:59:19 +0000266 /** Buffer for input that has not been processed yet. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200267 unsigned char unprocessed_data[MBEDTLS_MAX_BLOCK_LENGTH];
Paul Bakker8123e9d2011-01-06 15:37:30 +0000268
Rose Zadik9ba6b622018-01-24 12:59:19 +0000269 /** Number of Bytes that have not been processed yet. */
Paul Bakker23986e52011-04-24 08:57:21 +0000270 size_t unprocessed_len;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000271
Rose Zadik9ba6b622018-01-24 12:59:19 +0000272 /** Current IV or NONCE_COUNTER for CTR-mode. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200273 unsigned char iv[MBEDTLS_MAX_IV_LENGTH];
Paul Bakker8123e9d2011-01-06 15:37:30 +0000274
Rose Zadik9ba6b622018-01-24 12:59:19 +0000275 /** IV size in Bytes, for ciphers with variable-length IVs. */
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200276 size_t iv_size;
277
Rose Zadik9ba6b622018-01-24 12:59:19 +0000278 /** The cipher-specific context. */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000279 void *cipher_ctx;
Simon Butcher327398a2016-10-05 14:09:11 +0100280
281#if defined(MBEDTLS_CMAC_C)
Rose Zadik9ba6b622018-01-24 12:59:19 +0000282 /** CMAC-specific context. */
Simon Butcher327398a2016-10-05 14:09:11 +0100283 mbedtls_cmac_context_t *cmac_ctx;
284#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200285} mbedtls_cipher_context_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000286
Paul Bakker8123e9d2011-01-06 15:37:30 +0000287/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000288 * \brief This function retrieves the list of ciphers supported by the generic
289 * cipher module.
Paul Bakker72f62662011-01-16 21:27:44 +0000290 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000291 * \return A statically-allocated array of ciphers. The last entry
292 * is zero.
Paul Bakker72f62662011-01-16 21:27:44 +0000293 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200294const int *mbedtls_cipher_list( void );
Paul Bakker72f62662011-01-16 21:27:44 +0000295
296/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000297 * \brief This function retrieves the cipher-information
298 * structure associated with the given cipher name.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000299 *
Paul Bakker23986e52011-04-24 08:57:21 +0000300 * \param cipher_name Name of the cipher to search for.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000301 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000302 * \return The cipher information structure associated with the
Rose Zadik02f73a62018-03-26 18:02:32 +0100303 * given \p cipher_name.
304 * \return NULL if the associated cipher information is not found.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000305 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200306const mbedtls_cipher_info_t *mbedtls_cipher_info_from_string( const char *cipher_name );
Paul Bakker8123e9d2011-01-06 15:37:30 +0000307
308/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000309 * \brief This function retrieves the cipher-information
310 * structure associated with the given cipher type.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000311 *
312 * \param cipher_type Type of the cipher to search for.
313 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000314 * \return The cipher information structure associated with the
315 * given \p cipher_type, or NULL if not found.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000316 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200317const mbedtls_cipher_info_t *mbedtls_cipher_info_from_type( const mbedtls_cipher_type_t cipher_type );
Paul Bakker8123e9d2011-01-06 15:37:30 +0000318
319/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000320 * \brief This function retrieves the cipher-information
321 * structure associated with the given cipher ID,
322 * key size and mode.
Paul Bakkerf46b6952013-09-09 00:08:26 +0200323 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000324 * \param cipher_id The ID of the cipher to search for. For example,
325 * #MBEDTLS_CIPHER_ID_AES.
326 * \param key_bitlen The length of the key in bits.
327 * \param mode The cipher mode. For example, #MBEDTLS_MODE_CBC.
Paul Bakkerf46b6952013-09-09 00:08:26 +0200328 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000329 * \return The cipher information structure associated with the
Rose Zadik02f73a62018-03-26 18:02:32 +0100330 * given \p cipher_id.
331 * \return NULL if the associated cipher information is not found.
Paul Bakkerf46b6952013-09-09 00:08:26 +0200332 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200333const 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 +0200334 int key_bitlen,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200335 const mbedtls_cipher_mode_t mode );
Paul Bakkerf46b6952013-09-09 00:08:26 +0200336
337/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000338 * \brief This function initializes a \p cipher_context as NONE.
Paul Bakker84bbeb52014-07-01 14:53:22 +0200339 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200340void mbedtls_cipher_init( mbedtls_cipher_context_t *ctx );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200341
342/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000343 * \brief This function frees and clears the cipher-specific
344 * context of \p ctx. Freeing \p ctx itself remains the
345 * responsibility of the caller.
Paul Bakker84bbeb52014-07-01 14:53:22 +0200346 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200347void mbedtls_cipher_free( mbedtls_cipher_context_t *ctx );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200348
Rose Zadik9ba6b622018-01-24 12:59:19 +0000349
Paul Bakker84bbeb52014-07-01 14:53:22 +0200350/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000351 * \brief This function initializes and fills the cipher-context
352 * structure with the appropriate values. It also clears
353 * the structure.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000354 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000355 * \param ctx The context to initialize. May not be NULL.
356 * \param cipher_info The cipher to use.
Paul Bakker84bbeb52014-07-01 14:53:22 +0200357 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100358 * \return \c 0 on success.
359 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on parameter failure.
360 * \return #MBEDTLS_ERR_CIPHER_ALLOC_FAILED if allocation of the
Paul Bakkerff61a782011-06-09 15:42:02 +0000361 * cipher-specific context failed.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000362 *
363 * \internal Currently, the function also clears the structure.
364 * In future versions, the caller will be required to call
365 * mbedtls_cipher_init() on the structure first.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000366 */
Manuel Pégourié-Gonnard8473f872015-05-14 13:51:45 +0200367int mbedtls_cipher_setup( mbedtls_cipher_context_t *ctx, const mbedtls_cipher_info_t *cipher_info );
Paul Bakker8123e9d2011-01-06 15:37:30 +0000368
369/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000370 * \brief This function returns the block size of the given cipher.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000371 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000372 * \param ctx The context of the cipher. Must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000373 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100374 * \return The size of the blocks of the cipher.
375 * \return 0 if \p ctx has not been initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000376 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200377static inline unsigned int mbedtls_cipher_get_block_size( const mbedtls_cipher_context_t *ctx )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000378{
379 if( NULL == ctx || NULL == ctx->cipher_info )
380 return 0;
381
382 return ctx->cipher_info->block_size;
383}
384
385/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000386 * \brief This function returns the mode of operation for
387 * the cipher. For example, MBEDTLS_MODE_CBC.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000388 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000389 * \param ctx The context of the cipher. Must be initialized.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000390 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100391 * \return The mode of operation.
392 * \return #MBEDTLS_MODE_NONE if \p ctx has not been initialized.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000393 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200394static inline mbedtls_cipher_mode_t mbedtls_cipher_get_cipher_mode( const mbedtls_cipher_context_t *ctx )
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000395{
396 if( NULL == ctx || NULL == ctx->cipher_info )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200397 return MBEDTLS_MODE_NONE;
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000398
399 return ctx->cipher_info->mode;
400}
401
402/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000403 * \brief This function returns the size of the IV or nonce
404 * of the cipher, in Bytes.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000405 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000406 * \param ctx The context of the cipher. Must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000407 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100408 * \return The recommended IV size, if no IV has been set.
409 * 0 for ciphers not using IV or nonce.
410 * \return The actual size, if an IV has been set.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000411 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200412static inline int mbedtls_cipher_get_iv_size( const mbedtls_cipher_context_t *ctx )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000413{
414 if( NULL == ctx || NULL == ctx->cipher_info )
415 return 0;
416
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200417 if( ctx->iv_size != 0 )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200418 return (int) ctx->iv_size;
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200419
Manuel Pégourié-Gonnard46c4fa12015-08-12 09:27:55 +0200420 return (int) ctx->cipher_info->iv_size;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000421}
422
423/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000424 * \brief This function returns the type of the given cipher.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000425 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000426 * \param ctx The context of the cipher. Must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000427 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100428 * \return The type of the cipher.
429 * \return #MBEDTLS_CIPHER_NONE if \p ctx has not been initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200431static inline mbedtls_cipher_type_t mbedtls_cipher_get_type( const mbedtls_cipher_context_t *ctx )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000432{
433 if( NULL == ctx || NULL == ctx->cipher_info )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200434 return MBEDTLS_CIPHER_NONE;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000435
436 return ctx->cipher_info->type;
437}
438
439/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000440 * \brief This function returns the name of the given cipher
441 * as a string.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000442 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000443 * \param ctx The context of the cipher. Must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000444 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100445 * \return The name of the cipher.
446 * \return NULL if \p ctx has not been not initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000447 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200448static inline const char *mbedtls_cipher_get_name( const mbedtls_cipher_context_t *ctx )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000449{
450 if( NULL == ctx || NULL == ctx->cipher_info )
451 return 0;
452
453 return ctx->cipher_info->name;
454}
455
456/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000457 * \brief This function returns the key length of the cipher.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000458 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000459 * \param ctx The context of the cipher. Must be initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000460 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100461 * \return The key length of the cipher in bits.
462 * \return #MBEDTLS_KEY_LENGTH_NONE if ctx \p has not been
Rose Zadik9ba6b622018-01-24 12:59:19 +0000463 * initialized.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000464 */
Manuel Pégourié-Gonnard097c7bb2015-06-18 16:43:38 +0200465static inline int mbedtls_cipher_get_key_bitlen( const mbedtls_cipher_context_t *ctx )
Paul Bakker8123e9d2011-01-06 15:37:30 +0000466{
Paul Bakker68884e32013-01-07 18:20:04 +0100467 if( NULL == ctx || NULL == ctx->cipher_info )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200468 return MBEDTLS_KEY_LENGTH_NONE;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000469
Manuel Pégourié-Gonnard46c4fa12015-08-12 09:27:55 +0200470 return (int) ctx->cipher_info->key_bitlen;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000471}
472
473/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000474 * \brief This function returns the operation of the given cipher.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000475 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000476 * \param ctx The context of the cipher. Must be initialized.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000477 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000478 * \return The type of operation: #MBEDTLS_ENCRYPT or
Rose Zadik02f73a62018-03-26 18:02:32 +0100479 * #MBEDTLS_DECRYPT.
480 * \return #MBEDTLS_OPERATION_NONE if \p ctx
Rose Zadik9ba6b622018-01-24 12:59:19 +0000481 * has not been initialized.
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000482 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200483static inline mbedtls_operation_t mbedtls_cipher_get_operation( const mbedtls_cipher_context_t *ctx )
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000484{
485 if( NULL == ctx || NULL == ctx->cipher_info )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200486 return MBEDTLS_OPERATION_NONE;
Paul Bakkerf7e5bb52011-11-11 10:53:37 +0000487
488 return ctx->operation;
489}
490
491/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000492 * \brief This function sets the key to use with the given context.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000493 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000494 * \param ctx The generic cipher context. May not be NULL. Must have
495 * been initialized using mbedtls_cipher_info_from_type()
496 * or mbedtls_cipher_info_from_string().
Paul Bakker8123e9d2011-01-06 15:37:30 +0000497 * \param key The key to use.
Rose Zadik9ba6b622018-01-24 12:59:19 +0000498 * \param key_bitlen The key length to use, in bits.
499 * \param operation The operation that the key will be used for:
500 * #MBEDTLS_ENCRYPT or #MBEDTLS_DECRYPT.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000501 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100502 * \returns \c 0 on success.
503 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA if
504 * parameter verification fails.
505 * \return A cipher-specific error code.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000506 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200507int mbedtls_cipher_setkey( mbedtls_cipher_context_t *ctx, const unsigned char *key,
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +0200508 int key_bitlen, const mbedtls_operation_t operation );
Paul Bakker8123e9d2011-01-06 15:37:30 +0000509
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200510#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Paul Bakker8123e9d2011-01-06 15:37:30 +0000511/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000512 * \brief This function sets the padding mode, for cipher modes
513 * that use padding.
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200514 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000515 * The default passing mode is PKCS7 padding.
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200516 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000517 * \param ctx The generic cipher context.
518 * \param mode The padding mode.
519 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100520 * \returns \c 0 on success.
521 * \return #MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE
522 * if the selected padding mode is not supported.
523 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA if the cipher mode
Paul Bakker1a45d912013-08-14 12:04:26 +0200524 * does not support padding.
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200525 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526int mbedtls_cipher_set_padding_mode( mbedtls_cipher_context_t *ctx, mbedtls_cipher_padding_t mode );
527#endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
Manuel Pégourié-Gonnardd5fdcaf2013-07-24 18:05:00 +0200528
529/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000530 * \brief This function sets the initialization vector (IV)
531 * or nonce.
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200532 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100533 * \note Some ciphers do not use IVs nor nonce. For these
534 * ciphers, this function has no effect.
535 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000536 * \param ctx The generic cipher context.
537 * \param iv The IV to use, or NONCE_COUNTER for CTR-mode ciphers.
538 * \param iv_len The IV length for ciphers with variable-size IV.
539 * This parameter is discarded by ciphers with fixed-size IV.
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200540 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100541 * \returns \c 0 on success.
542 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on failure.
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544int mbedtls_cipher_set_iv( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200545 const unsigned char *iv, size_t iv_len );
546
547/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000548 * \brief This function resets the cipher state.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000549 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000550 * \param ctx The generic cipher context.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000551 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100552 * \returns \c 0 on success.
553 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA
Rose Zadik9ba6b622018-01-24 12:59:19 +0000554 * if parameter verification fails.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000555 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200556int mbedtls_cipher_reset( mbedtls_cipher_context_t *ctx );
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200557
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200558#if defined(MBEDTLS_GCM_C)
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200559/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000560 * \brief This function adds additional data for AEAD ciphers.
561 * Only supported with GCM. Must be called
562 * exactly once, after mbedtls_cipher_reset().
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200563 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000564 * \param ctx The generic cipher context.
565 * \param ad The additional data to use.
566 * \param ad_len the Length of \p ad.
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200567 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100568 * \return \c 0 on success.
569 * \return A specific error code on failure.
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571int mbedtls_cipher_update_ad( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200572 const unsigned char *ad, size_t ad_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200573#endif /* MBEDTLS_GCM_C */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000574
575/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000576 * \brief The generic cipher update function. It encrypts or
577 * decrypts using the given cipher context. Writes as
578 * many block-sized blocks of data as possible to output.
579 * Any data that cannot be written immediately is either
580 * added to the next block, or flushed when
581 * mbedtls_cipher_finish() is called.
582 * Exception: For MBEDTLS_MODE_ECB, expects a single block
583 * in size. For example, 16 Bytes for AES.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000584 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100585 * \note If the underlying cipher is GCM, all calls to this
586 * function, except the last one before
587 * mbedtls_cipher_finish(). Must have \p ilen as a
588 * multiple of the block_size.
589 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000590 * \param ctx The generic cipher context.
591 * \param input The buffer holding the input data.
592 * \param ilen The length of the input data.
593 * \param output The buffer for the output data. Must be able to hold at
594 * least \p ilen + block_size. Must not be the same buffer
595 * as input.
596 * \param olen The length of the output data, to be updated with the
597 * actual number of Bytes written.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000598 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100599 * \returns \c 0 on success.
600 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA if
601 * parameter verification fails.
602 * \return #MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE on an
603 * unsupported mode for a cipher.
604 * \return A cipher-specific error code.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000605 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200606int mbedtls_cipher_update( mbedtls_cipher_context_t *ctx, const unsigned char *input,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200607 size_t ilen, unsigned char *output, size_t *olen );
Paul Bakker8123e9d2011-01-06 15:37:30 +0000608
609/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000610 * \brief The generic cipher finalization function. If data still
611 * needs to be flushed from an incomplete block, the data
612 * contained in it is padded to the size of
613 * the last block, and written to the \p output buffer.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000614 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000615 * \param ctx The generic cipher context.
616 * \param output The buffer to write data to. Needs block_size available.
617 * \param olen The length of the data written to the \p output buffer.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000618 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100619 * \returns \c 0 on success.
620 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA if
621 * parameter verification fails.
622 * \return #MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED if decryption
623 * expected a full block but was not provided one.
624 * \return #MBEDTLS_ERR_CIPHER_INVALID_PADDING on invalid padding
625 * while decrypting.
626 * \return A cipher-specific error code on failure for any other
627 * reason.
Paul Bakker8123e9d2011-01-06 15:37:30 +0000628 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200629int mbedtls_cipher_finish( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200630 unsigned char *output, size_t *olen );
631
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200632#if defined(MBEDTLS_GCM_C)
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200633/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000634 * \brief This function writes a tag for AEAD ciphers.
635 * Only supported with GCM.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200636 * Must be called after mbedtls_cipher_finish().
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200637 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000638 * \param ctx The generic cipher context.
639 * \param tag The buffer to write the tag to.
640 * \param tag_len The length of the tag to write.
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200641 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100642 * \return \c 0 on success.
643 * \return A specific error code on failure.
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200644 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200645int mbedtls_cipher_write_tag( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200646 unsigned char *tag, size_t tag_len );
647
648/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000649 * \brief This function checks the tag for AEAD ciphers.
650 * Only supported with GCM.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200651 * Must be called after mbedtls_cipher_finish().
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200652 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000653 * \param ctx The generic cipher context.
654 * \param tag The buffer holding the tag.
655 * \param tag_len The length of the tag to check.
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200656 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100657 * \return \c 0 on success.
658 * \return A specific error code on failure.
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200659 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200660int mbedtls_cipher_check_tag( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +0200661 const unsigned char *tag, size_t tag_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200662#endif /* MBEDTLS_GCM_C */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000663
Paul Bakker8123e9d2011-01-06 15:37:30 +0000664/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000665 * \brief The generic all-in-one encryption/decryption function,
666 * for all ciphers except AEAD constructs.
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +0200667 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000668 * \param ctx The generic cipher context.
669 * \param iv The IV to use, or NONCE_COUNTER for CTR-mode ciphers.
670 * \param iv_len The IV length for ciphers with variable-size IV.
671 * This parameter is discarded by ciphers with fixed-size
672 * IV.
673 * \param input The buffer holding the input data.
674 * \param ilen The length of the input data.
675 * \param output The buffer for the output data. Must be able to hold at
676 * least \p ilen + block_size. Must not be the same buffer
677 * as input.
678 * \param olen The length of the output data, to be updated with the
679 * actual number of Bytes written.
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +0200680 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000681 * \note Some ciphers do not use IVs nor nonce. For these
682 * ciphers, use \p iv = NULL and \p iv_len = 0.
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +0200683 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100684 * \returns \c 0 on success.
685 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA, or
Rose Zadik9ba6b622018-01-24 12:59:19 +0000686 * #MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED if decryption
Rose Zadik02f73a62018-03-26 18:02:32 +0100687 * expected a full block but was not provided one.
688 * \return #MBEDTLS_ERR_CIPHER_INVALID_PADDING on invalid padding
689 * while decrypting.
690 * \return A cipher-specific error code on failure for any other
691 * reason.
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +0200692 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693int mbedtls_cipher_crypt( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +0200694 const unsigned char *iv, size_t iv_len,
695 const unsigned char *input, size_t ilen,
696 unsigned char *output, size_t *olen );
697
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200698#if defined(MBEDTLS_CIPHER_MODE_AEAD)
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200699/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000700 * \brief The generic autenticated encryption (AEAD) function.
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200701 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000702 * \param ctx The generic cipher context.
703 * \param iv The IV to use, or NONCE_COUNTER for CTR-mode ciphers.
704 * \param iv_len The IV length for ciphers with variable-size IV.
705 * This parameter is discarded by ciphers with fixed-size IV.
706 * \param ad The additional data to authenticate.
707 * \param ad_len The length of \p ad.
708 * \param input The buffer holding the input data.
709 * \param ilen The length of the input data.
710 * \param output The buffer for the output data.
711 * Must be able to hold at least \p ilen.
712 * \param olen The length of the output data, to be updated with the
713 * actual number of Bytes written.
714 * \param tag The buffer for the authentication tag.
715 * \param tag_len The desired length of the authentication tag.
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200716 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100717 * \returns \c 0 on success.
718 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA.
719 * \return A cipher-specific error code.
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200720 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200721int mbedtls_cipher_auth_encrypt( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200722 const unsigned char *iv, size_t iv_len,
723 const unsigned char *ad, size_t ad_len,
724 const unsigned char *input, size_t ilen,
725 unsigned char *output, size_t *olen,
726 unsigned char *tag, size_t tag_len );
727
728/**
Rose Zadik9ba6b622018-01-24 12:59:19 +0000729 * \brief The generic autenticated decryption (AEAD) function.
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200730 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100731 * \note If the data is not authentic, then the output buffer
732 * is zeroed out to prevent the unauthentic plaintext being
733 * used, making this interface safer.
734 *
Rose Zadik9ba6b622018-01-24 12:59:19 +0000735 * \param ctx The generic cipher context.
736 * \param iv The IV to use, or NONCE_COUNTER for CTR-mode ciphers.
737 * \param iv_len The IV length for ciphers with variable-size IV.
738 * This parameter is discarded by ciphers with fixed-size IV.
739 * \param ad The additional data to be authenticated.
740 * \param ad_len The length of \p ad.
741 * \param input The buffer holding the input data.
742 * \param ilen The length of the input data.
743 * \param output The buffer for the output data.
744 * Must be able to hold at least \p ilen.
745 * \param olen The length of the output data, to be updated with the
746 * actual number of Bytes written.
747 * \param tag The buffer holding the authentication tag.
748 * \param tag_len The length of the authentication tag.
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200749 *
Rose Zadik02f73a62018-03-26 18:02:32 +0100750 * \returns \c 0 on success.
751 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA.
752 * \return #MBEDTLS_ERR_CIPHER_AUTH_FAILED if data is not authentic.
753 * \return A cipher-specific error code on failure for any other reason.
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200754 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200755int mbedtls_cipher_auth_decrypt( mbedtls_cipher_context_t *ctx,
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200756 const unsigned char *iv, size_t iv_len,
757 const unsigned char *ad, size_t ad_len,
758 const unsigned char *input, size_t ilen,
759 unsigned char *output, size_t *olen,
760 const unsigned char *tag, size_t tag_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200761#endif /* MBEDTLS_CIPHER_MODE_AEAD */
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +0200762
Paul Bakker8123e9d2011-01-06 15:37:30 +0000763#ifdef __cplusplus
764}
765#endif
766
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767#endif /* MBEDTLS_CIPHER_H */