Paul Bakker | 8123e9d | 2011-01-06 15:37:30 +0000 | [diff] [blame] | 1 | /** |
Chris Jones | daacb59 | 2021-03-09 17:03:29 +0000 | [diff] [blame] | 2 | * \file cipher_wrap.h |
Paul Bakker | 9af723c | 2014-05-01 13:03:14 +0200 | [diff] [blame] | 3 | * |
Paul Bakker | 8123e9d | 2011-01-06 15:37:30 +0000 | [diff] [blame] | 4 | * \brief Cipher wrappers. |
| 5 | * |
| 6 | * \author Adriaan de Jong <dejong@fox-it.com> |
Darryl Green | a40a101 | 2018-01-05 15:33:17 +0000 | [diff] [blame] | 7 | */ |
| 8 | /* |
Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 9 | * Copyright The Mbed TLS Contributors |
Manuel Pégourié-Gonnard | 37ff140 | 2015-09-04 14:21:07 +0200 | [diff] [blame] | 10 | * 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 Bakker | 8123e9d | 2011-01-06 15:37:30 +0000 | [diff] [blame] | 23 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 24 | #ifndef MBEDTLS_CIPHER_WRAP_H |
| 25 | #define MBEDTLS_CIPHER_WRAP_H |
Paul Bakker | 8123e9d | 2011-01-06 15:37:30 +0000 | [diff] [blame] | 26 | |
Bence Szépkúti | c662b36 | 2021-05-27 11:25:03 +0200 | [diff] [blame] | 27 | #include "mbedtls/build_info.h" |
Manuel Pégourié-Gonnard | 6c5abfa | 2015-02-13 14:12:07 +0000 | [diff] [blame] | 28 | |
Jaeden Amero | c49fbbf | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 29 | #include "mbedtls/cipher.h" |
Paul Bakker | 8123e9d | 2011-01-06 15:37:30 +0000 | [diff] [blame] | 30 | |
Hanno Becker | 6118e43 | 2018-11-09 16:47:20 +0000 | [diff] [blame] | 31 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
| 32 | #include "psa/crypto.h" |
| 33 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
| 34 | |
Paul Bakker | 8123e9d | 2011-01-06 15:37:30 +0000 | [diff] [blame] | 35 | #ifdef __cplusplus |
| 36 | extern "C" { |
| 37 | #endif |
| 38 | |
Valerio Setti | db1ca8f | 2023-10-11 12:46:16 +0200 | [diff] [blame^] | 39 | /* Support for GCM either through Mbed TLS SW implementation or PSA */ |
| 40 | #if defined(MBEDTLS_GCM_C) || \ |
| 41 | (defined(MBEDTLS_USE_PSA_CRYPTO) && defined(PSA_WANT_ALG_GCM)) |
| 42 | #define MBEDTLS_CIPHER_HAVE_GCM |
| 43 | #endif |
| 44 | |
| 45 | #if (defined(MBEDTLS_GCM_C) && defined(MBEDTLS_AES_C)) || \ |
| 46 | (defined(MBEDTLS_USE_PSA_CRYPTO) && defined(PSA_WANT_ALG_GCM) && defined(PSA_WANT_KEY_TYPE_AES)) |
| 47 | #define MBEDTLS_CIPHER_HAVE_GCM_AES |
| 48 | #endif |
| 49 | |
| 50 | #if defined(MBEDTLS_CCM_C) || \ |
| 51 | (defined(MBEDTLS_USE_PSA_CRYPTO) && defined(PSA_WANT_ALG_CCM)) |
| 52 | #define MBEDTLS_CIPHER_HAVE_CCM |
| 53 | #endif |
| 54 | |
| 55 | #if (defined(MBEDTLS_CCM_C) && defined(MBEDTLS_AES_C)) || \ |
| 56 | (defined(MBEDTLS_USE_PSA_CRYPTO) && defined(PSA_WANT_ALG_CCM) && defined(PSA_WANT_KEY_TYPE_AES)) |
| 57 | #define MBEDTLS_CIPHER_HAVE_CCM_AES |
| 58 | #endif |
| 59 | |
| 60 | #if defined(MBEDTLS_CCM_C) || \ |
| 61 | (defined(MBEDTLS_USE_PSA_CRYPTO) && defined(PSA_WANT_ALG_CCM_STAR_NO_TAG)) |
| 62 | #define MBEDTLS_CIPHER_HAVE_CCM_STAR_NO_TAG |
| 63 | #endif |
| 64 | |
| 65 | #if defined(MBEDTLS_CHACHAPOLY_C) || \ |
| 66 | (defined(MBEDTLS_USE_PSA_CRYPTO) && defined(PSA_WANT_ALG_CHACHA20_POLY1305)) |
| 67 | #define MBEDTLS_CIPHER_HAVE_CHACHAPOLY |
| 68 | #endif |
| 69 | |
| 70 | #if defined(MBEDTLS_CIPHER_HAVE_GCM) || defined(MBEDTLS_CIPHER_HAVE_CCM) || \ |
| 71 | defined(MBEDTLS_CIPHER_HAVE_CCM_STAR_NO_TAG) || defined(MBEDTLS_CIPHER_HAVE_CHACHAPOLY) |
| 72 | #define MBEDTLS_CIPHER_HAVE_SOME_AEAD |
| 73 | #endif |
| 74 | |
Manuel Pégourié-Gonnard | 5a74e8b | 2015-05-06 17:10:55 +0100 | [diff] [blame] | 75 | /** |
| 76 | * Base cipher information. The non-mode specific functions and values. |
| 77 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 78 | struct mbedtls_cipher_base_t { |
Manuel Pégourié-Gonnard | 5a74e8b | 2015-05-06 17:10:55 +0100 | [diff] [blame] | 79 | /** Base Cipher type (e.g. MBEDTLS_CIPHER_ID_AES) */ |
| 80 | mbedtls_cipher_id_t cipher; |
| 81 | |
| 82 | /** Encrypt using ECB */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 83 | int (*ecb_func)(void *ctx, mbedtls_operation_t mode, |
| 84 | const unsigned char *input, unsigned char *output); |
Manuel Pégourié-Gonnard | 5a74e8b | 2015-05-06 17:10:55 +0100 | [diff] [blame] | 85 | |
| 86 | #if defined(MBEDTLS_CIPHER_MODE_CBC) |
| 87 | /** Encrypt using CBC */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 88 | int (*cbc_func)(void *ctx, mbedtls_operation_t mode, size_t length, |
| 89 | unsigned char *iv, const unsigned char *input, |
| 90 | unsigned char *output); |
Manuel Pégourié-Gonnard | 5a74e8b | 2015-05-06 17:10:55 +0100 | [diff] [blame] | 91 | #endif |
| 92 | |
| 93 | #if defined(MBEDTLS_CIPHER_MODE_CFB) |
| 94 | /** Encrypt using CFB (Full length) */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 95 | int (*cfb_func)(void *ctx, mbedtls_operation_t mode, size_t length, size_t *iv_off, |
| 96 | unsigned char *iv, const unsigned char *input, |
| 97 | unsigned char *output); |
Manuel Pégourié-Gonnard | 5a74e8b | 2015-05-06 17:10:55 +0100 | [diff] [blame] | 98 | #endif |
| 99 | |
Simon Butcher | 8c0fd1e | 2018-04-22 22:58:07 +0100 | [diff] [blame] | 100 | #if defined(MBEDTLS_CIPHER_MODE_OFB) |
| 101 | /** Encrypt using OFB (Full length) */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 102 | int (*ofb_func)(void *ctx, size_t length, size_t *iv_off, |
| 103 | unsigned char *iv, |
| 104 | const unsigned char *input, |
| 105 | unsigned char *output); |
Simon Butcher | 8c0fd1e | 2018-04-22 22:58:07 +0100 | [diff] [blame] | 106 | #endif |
| 107 | |
Manuel Pégourié-Gonnard | 5a74e8b | 2015-05-06 17:10:55 +0100 | [diff] [blame] | 108 | #if defined(MBEDTLS_CIPHER_MODE_CTR) |
| 109 | /** Encrypt using CTR */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 110 | int (*ctr_func)(void *ctx, size_t length, size_t *nc_off, |
| 111 | unsigned char *nonce_counter, unsigned char *stream_block, |
| 112 | const unsigned char *input, unsigned char *output); |
Manuel Pégourié-Gonnard | 5a74e8b | 2015-05-06 17:10:55 +0100 | [diff] [blame] | 113 | #endif |
| 114 | |
Jaeden Amero | c653990 | 2018-04-30 17:17:41 +0100 | [diff] [blame] | 115 | #if defined(MBEDTLS_CIPHER_MODE_XTS) |
| 116 | /** Encrypt or decrypt using XTS. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 117 | int (*xts_func)(void *ctx, mbedtls_operation_t mode, size_t length, |
| 118 | const unsigned char data_unit[16], |
| 119 | const unsigned char *input, unsigned char *output); |
Jaeden Amero | c653990 | 2018-04-30 17:17:41 +0100 | [diff] [blame] | 120 | #endif |
| 121 | |
Manuel Pégourié-Gonnard | 5a74e8b | 2015-05-06 17:10:55 +0100 | [diff] [blame] | 122 | #if defined(MBEDTLS_CIPHER_MODE_STREAM) |
| 123 | /** Encrypt using STREAM */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 124 | int (*stream_func)(void *ctx, size_t length, |
| 125 | const unsigned char *input, unsigned char *output); |
Manuel Pégourié-Gonnard | 5a74e8b | 2015-05-06 17:10:55 +0100 | [diff] [blame] | 126 | #endif |
| 127 | |
| 128 | /** Set key for encryption purposes */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 129 | int (*setkey_enc_func)(void *ctx, const unsigned char *key, |
| 130 | unsigned int key_bitlen); |
Manuel Pégourié-Gonnard | 5a74e8b | 2015-05-06 17:10:55 +0100 | [diff] [blame] | 131 | |
| 132 | /** Set key for decryption purposes */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 133 | int (*setkey_dec_func)(void *ctx, const unsigned char *key, |
| 134 | unsigned int key_bitlen); |
Manuel Pégourié-Gonnard | 5a74e8b | 2015-05-06 17:10:55 +0100 | [diff] [blame] | 135 | |
| 136 | /** Allocate a new context */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 137 | void * (*ctx_alloc_func)(void); |
Manuel Pégourié-Gonnard | 5a74e8b | 2015-05-06 17:10:55 +0100 | [diff] [blame] | 138 | |
| 139 | /** Free the given context */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 140 | void (*ctx_free_func)(void *ctx); |
Manuel Pégourié-Gonnard | 5a74e8b | 2015-05-06 17:10:55 +0100 | [diff] [blame] | 141 | |
| 142 | }; |
| 143 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 144 | typedef struct { |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 145 | mbedtls_cipher_type_t type; |
| 146 | const mbedtls_cipher_info_t *info; |
| 147 | } mbedtls_cipher_definition_t; |
Paul Bakker | 8123e9d | 2011-01-06 15:37:30 +0000 | [diff] [blame] | 148 | |
Hanno Becker | 6118e43 | 2018-11-09 16:47:20 +0000 | [diff] [blame] | 149 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 150 | typedef enum { |
Hanno Becker | 1908655 | 2018-11-17 22:11:16 +0000 | [diff] [blame] | 151 | MBEDTLS_CIPHER_PSA_KEY_UNSET = 0, |
Hanno Becker | 9de97d7 | 2018-11-19 14:05:48 +0000 | [diff] [blame] | 152 | MBEDTLS_CIPHER_PSA_KEY_OWNED, /* Used for PSA-based cipher contexts which */ |
| 153 | /* use raw key material internally imported */ |
Gilles Peskine | 1139249 | 2019-05-27 14:53:19 +0200 | [diff] [blame] | 154 | /* as a volatile key, and which hence need */ |
| 155 | /* to destroy that key when the context is */ |
| 156 | /* freed. */ |
Hanno Becker | 9de97d7 | 2018-11-19 14:05:48 +0000 | [diff] [blame] | 157 | MBEDTLS_CIPHER_PSA_KEY_NOT_OWNED, /* Used for PSA-based cipher contexts */ |
Gilles Peskine | 1139249 | 2019-05-27 14:53:19 +0200 | [diff] [blame] | 158 | /* which use a key provided by the */ |
| 159 | /* user, and which hence will not be */ |
| 160 | /* destroyed when the context is freed. */ |
Hanno Becker | 1908655 | 2018-11-17 22:11:16 +0000 | [diff] [blame] | 161 | } mbedtls_cipher_psa_key_ownership; |
| 162 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 163 | typedef struct { |
Hanno Becker | edda8b8 | 2018-11-12 11:59:30 +0000 | [diff] [blame] | 164 | psa_algorithm_t alg; |
Andrzej Kurek | 03e0146 | 2022-01-03 12:53:24 +0100 | [diff] [blame] | 165 | mbedtls_svc_key_id_t slot; |
Hanno Becker | 1908655 | 2018-11-17 22:11:16 +0000 | [diff] [blame] | 166 | mbedtls_cipher_psa_key_ownership slot_state; |
Hanno Becker | 6118e43 | 2018-11-09 16:47:20 +0000 | [diff] [blame] | 167 | } mbedtls_cipher_context_psa; |
| 168 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
| 169 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 170 | extern const mbedtls_cipher_definition_t mbedtls_cipher_definitions[]; |
Paul Bakker | 5e0efa7 | 2013-09-08 23:04:04 +0200 | [diff] [blame] | 171 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 172 | extern int mbedtls_cipher_supported[]; |
Paul Bakker | fab5c82 | 2012-02-06 16:45:10 +0000 | [diff] [blame] | 173 | |
Dave Rodgman | 3b46b77 | 2023-06-24 13:25:06 +0100 | [diff] [blame] | 174 | extern const mbedtls_cipher_base_t *mbedtls_cipher_base_lookup_table[]; |
Dave Rodgman | de3de77 | 2023-06-24 12:51:06 +0100 | [diff] [blame] | 175 | |
Paul Bakker | 8123e9d | 2011-01-06 15:37:30 +0000 | [diff] [blame] | 176 | #ifdef __cplusplus |
| 177 | } |
| 178 | #endif |
| 179 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 180 | #endif /* MBEDTLS_CIPHER_WRAP_H */ |