blob: d28310847a10e3e771eaec9147930ecdae262b11 [file] [log] [blame]
Paul Bakker8123e9d2011-01-06 15:37:30 +00001/**
Manuel Pégourié-Gonnard50518f42015-05-26 11:04:15 +02002 * \file cipher_internal.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
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if !defined(MBEDTLS_CONFIG_FILE)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010028#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020029#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020030#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020031#endif
Manuel Pégourié-Gonnard6c5abfa2015-02-13 14:12:07 +000032
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010033#include "mbedtls/cipher.h"
Paul Bakker8123e9d2011-01-06 15:37:30 +000034
Hanno Becker6118e432018-11-09 16:47:20 +000035#if defined(MBEDTLS_USE_PSA_CRYPTO)
36#include "psa/crypto.h"
37#endif /* MBEDTLS_USE_PSA_CRYPTO */
38
Paul Bakker8123e9d2011-01-06 15:37:30 +000039#ifdef __cplusplus
40extern "C" {
41#endif
42
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +010043/**
44 * Base cipher information. The non-mode specific functions and values.
45 */
46struct mbedtls_cipher_base_t
47{
48 /** Base Cipher type (e.g. MBEDTLS_CIPHER_ID_AES) */
49 mbedtls_cipher_id_t cipher;
50
51 /** Encrypt using ECB */
52 int (*ecb_func)( void *ctx, mbedtls_operation_t mode,
53 const unsigned char *input, unsigned char *output );
54
55#if defined(MBEDTLS_CIPHER_MODE_CBC)
56 /** Encrypt using CBC */
57 int (*cbc_func)( void *ctx, mbedtls_operation_t mode, size_t length,
58 unsigned char *iv, const unsigned char *input,
59 unsigned char *output );
60#endif
61
62#if defined(MBEDTLS_CIPHER_MODE_CFB)
63 /** Encrypt using CFB (Full length) */
64 int (*cfb_func)( void *ctx, mbedtls_operation_t mode, size_t length, size_t *iv_off,
65 unsigned char *iv, const unsigned char *input,
66 unsigned char *output );
67#endif
68
Simon Butcher8c0fd1e2018-04-22 22:58:07 +010069#if defined(MBEDTLS_CIPHER_MODE_OFB)
70 /** Encrypt using OFB (Full length) */
71 int (*ofb_func)( void *ctx, size_t length, size_t *iv_off,
72 unsigned char *iv,
73 const unsigned char *input,
74 unsigned char *output );
75#endif
76
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +010077#if defined(MBEDTLS_CIPHER_MODE_CTR)
78 /** Encrypt using CTR */
79 int (*ctr_func)( void *ctx, size_t length, size_t *nc_off,
80 unsigned char *nonce_counter, unsigned char *stream_block,
81 const unsigned char *input, unsigned char *output );
82#endif
83
Jaeden Ameroc6539902018-04-30 17:17:41 +010084#if defined(MBEDTLS_CIPHER_MODE_XTS)
85 /** Encrypt or decrypt using XTS. */
86 int (*xts_func)( void *ctx, mbedtls_operation_t mode, size_t length,
87 const unsigned char data_unit[16],
88 const unsigned char *input, unsigned char *output );
89#endif
90
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +010091#if defined(MBEDTLS_CIPHER_MODE_STREAM)
92 /** Encrypt using STREAM */
93 int (*stream_func)( void *ctx, size_t length,
94 const unsigned char *input, unsigned char *output );
95#endif
96
97 /** Set key for encryption purposes */
98 int (*setkey_enc_func)( void *ctx, const unsigned char *key,
Manuel Pégourié-Gonnard898e0aa2015-06-18 15:28:12 +020099 unsigned int key_bitlen );
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100100
101 /** Set key for decryption purposes */
102 int (*setkey_dec_func)( void *ctx, const unsigned char *key,
Manuel Pégourié-Gonnard898e0aa2015-06-18 15:28:12 +0200103 unsigned int key_bitlen);
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100104
105 /** Allocate a new context */
106 void * (*ctx_alloc_func)( void );
107
108 /** Free the given context */
109 void (*ctx_free_func)( void *ctx );
110
111};
112
Manuel Pégourié-Gonnarddace82f2013-09-18 15:12:07 +0200113typedef struct
114{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200115 mbedtls_cipher_type_t type;
116 const mbedtls_cipher_info_t *info;
117} mbedtls_cipher_definition_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000118
Hanno Becker6118e432018-11-09 16:47:20 +0000119#if defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Becker19086552018-11-17 22:11:16 +0000120typedef enum
121{
122 MBEDTLS_CIPHER_PSA_KEY_UNSET = 0,
Hanno Becker9de97d72018-11-19 14:05:48 +0000123 MBEDTLS_CIPHER_PSA_KEY_OWNED, /* Used for PSA-based cipher contexts which */
124 /* use raw key material internally imported */
Gilles Peskine11392492019-05-27 14:53:19 +0200125 /* as a volatile key, and which hence need */
126 /* to destroy that key when the context is */
127 /* freed. */
Hanno Becker9de97d72018-11-19 14:05:48 +0000128 MBEDTLS_CIPHER_PSA_KEY_NOT_OWNED, /* Used for PSA-based cipher contexts */
Gilles Peskine11392492019-05-27 14:53:19 +0200129 /* which use a key provided by the */
130 /* user, and which hence will not be */
131 /* destroyed when the context is freed. */
Hanno Becker19086552018-11-17 22:11:16 +0000132} mbedtls_cipher_psa_key_ownership;
133
Hanno Becker6118e432018-11-09 16:47:20 +0000134typedef struct
135{
Hanno Beckeredda8b82018-11-12 11:59:30 +0000136 psa_algorithm_t alg;
Andrzej Kurekc7509322019-01-08 09:36:01 -0500137 psa_key_handle_t slot;
Hanno Becker19086552018-11-17 22:11:16 +0000138 mbedtls_cipher_psa_key_ownership slot_state;
Hanno Becker6118e432018-11-09 16:47:20 +0000139} mbedtls_cipher_context_psa;
140#endif /* MBEDTLS_USE_PSA_CRYPTO */
141
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200142extern const mbedtls_cipher_definition_t mbedtls_cipher_definitions[];
Paul Bakker5e0efa72013-09-08 23:04:04 +0200143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200144extern int mbedtls_cipher_supported[];
Paul Bakkerfab5c822012-02-06 16:45:10 +0000145
Paul Bakker8123e9d2011-01-06 15:37:30 +0000146#ifdef __cplusplus
147}
148#endif
149
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200150#endif /* MBEDTLS_CIPHER_WRAP_H */