blob: 53cf12ff4037615a0026e8f728d46d069577c188 [file] [log] [blame]
Paul Bakker8123e9d2011-01-06 15:37:30 +00001/**
Chris Jonesdaacb592021-03-09 17:03:29 +00002 * \file cipher_wrap.h
Paul Bakker9af723c2014-05-01 13:03:14 +02003 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00004 * \brief Cipher wrappers.
5 *
6 * \author Adriaan de Jong <dejong@fox-it.com>
Darryl Greena40a1012018-01-05 15:33:17 +00007 */
8/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02009 * Copyright The Mbed TLS Contributors
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 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020024#ifndef MBEDTLS_CIPHER_WRAP_H
25#define MBEDTLS_CIPHER_WRAP_H
Paul Bakker8123e9d2011-01-06 15:37:30 +000026
Bence Szépkútic662b362021-05-27 11:25:03 +020027#include "mbedtls/build_info.h"
Manuel Pégourié-Gonnard6c5abfa2015-02-13 14:12:07 +000028
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010029#include "mbedtls/cipher.h"
Paul Bakker8123e9d2011-01-06 15:37:30 +000030
Hanno Becker6118e432018-11-09 16:47:20 +000031#if defined(MBEDTLS_USE_PSA_CRYPTO)
32#include "psa/crypto.h"
33#endif /* MBEDTLS_USE_PSA_CRYPTO */
34
Paul Bakker8123e9d2011-01-06 15:37:30 +000035#ifdef __cplusplus
36extern "C" {
37#endif
38
Valerio Settidb1ca8f2023-10-11 12:46:16 +020039/* 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é-Gonnard5a74e8b2015-05-06 17:10:55 +010075/**
76 * Base cipher information. The non-mode specific functions and values.
77 */
Gilles Peskine449bd832023-01-11 14:50:10 +010078struct mbedtls_cipher_base_t {
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +010079 /** Base Cipher type (e.g. MBEDTLS_CIPHER_ID_AES) */
80 mbedtls_cipher_id_t cipher;
81
82 /** Encrypt using ECB */
Gilles Peskine449bd832023-01-11 14:50:10 +010083 int (*ecb_func)(void *ctx, mbedtls_operation_t mode,
84 const unsigned char *input, unsigned char *output);
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +010085
86#if defined(MBEDTLS_CIPHER_MODE_CBC)
87 /** Encrypt using CBC */
Gilles Peskine449bd832023-01-11 14:50:10 +010088 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é-Gonnard5a74e8b2015-05-06 17:10:55 +010091#endif
92
93#if defined(MBEDTLS_CIPHER_MODE_CFB)
94 /** Encrypt using CFB (Full length) */
Gilles Peskine449bd832023-01-11 14:50:10 +010095 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é-Gonnard5a74e8b2015-05-06 17:10:55 +010098#endif
99
Simon Butcher8c0fd1e2018-04-22 22:58:07 +0100100#if defined(MBEDTLS_CIPHER_MODE_OFB)
101 /** Encrypt using OFB (Full length) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100102 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 Butcher8c0fd1e2018-04-22 22:58:07 +0100106#endif
107
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100108#if defined(MBEDTLS_CIPHER_MODE_CTR)
109 /** Encrypt using CTR */
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 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é-Gonnard5a74e8b2015-05-06 17:10:55 +0100113#endif
114
Jaeden Ameroc6539902018-04-30 17:17:41 +0100115#if defined(MBEDTLS_CIPHER_MODE_XTS)
116 /** Encrypt or decrypt using XTS. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 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 Ameroc6539902018-04-30 17:17:41 +0100120#endif
121
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100122#if defined(MBEDTLS_CIPHER_MODE_STREAM)
123 /** Encrypt using STREAM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100124 int (*stream_func)(void *ctx, size_t length,
125 const unsigned char *input, unsigned char *output);
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100126#endif
127
128 /** Set key for encryption purposes */
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 int (*setkey_enc_func)(void *ctx, const unsigned char *key,
130 unsigned int key_bitlen);
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100131
132 /** Set key for decryption purposes */
Gilles Peskine449bd832023-01-11 14:50:10 +0100133 int (*setkey_dec_func)(void *ctx, const unsigned char *key,
134 unsigned int key_bitlen);
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100135
136 /** Allocate a new context */
Gilles Peskine449bd832023-01-11 14:50:10 +0100137 void * (*ctx_alloc_func)(void);
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100138
139 /** Free the given context */
Gilles Peskine449bd832023-01-11 14:50:10 +0100140 void (*ctx_free_func)(void *ctx);
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100141
142};
143
Gilles Peskine449bd832023-01-11 14:50:10 +0100144typedef struct {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200145 mbedtls_cipher_type_t type;
146 const mbedtls_cipher_info_t *info;
147} mbedtls_cipher_definition_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000148
Hanno Becker6118e432018-11-09 16:47:20 +0000149#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100150typedef enum {
Hanno Becker19086552018-11-17 22:11:16 +0000151 MBEDTLS_CIPHER_PSA_KEY_UNSET = 0,
Hanno Becker9de97d72018-11-19 14:05:48 +0000152 MBEDTLS_CIPHER_PSA_KEY_OWNED, /* Used for PSA-based cipher contexts which */
153 /* use raw key material internally imported */
Gilles Peskine11392492019-05-27 14:53:19 +0200154 /* as a volatile key, and which hence need */
155 /* to destroy that key when the context is */
156 /* freed. */
Hanno Becker9de97d72018-11-19 14:05:48 +0000157 MBEDTLS_CIPHER_PSA_KEY_NOT_OWNED, /* Used for PSA-based cipher contexts */
Gilles Peskine11392492019-05-27 14:53:19 +0200158 /* which use a key provided by the */
159 /* user, and which hence will not be */
160 /* destroyed when the context is freed. */
Hanno Becker19086552018-11-17 22:11:16 +0000161} mbedtls_cipher_psa_key_ownership;
162
Gilles Peskine449bd832023-01-11 14:50:10 +0100163typedef struct {
Hanno Beckeredda8b82018-11-12 11:59:30 +0000164 psa_algorithm_t alg;
Andrzej Kurek03e01462022-01-03 12:53:24 +0100165 mbedtls_svc_key_id_t slot;
Hanno Becker19086552018-11-17 22:11:16 +0000166 mbedtls_cipher_psa_key_ownership slot_state;
Hanno Becker6118e432018-11-09 16:47:20 +0000167} mbedtls_cipher_context_psa;
168#endif /* MBEDTLS_USE_PSA_CRYPTO */
169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170extern const mbedtls_cipher_definition_t mbedtls_cipher_definitions[];
Paul Bakker5e0efa72013-09-08 23:04:04 +0200171
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200172extern int mbedtls_cipher_supported[];
Paul Bakkerfab5c822012-02-06 16:45:10 +0000173
Dave Rodgman3b46b772023-06-24 13:25:06 +0100174extern const mbedtls_cipher_base_t *mbedtls_cipher_base_lookup_table[];
Dave Rodgmande3de772023-06-24 12:51:06 +0100175
Paul Bakker8123e9d2011-01-06 15:37:30 +0000176#ifdef __cplusplus
177}
178#endif
179
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180#endif /* MBEDTLS_CIPHER_WRAP_H */