blob: 702b5491c1ecaee86a86c9a24aa0bb854ca22e54 [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/*
Manuel Pégourié-Gonnard6fb81872015-07-27 11:11:48 +02009 * Copyright (C) 2006-2015, ARM Limited, 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 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000024 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker8123e9d2011-01-06 15:37:30 +000025 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#ifndef MBEDTLS_CIPHER_WRAP_H
27#define MBEDTLS_CIPHER_WRAP_H
Paul Bakker8123e9d2011-01-06 15:37:30 +000028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020029#if !defined(MBEDTLS_CONFIG_FILE)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010030#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020031#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020033#endif
Manuel Pégourié-Gonnard6c5abfa2015-02-13 14:12:07 +000034
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010035#include "mbedtls/cipher.h"
Paul Bakker8123e9d2011-01-06 15:37:30 +000036
Hanno Becker6118e432018-11-09 16:47:20 +000037#if defined(MBEDTLS_USE_PSA_CRYPTO)
38#include "psa/crypto.h"
39#endif /* MBEDTLS_USE_PSA_CRYPTO */
40
Paul Bakker8123e9d2011-01-06 15:37:30 +000041#ifdef __cplusplus
42extern "C" {
43#endif
44
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +010045/**
46 * Base cipher information. The non-mode specific functions and values.
47 */
48struct mbedtls_cipher_base_t
49{
50 /** Base Cipher type (e.g. MBEDTLS_CIPHER_ID_AES) */
51 mbedtls_cipher_id_t cipher;
52
53 /** Encrypt using ECB */
54 int (*ecb_func)( void *ctx, mbedtls_operation_t mode,
55 const unsigned char *input, unsigned char *output );
56
57#if defined(MBEDTLS_CIPHER_MODE_CBC)
58 /** Encrypt using CBC */
59 int (*cbc_func)( void *ctx, mbedtls_operation_t mode, size_t length,
60 unsigned char *iv, const unsigned char *input,
61 unsigned char *output );
62#endif
63
64#if defined(MBEDTLS_CIPHER_MODE_CFB)
65 /** Encrypt using CFB (Full length) */
66 int (*cfb_func)( void *ctx, mbedtls_operation_t mode, size_t length, size_t *iv_off,
67 unsigned char *iv, const unsigned char *input,
68 unsigned char *output );
69#endif
70
Simon Butcher8c0fd1e2018-04-22 22:58:07 +010071#if defined(MBEDTLS_CIPHER_MODE_OFB)
72 /** Encrypt using OFB (Full length) */
73 int (*ofb_func)( void *ctx, size_t length, size_t *iv_off,
74 unsigned char *iv,
75 const unsigned char *input,
76 unsigned char *output );
77#endif
78
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +010079#if defined(MBEDTLS_CIPHER_MODE_CTR)
80 /** Encrypt using CTR */
81 int (*ctr_func)( void *ctx, size_t length, size_t *nc_off,
82 unsigned char *nonce_counter, unsigned char *stream_block,
83 const unsigned char *input, unsigned char *output );
84#endif
85
Jaeden Ameroc6539902018-04-30 17:17:41 +010086#if defined(MBEDTLS_CIPHER_MODE_XTS)
87 /** Encrypt or decrypt using XTS. */
88 int (*xts_func)( void *ctx, mbedtls_operation_t mode, size_t length,
89 const unsigned char data_unit[16],
90 const unsigned char *input, unsigned char *output );
91#endif
92
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +010093#if defined(MBEDTLS_CIPHER_MODE_STREAM)
94 /** Encrypt using STREAM */
95 int (*stream_func)( void *ctx, size_t length,
96 const unsigned char *input, unsigned char *output );
97#endif
98
99 /** Set key for encryption purposes */
100 int (*setkey_enc_func)( void *ctx, const unsigned char *key,
Manuel Pégourié-Gonnard898e0aa2015-06-18 15:28:12 +0200101 unsigned int key_bitlen );
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100102
103 /** Set key for decryption purposes */
104 int (*setkey_dec_func)( void *ctx, const unsigned char *key,
Manuel Pégourié-Gonnard898e0aa2015-06-18 15:28:12 +0200105 unsigned int key_bitlen);
Manuel Pégourié-Gonnard5a74e8b2015-05-06 17:10:55 +0100106
107 /** Allocate a new context */
108 void * (*ctx_alloc_func)( void );
109
110 /** Free the given context */
111 void (*ctx_free_func)( void *ctx );
112
113};
114
Manuel Pégourié-Gonnarddace82f2013-09-18 15:12:07 +0200115typedef struct
116{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200117 mbedtls_cipher_type_t type;
118 const mbedtls_cipher_info_t *info;
119} mbedtls_cipher_definition_t;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000120
Hanno Becker6118e432018-11-09 16:47:20 +0000121#if defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Becker19086552018-11-17 22:11:16 +0000122typedef enum
123{
124 MBEDTLS_CIPHER_PSA_KEY_UNSET = 0,
Hanno Becker9de97d72018-11-19 14:05:48 +0000125 MBEDTLS_CIPHER_PSA_KEY_OWNED, /* Used for PSA-based cipher contexts which */
126 /* use raw key material internally imported */
127 /* into a allocated key slot, and which */
128 /* hence need to destroy that key slot */
129 /* when they are no longer needed. */
130 MBEDTLS_CIPHER_PSA_KEY_NOT_OWNED, /* Used for PSA-based cipher contexts */
131 /* which use a key from a key slot */
132 /* provided by the user, and which */
133 /* hence should not be destroyed when */
134 /* the context is no longer needed. */
Hanno Becker19086552018-11-17 22:11:16 +0000135} mbedtls_cipher_psa_key_ownership;
136
Hanno Becker6118e432018-11-09 16:47:20 +0000137typedef struct
138{
Hanno Beckeredda8b82018-11-12 11:59:30 +0000139 psa_algorithm_t alg;
Andrzej Kurekc7509322019-01-08 09:36:01 -0500140 psa_key_handle_t slot;
Hanno Becker19086552018-11-17 22:11:16 +0000141 mbedtls_cipher_psa_key_ownership slot_state;
Hanno Becker6118e432018-11-09 16:47:20 +0000142} mbedtls_cipher_context_psa;
143#endif /* MBEDTLS_USE_PSA_CRYPTO */
144
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200145extern const mbedtls_cipher_definition_t mbedtls_cipher_definitions[];
Paul Bakker5e0efa72013-09-08 23:04:04 +0200146
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200147extern int mbedtls_cipher_supported[];
Paul Bakkerfab5c822012-02-06 16:45:10 +0000148
Paul Bakker8123e9d2011-01-06 15:37:30 +0000149#ifdef __cplusplus
150}
151#endif
152
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153#endif /* MBEDTLS_CIPHER_WRAP_H */