blob: eeb460eb6f97bd3fb5423127b6eb472fd5bb2f0a [file] [log] [blame]
Gilles Peskine0cad07c2018-06-27 19:49:02 +02001/**
2 * \file psa/crypto_sizes.h
3 *
4 * \brief PSA cryptography module: Mbed TLS buffer size macros
5 *
Gilles Peskine07c91f52018-06-28 18:02:53 +02006 * \note This file may not be included directly. Applications must
7 * include psa/crypto.h.
8 *
Gilles Peskine0cad07c2018-06-27 19:49:02 +02009 * This file contains the definitions of macros that are useful to
10 * compute buffer sizes. The signatures and semantics of these macros
11 * are standardized, but the definitions are not, because they depend on
12 * the available algorithms and, in some cases, on permitted tolerances
13 * on buffer sizes.
Gilles Peskine49cee6c2018-06-27 21:03:58 +020014 *
Gilles Peskine07c91f52018-06-28 18:02:53 +020015 * In implementations with isolation between the application and the
16 * cryptography module, implementers should take care to ensure that
17 * the definitions that are exposed to applications match what the
18 * module implements.
19 *
Gilles Peskine49cee6c2018-06-27 21:03:58 +020020 * Macros that compute sizes whose values do not depend on the
21 * implementation are in crypto.h.
Gilles Peskine0cad07c2018-06-27 19:49:02 +020022 */
23/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020024 * Copyright The Mbed TLS Contributors
Gilles Peskine0cad07c2018-06-27 19:49:02 +020025 * SPDX-License-Identifier: Apache-2.0
26 *
27 * Licensed under the Apache License, Version 2.0 (the "License"); you may
28 * not use this file except in compliance with the License.
29 * You may obtain a copy of the License at
30 *
31 * http://www.apache.org/licenses/LICENSE-2.0
32 *
33 * Unless required by applicable law or agreed to in writing, software
34 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
35 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
36 * See the License for the specific language governing permissions and
37 * limitations under the License.
Gilles Peskine0cad07c2018-06-27 19:49:02 +020038 */
39
40#ifndef PSA_CRYPTO_SIZES_H
41#define PSA_CRYPTO_SIZES_H
42
Ronald Cronf6236f02023-01-26 16:22:25 +010043/*
44 * Include the build-time configuration information file. Here, we do not
45 * include `"mbedtls/build_info.h"` directly but `"psa/build_info.h"`, which
46 * is basically just an alias to it. This is to ease the maintenance of the
47 * PSA cryptography repository which has a different build system and
48 * configuration.
49 */
50#include "psa/build_info.h"
Gilles Peskine0cad07c2018-06-27 19:49:02 +020051
Gilles Peskinea7c26db2018-12-12 13:42:25 +010052#define PSA_BITS_TO_BYTES(bits) (((bits) + 7) / 8)
53#define PSA_BYTES_TO_BITS(bytes) ((bytes) * 8)
Przemek Stekiel654bef02022-12-15 13:28:02 +010054#define PSA_MAX_OF_THREE(a, b, c) ((a) <= (b) ? (b) <= (c) ? \
55 (c) : (b) : (a) <= (c) ? (c) : (a))
Gilles Peskinea7c26db2018-12-12 13:42:25 +010056
Gilles Peskine248010c2019-05-14 16:08:59 +020057#define PSA_ROUND_UP_TO_MULTIPLE(block_size, length) \
58 (((length) + (block_size) - 1) / (block_size) * (block_size))
59
Gilles Peskinea7c26db2018-12-12 13:42:25 +010060/** The size of the output of psa_hash_finish(), in bytes.
61 *
62 * This is also the hash size that psa_hash_verify() expects.
63 *
64 * \param alg A hash algorithm (\c PSA_ALG_XXX value such that
65 * #PSA_ALG_IS_HASH(\p alg) is true), or an HMAC algorithm
66 * (#PSA_ALG_HMAC(\c hash_alg) where \c hash_alg is a
67 * hash algorithm).
68 *
69 * \return The hash size for the specified hash algorithm.
70 * If the hash algorithm is not recognized, return 0.
Gilles Peskinea7c26db2018-12-12 13:42:25 +010071 */
gabor-mezei-armcbcec212020-12-18 14:23:51 +010072#define PSA_HASH_LENGTH(alg) \
73 ( \
Gilles Peskinea7c26db2018-12-12 13:42:25 +010074 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_MD5 ? 16 : \
75 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_RIPEMD160 ? 20 : \
76 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_1 ? 20 : \
77 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_224 ? 28 : \
78 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_256 ? 32 : \
79 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_384 ? 48 : \
80 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_512 ? 64 : \
81 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_512_224 ? 28 : \
82 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_512_256 ? 32 : \
83 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA3_224 ? 28 : \
84 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA3_256 ? 32 : \
85 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA3_384 ? 48 : \
86 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA3_512 ? 64 : \
87 0)
88
Mateusz Starzyk7d262dd2021-08-26 13:28:46 +020089/** The input block size of a hash algorithm, in bytes.
90 *
91 * Hash algorithms process their input data in blocks. Hash operations will
92 * retain any partial blocks until they have enough input to fill the block or
93 * until the operation is finished.
94 * This affects the output from psa_hash_suspend().
95 *
96 * \param alg A hash algorithm (\c PSA_ALG_XXX value such that
97 * PSA_ALG_IS_HASH(\p alg) is true).
98 *
99 * \return The block size in bytes for the specified hash algorithm.
100 * If the hash algorithm is not recognized, return 0.
101 * An implementation can return either 0 or the correct size for a
102 * hash algorithm that it recognizes, but does not support.
103 */
104#define PSA_HASH_BLOCK_LENGTH(alg) \
105 ( \
106 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_MD5 ? 64 : \
107 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_RIPEMD160 ? 64 : \
108 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_1 ? 64 : \
109 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_224 ? 64 : \
110 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_256 ? 64 : \
111 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_384 ? 128 : \
112 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_512 ? 128 : \
113 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_512_224 ? 128 : \
114 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_512_256 ? 128 : \
115 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA3_224 ? 144 : \
116 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA3_256 ? 136 : \
117 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA3_384 ? 104 : \
118 PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA3_512 ? 72 : \
119 0)
120
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200121/** \def PSA_HASH_MAX_SIZE
122 *
123 * Maximum size of a hash.
124 *
gabor-mezei-armc6f24802021-02-15 15:56:29 +0100125 * This macro expands to a compile-time constant integer. This value
126 * is the maximum size of a hash in bytes.
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200127 */
Gilles Peskine3052f532018-09-17 14:13:26 +0200128/* Note: for HMAC-SHA-3, the block size is 144 bytes for HMAC-SHA3-226,
129 * 136 bytes for HMAC-SHA3-256, 104 bytes for SHA3-384, 72 bytes for
130 * HMAC-SHA3-512. */
Manuel Pégourié-Gonnardc9d98292023-05-24 12:28:38 +0200131/* Note: PSA_HASH_MAX_SIZE should be kept in sync with MBEDTLS_MD_MAX_SIZE,
132 * see the note on MBEDTLS_MD_MAX_SIZE for details. */
Manuel Pégourié-Gonnard45b34512023-03-30 12:19:35 +0200133#if defined(PSA_WANT_ALG_SHA_512)
Gilles Peskine0cad07c2018-06-27 19:49:02 +0200134#define PSA_HASH_MAX_SIZE 64
135#define PSA_HMAC_MAX_HASH_BLOCK_SIZE 128
Manuel Pégourié-Gonnard45b34512023-03-30 12:19:35 +0200136#elif defined(PSA_WANT_ALG_SHA_384)
137#define PSA_HASH_MAX_SIZE 48
138#define PSA_HMAC_MAX_HASH_BLOCK_SIZE 128
139#elif defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine0cad07c2018-06-27 19:49:02 +0200140#define PSA_HASH_MAX_SIZE 32
141#define PSA_HMAC_MAX_HASH_BLOCK_SIZE 64
Manuel Pégourié-Gonnard45b34512023-03-30 12:19:35 +0200142#elif defined(PSA_WANT_ALG_SHA_224)
143#define PSA_HASH_MAX_SIZE 28
144#define PSA_HMAC_MAX_HASH_BLOCK_SIZE 64
145#else /* SHA-1 or smaller */
146#define PSA_HASH_MAX_SIZE 20
147#define PSA_HMAC_MAX_HASH_BLOCK_SIZE 64
Gilles Peskine0cad07c2018-06-27 19:49:02 +0200148#endif
149
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200150/** \def PSA_MAC_MAX_SIZE
151 *
152 * Maximum size of a MAC.
153 *
gabor-mezei-armc6f24802021-02-15 15:56:29 +0100154 * This macro expands to a compile-time constant integer. This value
155 * is the maximum size of a MAC in bytes.
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200156 */
157/* All non-HMAC MACs have a maximum size that's smaller than the
158 * minimum possible value of PSA_HASH_MAX_SIZE in this implementation. */
Gilles Peskinee1f2d7d2018-08-21 14:54:54 +0200159/* Note that the encoding of truncated MAC algorithms limits this value
160 * to 64 bytes.
161 */
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200162#define PSA_MAC_MAX_SIZE PSA_HASH_MAX_SIZE
163
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100164/** The length of a tag for an AEAD algorithm, in bytes.
Gilles Peskinea7c26db2018-12-12 13:42:25 +0100165 *
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100166 * This macro can be used to allocate a buffer of sufficient size to store the
167 * tag output from psa_aead_finish().
168 *
169 * See also #PSA_AEAD_TAG_MAX_SIZE.
170 *
171 * \param key_type The type of the AEAD key.
172 * \param key_bits The size of the AEAD key in bits.
Gilles Peskinea7c26db2018-12-12 13:42:25 +0100173 * \param alg An AEAD algorithm
174 * (\c PSA_ALG_XXX value such that
175 * #PSA_ALG_IS_AEAD(\p alg) is true).
176 *
Bence Szépkútibd98df72021-04-27 04:37:18 +0200177 * \return The tag length for the specified algorithm and key.
Gilles Peskinea7c26db2018-12-12 13:42:25 +0100178 * If the AEAD algorithm does not have an identified
179 * tag that can be distinguished from the rest of
180 * the ciphertext, return 0.
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100181 * If the key type or AEAD algorithm is not
182 * recognized, or the parameters are incompatible,
183 * return 0.
Gilles Peskinea7c26db2018-12-12 13:42:25 +0100184 */
Bence Szépkúti12116bc2021-03-11 15:59:24 +0100185#define PSA_AEAD_TAG_LENGTH(key_type, key_bits, alg) \
Bence Szépkútif5a1fe92021-04-21 10:13:08 +0200186 (PSA_AEAD_NONCE_LENGTH(key_type, alg) != 0 ? \
Bence Szépkúti7e310092021-04-08 12:05:18 +0200187 PSA_ALG_AEAD_GET_TAG_LENGTH(alg) : \
Bence Szépkúti0d8da392021-03-19 19:28:52 +0100188 ((void) (key_bits), 0))
Gilles Peskinea7c26db2018-12-12 13:42:25 +0100189
gabor-mezei-arm0687b2b2020-05-06 16:05:37 +0200190/** The maximum tag size for all supported AEAD algorithms, in bytes.
191 *
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100192 * See also #PSA_AEAD_TAG_LENGTH(\p key_type, \p key_bits, \p alg).
gabor-mezei-arm0687b2b2020-05-06 16:05:37 +0200193 */
gabor-mezei-arme86bdca2021-01-07 14:26:12 +0100194#define PSA_AEAD_TAG_MAX_SIZE 16
gabor-mezei-arm0687b2b2020-05-06 16:05:37 +0200195
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200196/* The maximum size of an RSA key on this implementation, in bits.
197 * This is a vendor-specific macro.
198 *
199 * Mbed TLS does not set a hard limit on the size of RSA keys: any key
200 * whose parameters fit in a bignum is accepted. However large keys can
201 * induce a large memory usage and long computation times. Unlike other
202 * auxiliary macros in this file and in crypto.h, which reflect how the
203 * library is configured, this macro defines how the library is
204 * configured. This implementation refuses to import or generate an
205 * RSA key whose size is larger than the value defined here.
206 *
207 * Note that an implementation may set different size limits for different
208 * operations, and does not need to accept all key sizes up to the limit. */
209#define PSA_VENDOR_RSA_MAX_KEY_BITS 4096
210
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200211/* The maximum size of an DH key on this implementation, in bits.
Przemek Stekieled23b612022-12-01 15:00:41 +0100212 *
213 * Note that an implementation may set different size limits for different
214 * operations, and does not need to accept all key sizes up to the limit. */
215#define PSA_VENDOR_FFDH_MAX_KEY_BITS 8192
216
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200217/* The maximum size of an ECC key on this implementation, in bits.
218 * This is a vendor-specific macro. */
Valerio Setti271c12e2023-03-23 16:30:27 +0100219#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200220#define PSA_VENDOR_ECC_MAX_CURVE_BITS 521
Valerio Setti271c12e2023-03-23 16:30:27 +0100221#elif defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200222#define PSA_VENDOR_ECC_MAX_CURVE_BITS 512
Valerio Setti271c12e2023-03-23 16:30:27 +0100223#elif defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200224#define PSA_VENDOR_ECC_MAX_CURVE_BITS 448
Valerio Setti271c12e2023-03-23 16:30:27 +0100225#elif defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200226#define PSA_VENDOR_ECC_MAX_CURVE_BITS 384
Valerio Setti271c12e2023-03-23 16:30:27 +0100227#elif defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200228#define PSA_VENDOR_ECC_MAX_CURVE_BITS 384
Valerio Setti271c12e2023-03-23 16:30:27 +0100229#elif defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200230#define PSA_VENDOR_ECC_MAX_CURVE_BITS 256
Valerio Setti271c12e2023-03-23 16:30:27 +0100231#elif defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200232#define PSA_VENDOR_ECC_MAX_CURVE_BITS 256
Valerio Setti271c12e2023-03-23 16:30:27 +0100233#elif defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200234#define PSA_VENDOR_ECC_MAX_CURVE_BITS 256
Valerio Setti271c12e2023-03-23 16:30:27 +0100235#elif defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200236#define PSA_VENDOR_ECC_MAX_CURVE_BITS 255
Valerio Setti271c12e2023-03-23 16:30:27 +0100237#elif defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200238#define PSA_VENDOR_ECC_MAX_CURVE_BITS 224
Valerio Setti271c12e2023-03-23 16:30:27 +0100239#elif defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200240#define PSA_VENDOR_ECC_MAX_CURVE_BITS 224
Valerio Setti271c12e2023-03-23 16:30:27 +0100241#elif defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200242#define PSA_VENDOR_ECC_MAX_CURVE_BITS 192
Valerio Setti271c12e2023-03-23 16:30:27 +0100243#elif defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskineaf3baab2018-06-27 22:55:52 +0200244#define PSA_VENDOR_ECC_MAX_CURVE_BITS 192
245#else
246#define PSA_VENDOR_ECC_MAX_CURVE_BITS 0
247#endif
248
gabor-mezei-armbdae9182021-01-28 14:33:10 +0100249/** This macro returns the maximum supported length of the PSK for the
250 * TLS-1.2 PSK-to-MS key derivation
Gilles Peskine364d12c2021-03-08 17:23:47 +0100251 * (#PSA_ALG_TLS12_PSK_TO_MS(\c hash_alg)).
gabor-mezei-armbdae9182021-01-28 14:33:10 +0100252 *
253 * The maximum supported length does not depend on the chosen hash algorithm.
Hanno Becker8dbfca42018-10-12 11:56:55 +0100254 *
255 * Quoting RFC 4279, Sect 5.3:
256 * TLS implementations supporting these ciphersuites MUST support
257 * arbitrary PSK identities up to 128 octets in length, and arbitrary
258 * PSKs up to 64 octets in length. Supporting longer identities and
259 * keys is RECOMMENDED.
260 *
261 * Therefore, no implementation should define a value smaller than 64
gabor-mezei-armcbcec212020-12-18 14:23:51 +0100262 * for #PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE.
Hanno Becker8dbfca42018-10-12 11:56:55 +0100263 */
gabor-mezei-armcbcec212020-12-18 14:23:51 +0100264#define PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE 128
Hanno Becker8dbfca42018-10-12 11:56:55 +0100265
Andrzej Kurek08d34b82022-07-29 10:00:16 -0400266/* The expected size of input passed to psa_tls12_ecjpake_to_pms_input,
267 * which is expected to work with P-256 curve only. */
268#define PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE 65
269
270/* The size of a serialized K.X coordinate to be used in
271 * psa_tls12_ecjpake_to_pms_input. This function only accepts the P-256
272 * curve. */
273#define PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE 32
274
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +0530275/* The maximum number of iterations for PBKDF2 on this implementation, in bits.
276 * This is a vendor-specific macro. This can be configured if necessary */
277#define PSA_VENDOR_PBKDF2_MAX_ITERATIONS 0xffffffff
278
gabor-mezei-armc6f24802021-02-15 15:56:29 +0100279/** The maximum size of a block cipher. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +0100280#define PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE 16
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200281
Gilles Peskineacd4be32018-07-08 19:56:25 +0200282/** The size of the output of psa_mac_sign_finish(), in bytes.
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200283 *
Gilles Peskineacd4be32018-07-08 19:56:25 +0200284 * This is also the MAC size that psa_mac_verify_finish() expects.
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200285 *
gabor-mezei-armcbcec212020-12-18 14:23:51 +0100286 * \warning This macro may evaluate its arguments multiple times or
287 * zero times, so you should not pass arguments that contain
288 * side effects.
289 *
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200290 * \param key_type The type of the MAC key.
291 * \param key_bits The size of the MAC key in bits.
292 * \param alg A MAC algorithm (\c PSA_ALG_XXX value such that
Gilles Peskine63f79302019-02-15 13:01:17 +0100293 * #PSA_ALG_IS_MAC(\p alg) is true).
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200294 *
295 * \return The MAC size for the specified algorithm with
296 * the specified key parameters.
297 * \return 0 if the MAC algorithm is not recognized.
298 * \return Either 0 or the correct size for a MAC algorithm that
299 * the implementation recognizes, but does not support.
300 * \return Unspecified if the key parameters are not consistent
301 * with the algorithm.
302 */
gabor-mezei-armcbcec212020-12-18 14:23:51 +0100303#define PSA_MAC_LENGTH(key_type, key_bits, alg) \
304 ((alg) & PSA_ALG_MAC_TRUNCATION_MASK ? PSA_MAC_TRUNCATED_LENGTH(alg) : \
305 PSA_ALG_IS_HMAC(alg) ? PSA_HASH_LENGTH(PSA_ALG_HMAC_GET_HASH(alg)) : \
306 PSA_ALG_IS_BLOCK_CIPHER_MAC(alg) ? PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) : \
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 ((void) (key_type), (void) (key_bits), 0))
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200308
309/** The maximum size of the output of psa_aead_encrypt(), in bytes.
310 *
311 * If the size of the ciphertext buffer is at least this large, it is
312 * guaranteed that psa_aead_encrypt() will not fail due to an
313 * insufficient buffer size. Depending on the algorithm, the actual size of
314 * the ciphertext may be smaller.
315 *
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100316 * See also #PSA_AEAD_ENCRYPT_OUTPUT_MAX_SIZE(\p plaintext_length).
317 *
gabor-mezei-arme86bdca2021-01-07 14:26:12 +0100318 * \warning This macro may evaluate its arguments multiple times or
319 * zero times, so you should not pass arguments that contain
320 * side effects.
321 *
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100322 * \param key_type A symmetric key type that is
323 * compatible with algorithm \p alg.
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200324 * \param alg An AEAD algorithm
325 * (\c PSA_ALG_XXX value such that
Gilles Peskine63f79302019-02-15 13:01:17 +0100326 * #PSA_ALG_IS_AEAD(\p alg) is true).
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200327 * \param plaintext_length Size of the plaintext in bytes.
328 *
329 * \return The AEAD ciphertext size for the specified
330 * algorithm.
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100331 * If the key type or AEAD algorithm is not
332 * recognized, or the parameters are incompatible,
333 * return 0.
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200334 */
Bence Szépkúti12116bc2021-03-11 15:59:24 +0100335#define PSA_AEAD_ENCRYPT_OUTPUT_SIZE(key_type, alg, plaintext_length) \
Bence Szépkútif5a1fe92021-04-21 10:13:08 +0200336 (PSA_AEAD_NONCE_LENGTH(key_type, alg) != 0 ? \
Bence Szépkúti7e310092021-04-08 12:05:18 +0200337 (plaintext_length) + PSA_ALG_AEAD_GET_TAG_LENGTH(alg) : \
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200338 0)
339
gabor-mezei-arm0687b2b2020-05-06 16:05:37 +0200340/** A sufficient output buffer size for psa_aead_encrypt(), for any of the
341 * supported key types and AEAD algorithms.
342 *
343 * If the size of the ciphertext buffer is at least this large, it is guaranteed
344 * that psa_aead_encrypt() will not fail due to an insufficient buffer size.
345 *
gabor-mezei-arme86bdca2021-01-07 14:26:12 +0100346 * \note This macro returns a compile-time constant if its arguments are
347 * compile-time constants.
348 *
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100349 * See also #PSA_AEAD_ENCRYPT_OUTPUT_SIZE(\p key_type, \p alg,
350 * \p plaintext_length).
gabor-mezei-arm0687b2b2020-05-06 16:05:37 +0200351 *
352 * \param plaintext_length Size of the plaintext in bytes.
353 *
354 * \return A sufficient output buffer size for any of the
355 * supported key types and AEAD algorithms.
356 *
357 */
358#define PSA_AEAD_ENCRYPT_OUTPUT_MAX_SIZE(plaintext_length) \
359 ((plaintext_length) + PSA_AEAD_TAG_MAX_SIZE)
360
361
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200362/** The maximum size of the output of psa_aead_decrypt(), in bytes.
363 *
364 * If the size of the plaintext buffer is at least this large, it is
365 * guaranteed that psa_aead_decrypt() will not fail due to an
366 * insufficient buffer size. Depending on the algorithm, the actual size of
367 * the plaintext may be smaller.
368 *
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100369 * See also #PSA_AEAD_DECRYPT_OUTPUT_MAX_SIZE(\p ciphertext_length).
370 *
gabor-mezei-arme86bdca2021-01-07 14:26:12 +0100371 * \warning This macro may evaluate its arguments multiple times or
372 * zero times, so you should not pass arguments that contain
373 * side effects.
374 *
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100375 * \param key_type A symmetric key type that is
376 * compatible with algorithm \p alg.
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200377 * \param alg An AEAD algorithm
378 * (\c PSA_ALG_XXX value such that
Gilles Peskine63f79302019-02-15 13:01:17 +0100379 * #PSA_ALG_IS_AEAD(\p alg) is true).
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200380 * \param ciphertext_length Size of the plaintext in bytes.
381 *
382 * \return The AEAD ciphertext size for the specified
383 * algorithm.
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100384 * If the key type or AEAD algorithm is not
385 * recognized, or the parameters are incompatible,
386 * return 0.
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200387 */
Bence Szépkúti12116bc2021-03-11 15:59:24 +0100388#define PSA_AEAD_DECRYPT_OUTPUT_SIZE(key_type, alg, ciphertext_length) \
Bence Szépkúti1dda21c2021-04-21 11:09:50 +0200389 (PSA_AEAD_NONCE_LENGTH(key_type, alg) != 0 && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100390 (ciphertext_length) > PSA_ALG_AEAD_GET_TAG_LENGTH(alg) ? \
391 (ciphertext_length) - PSA_ALG_AEAD_GET_TAG_LENGTH(alg) : \
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200392 0)
393
gabor-mezei-arm0687b2b2020-05-06 16:05:37 +0200394/** A sufficient output buffer size for psa_aead_decrypt(), for any of the
395 * supported key types and AEAD algorithms.
396 *
397 * If the size of the plaintext buffer is at least this large, it is guaranteed
398 * that psa_aead_decrypt() will not fail due to an insufficient buffer size.
399 *
gabor-mezei-armc6f24802021-02-15 15:56:29 +0100400 * \note This macro returns a compile-time constant if its arguments are
401 * compile-time constants.
402 *
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100403 * See also #PSA_AEAD_DECRYPT_OUTPUT_SIZE(\p key_type, \p alg,
404 * \p ciphertext_length).
gabor-mezei-arm0687b2b2020-05-06 16:05:37 +0200405 *
406 * \param ciphertext_length Size of the ciphertext in bytes.
407 *
408 * \return A sufficient output buffer size for any of the
409 * supported key types and AEAD algorithms.
410 *
411 */
412#define PSA_AEAD_DECRYPT_OUTPUT_MAX_SIZE(ciphertext_length) \
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 (ciphertext_length)
gabor-mezei-arm0687b2b2020-05-06 16:05:37 +0200414
gabor-mezei-arma200ee62020-12-17 14:09:38 +0100415/** The default nonce size for an AEAD algorithm, in bytes.
416 *
417 * This macro can be used to allocate a buffer of sufficient size to
418 * store the nonce output from #psa_aead_generate_nonce().
419 *
420 * See also #PSA_AEAD_NONCE_MAX_SIZE.
421 *
422 * \note This is not the maximum size of nonce supported as input to
423 * #psa_aead_set_nonce(), #psa_aead_encrypt() or #psa_aead_decrypt(),
424 * just the default size that is generated by #psa_aead_generate_nonce().
425 *
426 * \warning This macro may evaluate its arguments multiple times or
427 * zero times, so you should not pass arguments that contain
428 * side effects.
429 *
430 * \param key_type A symmetric key type that is compatible with
431 * algorithm \p alg.
432 *
433 * \param alg An AEAD algorithm (\c PSA_ALG_XXX value such that
434 * #PSA_ALG_IS_AEAD(\p alg) is true).
435 *
436 * \return The default nonce size for the specified key type and algorithm.
437 * If the key type or AEAD algorithm is not recognized,
438 * or the parameters are incompatible, return 0.
gabor-mezei-arma200ee62020-12-17 14:09:38 +0100439 */
440#define PSA_AEAD_NONCE_LENGTH(key_type, alg) \
Bence Szépkúti0153c942021-03-04 10:32:59 +0100441 (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) == 16 ? \
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 MBEDTLS_PSA_ALG_AEAD_EQUAL(alg, PSA_ALG_CCM) ? 13 : \
443 MBEDTLS_PSA_ALG_AEAD_EQUAL(alg, PSA_ALG_GCM) ? 12 : \
444 0 : \
gabor-mezei-arma200ee62020-12-17 14:09:38 +0100445 (key_type) == PSA_KEY_TYPE_CHACHA20 && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100446 MBEDTLS_PSA_ALG_AEAD_EQUAL(alg, PSA_ALG_CHACHA20_POLY1305) ? 12 : \
gabor-mezei-arma200ee62020-12-17 14:09:38 +0100447 0)
448
449/** The maximum default nonce size among all supported pairs of key types and
450 * AEAD algorithms, in bytes.
451 *
452 * This is equal to or greater than any value that #PSA_AEAD_NONCE_LENGTH()
453 * may return.
454 *
455 * \note This is not the maximum size of nonce supported as input to
456 * #psa_aead_set_nonce(), #psa_aead_encrypt() or #psa_aead_decrypt(),
457 * just the largest size that may be generated by
458 * #psa_aead_generate_nonce().
459 */
Bence Szépkúti0153c942021-03-04 10:32:59 +0100460#define PSA_AEAD_NONCE_MAX_SIZE 13
gabor-mezei-arma200ee62020-12-17 14:09:38 +0100461
Gilles Peskine49dd8d82019-05-06 15:16:19 +0200462/** A sufficient output buffer size for psa_aead_update().
463 *
464 * If the size of the output buffer is at least this large, it is
Gilles Peskineac99e322019-05-14 16:10:53 +0200465 * guaranteed that psa_aead_update() will not fail due to an
Gilles Peskine49dd8d82019-05-06 15:16:19 +0200466 * insufficient buffer size. The actual size of the output may be smaller
467 * in any given call.
468 *
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100469 * See also #PSA_AEAD_UPDATE_OUTPUT_MAX_SIZE(\p input_length).
470 *
gabor-mezei-arme86bdca2021-01-07 14:26:12 +0100471 * \warning This macro may evaluate its arguments multiple times or
472 * zero times, so you should not pass arguments that contain
473 * side effects.
474 *
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100475 * \param key_type A symmetric key type that is
476 * compatible with algorithm \p alg.
Gilles Peskine49dd8d82019-05-06 15:16:19 +0200477 * \param alg An AEAD algorithm
478 * (\c PSA_ALG_XXX value such that
479 * #PSA_ALG_IS_AEAD(\p alg) is true).
480 * \param input_length Size of the input in bytes.
481 *
482 * \return A sufficient output buffer size for the specified
483 * algorithm.
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100484 * If the key type or AEAD algorithm is not
485 * recognized, or the parameters are incompatible,
486 * return 0.
Gilles Peskine49dd8d82019-05-06 15:16:19 +0200487 */
488/* For all the AEAD modes defined in this specification, it is possible
489 * to emit output without delay. However, hardware may not always be
490 * capable of this. So for modes based on a block cipher, allow the
491 * implementation to delay the output until it has a full block. */
Bence Szépkúti12116bc2021-03-11 15:59:24 +0100492#define PSA_AEAD_UPDATE_OUTPUT_SIZE(key_type, alg, input_length) \
Bence Szépkútif5a1fe92021-04-21 10:13:08 +0200493 (PSA_AEAD_NONCE_LENGTH(key_type, alg) != 0 ? \
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER(alg) ? \
495 PSA_ROUND_UP_TO_MULTIPLE(PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type), (input_length)) : \
496 (input_length) : \
Bence Szépkúti12116bc2021-03-11 15:59:24 +0100497 0)
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200498
499/** A sufficient output buffer size for psa_aead_update(), for any of the
500 * supported key types and AEAD algorithms.
501 *
502 * If the size of the output buffer is at least this large, it is guaranteed
503 * that psa_aead_update() will not fail due to an insufficient buffer size.
504 *
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100505 * See also #PSA_AEAD_UPDATE_OUTPUT_SIZE(\p key_type, \p alg, \p input_length).
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200506 *
507 * \param input_length Size of the input in bytes.
508 */
509#define PSA_AEAD_UPDATE_OUTPUT_MAX_SIZE(input_length) \
510 (PSA_ROUND_UP_TO_MULTIPLE(PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE, (input_length)))
Gilles Peskine49dd8d82019-05-06 15:16:19 +0200511
512/** A sufficient ciphertext buffer size for psa_aead_finish().
Gilles Peskinebdc27862019-05-06 15:45:16 +0200513 *
514 * If the size of the ciphertext buffer is at least this large, it is
515 * guaranteed that psa_aead_finish() will not fail due to an
Gilles Peskine49dd8d82019-05-06 15:16:19 +0200516 * insufficient ciphertext buffer size. The actual size of the output may
517 * be smaller in any given call.
Gilles Peskinebdc27862019-05-06 15:45:16 +0200518 *
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100519 * See also #PSA_AEAD_FINISH_OUTPUT_MAX_SIZE.
520 *
521 * \param key_type A symmetric key type that is
522 compatible with algorithm \p alg.
Gilles Peskinebdc27862019-05-06 15:45:16 +0200523 * \param alg An AEAD algorithm
524 * (\c PSA_ALG_XXX value such that
525 * #PSA_ALG_IS_AEAD(\p alg) is true).
526 *
Gilles Peskine49dd8d82019-05-06 15:16:19 +0200527 * \return A sufficient ciphertext buffer size for the
Gilles Peskinebdc27862019-05-06 15:45:16 +0200528 * specified algorithm.
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100529 * If the key type or AEAD algorithm is not
530 * recognized, or the parameters are incompatible,
531 * return 0.
Gilles Peskinebdc27862019-05-06 15:45:16 +0200532 */
Bence Szépkútif5a1fe92021-04-21 10:13:08 +0200533#define PSA_AEAD_FINISH_OUTPUT_SIZE(key_type, alg) \
534 (PSA_AEAD_NONCE_LENGTH(key_type, alg) != 0 && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER(alg) ? \
536 PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) : \
Gilles Peskine49dd8d82019-05-06 15:16:19 +0200537 0)
538
gabor-mezei-arm0687b2b2020-05-06 16:05:37 +0200539/** A sufficient ciphertext buffer size for psa_aead_finish(), for any of the
540 * supported key types and AEAD algorithms.
541 *
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100542 * See also #PSA_AEAD_FINISH_OUTPUT_SIZE(\p key_type, \p alg).
gabor-mezei-arm0687b2b2020-05-06 16:05:37 +0200543 */
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200544#define PSA_AEAD_FINISH_OUTPUT_MAX_SIZE (PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE)
gabor-mezei-arm0687b2b2020-05-06 16:05:37 +0200545
Gilles Peskine49dd8d82019-05-06 15:16:19 +0200546/** A sufficient plaintext buffer size for psa_aead_verify().
547 *
548 * If the size of the plaintext buffer is at least this large, it is
549 * guaranteed that psa_aead_verify() will not fail due to an
550 * insufficient plaintext buffer size. The actual size of the output may
551 * be smaller in any given call.
552 *
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100553 * See also #PSA_AEAD_VERIFY_OUTPUT_MAX_SIZE.
554 *
555 * \param key_type A symmetric key type that is
556 * compatible with algorithm \p alg.
Gilles Peskine49dd8d82019-05-06 15:16:19 +0200557 * \param alg An AEAD algorithm
558 * (\c PSA_ALG_XXX value such that
559 * #PSA_ALG_IS_AEAD(\p alg) is true).
560 *
561 * \return A sufficient plaintext buffer size for the
562 * specified algorithm.
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100563 * If the key type or AEAD algorithm is not
564 * recognized, or the parameters are incompatible,
565 * return 0.
Gilles Peskine49dd8d82019-05-06 15:16:19 +0200566 */
Bence Szépkútif5a1fe92021-04-21 10:13:08 +0200567#define PSA_AEAD_VERIFY_OUTPUT_SIZE(key_type, alg) \
568 (PSA_AEAD_NONCE_LENGTH(key_type, alg) != 0 && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER(alg) ? \
570 PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) : \
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200571 0)
572
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200573/** A sufficient plaintext buffer size for psa_aead_verify(), for any of the
574 * supported key types and AEAD algorithms.
575 *
Bence Szépkútieb1a3012021-03-18 10:33:33 +0100576 * See also #PSA_AEAD_VERIFY_OUTPUT_SIZE(\p key_type, \p alg).
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200577 */
578#define PSA_AEAD_VERIFY_OUTPUT_MAX_SIZE (PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE)
579
Jaeden Amero7f042142019-02-07 10:44:38 +0000580#define PSA_RSA_MINIMUM_PADDING_SIZE(alg) \
581 (PSA_ALG_IS_RSA_OAEP(alg) ? \
gabor-mezei-armd25ea722021-01-21 12:20:08 +0100582 2 * PSA_HASH_LENGTH(PSA_ALG_RSA_OAEP_GET_HASH(alg)) + 1 : \
Gilles Peskinea7c26db2018-12-12 13:42:25 +0100583 11 /*PKCS#1v1.5*/)
584
585/**
586 * \brief ECDSA signature size for a given curve bit size
587 *
588 * \param curve_bits Curve size in bits.
589 * \return Signature size in bytes.
590 *
591 * \note This macro returns a compile-time constant if its argument is one.
592 */
593#define PSA_ECDSA_SIGNATURE_SIZE(curve_bits) \
594 (PSA_BITS_TO_BYTES(curve_bits) * 2)
595
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100596/** Sufficient signature buffer size for psa_sign_hash().
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200597 *
Gilles Peskine56e2dc82019-05-21 15:59:56 +0200598 * This macro returns a sufficient buffer size for a signature using a key
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200599 * of the specified type and size, with the specified algorithm.
600 * Note that the actual size of the signature may be smaller
601 * (some algorithms produce a variable-size signature).
602 *
603 * \warning This function may call its arguments multiple times or
604 * zero times, so you should not pass arguments that contain
605 * side effects.
606 *
607 * \param key_type An asymmetric key type (this may indifferently be a
608 * key pair type or a public key type).
609 * \param key_bits The size of the key in bits.
610 * \param alg The signature algorithm.
611 *
612 * \return If the parameters are valid and supported, return
613 * a buffer size in bytes that guarantees that
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100614 * psa_sign_hash() will not fail with
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200615 * #PSA_ERROR_BUFFER_TOO_SMALL.
gabor-mezei-armc6f24802021-02-15 15:56:29 +0100616 * If the parameters are a valid combination that is not supported,
617 * return either a sensible size or 0.
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200618 * If the parameters are not valid, the
619 * return value is unspecified.
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200620 */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100621#define PSA_SIGN_OUTPUT_SIZE(key_type, key_bits, alg) \
Gilles Peskine449bd832023-01-11 14:50:10 +0100622 (PSA_KEY_TYPE_IS_RSA(key_type) ? ((void) alg, PSA_BITS_TO_BYTES(key_bits)) : \
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200623 PSA_KEY_TYPE_IS_ECC(key_type) ? PSA_ECDSA_SIGNATURE_SIZE(key_bits) : \
Gilles Peskine449bd832023-01-11 14:50:10 +0100624 ((void) alg, 0))
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200625
Gilles Peskine29755712019-11-08 15:49:40 +0100626#define PSA_VENDOR_ECDSA_SIGNATURE_MAX_SIZE \
627 PSA_ECDSA_SIGNATURE_SIZE(PSA_VENDOR_ECC_MAX_CURVE_BITS)
628
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100629/** \def PSA_SIGNATURE_MAX_SIZE
Gilles Peskine29755712019-11-08 15:49:40 +0100630 *
631 * Maximum size of an asymmetric signature.
632 *
gabor-mezei-armc6f24802021-02-15 15:56:29 +0100633 * This macro expands to a compile-time constant integer. This value
634 * is the maximum size of a signature in bytes.
Gilles Peskine29755712019-11-08 15:49:40 +0100635 */
Valerio Settic012a2d2023-07-28 09:34:44 +0200636#define PSA_SIGNATURE_MAX_SIZE 1
Valerio Settia83d9bf2023-07-27 18:15:20 +0200637
638#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC) && \
639 (PSA_VENDOR_ECDSA_SIGNATURE_MAX_SIZE > PSA_SIGNATURE_MAX_SIZE)
640#undef PSA_SIGNATURE_MAX_SIZE
641#define PSA_SIGNATURE_MAX_SIZE PSA_VENDOR_ECDSA_SIGNATURE_MAX_SIZE
642#endif
643#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) && \
644 (PSA_BITS_TO_BYTES(PSA_VENDOR_RSA_MAX_KEY_BITS) > PSA_SIGNATURE_MAX_SIZE)
645#undef PSA_SIGNATURE_MAX_SIZE
646#define PSA_SIGNATURE_MAX_SIZE PSA_BITS_TO_BYTES(PSA_VENDOR_RSA_MAX_KEY_BITS)
647#endif
Gilles Peskine29755712019-11-08 15:49:40 +0100648
Gilles Peskine56e2dc82019-05-21 15:59:56 +0200649/** Sufficient output buffer size for psa_asymmetric_encrypt().
Gilles Peskinedcd14942018-07-12 00:30:52 +0200650 *
Gilles Peskine56e2dc82019-05-21 15:59:56 +0200651 * This macro returns a sufficient buffer size for a ciphertext produced using
Gilles Peskinedcd14942018-07-12 00:30:52 +0200652 * a key of the specified type and size, with the specified algorithm.
653 * Note that the actual size of the ciphertext may be smaller, depending
654 * on the algorithm.
655 *
656 * \warning This function may call its arguments multiple times or
657 * zero times, so you should not pass arguments that contain
658 * side effects.
659 *
660 * \param key_type An asymmetric key type (this may indifferently be a
661 * key pair type or a public key type).
662 * \param key_bits The size of the key in bits.
Gilles Peskine9ff8d1f2020-05-05 16:00:17 +0200663 * \param alg The asymmetric encryption algorithm.
Gilles Peskinedcd14942018-07-12 00:30:52 +0200664 *
665 * \return If the parameters are valid and supported, return
666 * a buffer size in bytes that guarantees that
667 * psa_asymmetric_encrypt() will not fail with
668 * #PSA_ERROR_BUFFER_TOO_SMALL.
gabor-mezei-armc6f24802021-02-15 15:56:29 +0100669 * If the parameters are a valid combination that is not supported,
670 * return either a sensible size or 0.
Gilles Peskinedcd14942018-07-12 00:30:52 +0200671 * If the parameters are not valid, the
672 * return value is unspecified.
673 */
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200674#define PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE(key_type, key_bits, alg) \
675 (PSA_KEY_TYPE_IS_RSA(key_type) ? \
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 ((void) alg, PSA_BITS_TO_BYTES(key_bits)) : \
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200677 0)
Gilles Peskinedcd14942018-07-12 00:30:52 +0200678
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200679/** A sufficient output buffer size for psa_asymmetric_encrypt(), for any
680 * supported asymmetric encryption.
681 *
682 * See also #PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE(\p key_type, \p key_bits, \p alg).
683 */
gabor-mezei-armc6f24802021-02-15 15:56:29 +0100684/* This macro assumes that RSA is the only supported asymmetric encryption. */
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200685#define PSA_ASYMMETRIC_ENCRYPT_OUTPUT_MAX_SIZE \
gabor-mezei-arme86bdca2021-01-07 14:26:12 +0100686 (PSA_BITS_TO_BYTES(PSA_VENDOR_RSA_MAX_KEY_BITS))
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200687
Gilles Peskine56e2dc82019-05-21 15:59:56 +0200688/** Sufficient output buffer size for psa_asymmetric_decrypt().
Gilles Peskinedcd14942018-07-12 00:30:52 +0200689 *
Gilles Peskine76689602020-05-05 16:01:22 +0200690 * This macro returns a sufficient buffer size for a plaintext produced using
Gilles Peskinedcd14942018-07-12 00:30:52 +0200691 * a key of the specified type and size, with the specified algorithm.
Gilles Peskine76689602020-05-05 16:01:22 +0200692 * Note that the actual size of the plaintext may be smaller, depending
Gilles Peskinedcd14942018-07-12 00:30:52 +0200693 * on the algorithm.
694 *
695 * \warning This function may call its arguments multiple times or
696 * zero times, so you should not pass arguments that contain
697 * side effects.
698 *
699 * \param key_type An asymmetric key type (this may indifferently be a
700 * key pair type or a public key type).
701 * \param key_bits The size of the key in bits.
Gilles Peskine9ff8d1f2020-05-05 16:00:17 +0200702 * \param alg The asymmetric encryption algorithm.
Gilles Peskinedcd14942018-07-12 00:30:52 +0200703 *
704 * \return If the parameters are valid and supported, return
705 * a buffer size in bytes that guarantees that
706 * psa_asymmetric_decrypt() will not fail with
707 * #PSA_ERROR_BUFFER_TOO_SMALL.
gabor-mezei-armc6f24802021-02-15 15:56:29 +0100708 * If the parameters are a valid combination that is not supported,
709 * return either a sensible size or 0.
Gilles Peskinedcd14942018-07-12 00:30:52 +0200710 * If the parameters are not valid, the
711 * return value is unspecified.
712 */
Gilles Peskine49cee6c2018-06-27 21:03:58 +0200713#define PSA_ASYMMETRIC_DECRYPT_OUTPUT_SIZE(key_type, key_bits, alg) \
714 (PSA_KEY_TYPE_IS_RSA(key_type) ? \
715 PSA_BITS_TO_BYTES(key_bits) - PSA_RSA_MINIMUM_PADDING_SIZE(alg) : \
716 0)
717
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200718/** A sufficient output buffer size for psa_asymmetric_decrypt(), for any
719 * supported asymmetric decryption.
720 *
gabor-mezei-arme86bdca2021-01-07 14:26:12 +0100721 * This macro assumes that RSA is the only supported asymmetric encryption.
722 *
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200723 * See also #PSA_ASYMMETRIC_DECRYPT_OUTPUT_SIZE(\p key_type, \p key_bits, \p alg).
724 */
725#define PSA_ASYMMETRIC_DECRYPT_OUTPUT_MAX_SIZE \
gabor-mezei-arme86bdca2021-01-07 14:26:12 +0100726 (PSA_BITS_TO_BYTES(PSA_VENDOR_RSA_MAX_KEY_BITS))
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200727
Gilles Peskine1be949b2018-08-10 19:06:59 +0200728/* Maximum size of the ASN.1 encoding of an INTEGER with the specified
729 * number of bits.
730 *
731 * This definition assumes that bits <= 2^19 - 9 so that the length field
732 * is at most 3 bytes. The length of the encoding is the length of the
733 * bit string padded to a whole number of bytes plus:
734 * - 1 type byte;
735 * - 1 to 3 length bytes;
736 * - 0 to 1 bytes of leading 0 due to the sign bit.
737 */
738#define PSA_KEY_EXPORT_ASN1_INTEGER_MAX_SIZE(bits) \
739 ((bits) / 8 + 5)
740
741/* Maximum size of the export encoding of an RSA public key.
742 * Assumes that the public exponent is less than 2^32.
743 *
Gilles Peskine1be949b2018-08-10 19:06:59 +0200744 * RSAPublicKey ::= SEQUENCE {
745 * modulus INTEGER, -- n
746 * publicExponent INTEGER } -- e
747 *
Jaeden Amero25384a22019-01-10 10:23:21 +0000748 * - 4 bytes of SEQUENCE overhead;
Gilles Peskine1be949b2018-08-10 19:06:59 +0200749 * - n : INTEGER;
750 * - 7 bytes for the public exponent.
751 */
752#define PSA_KEY_EXPORT_RSA_PUBLIC_KEY_MAX_SIZE(key_bits) \
Jaeden Amero25384a22019-01-10 10:23:21 +0000753 (PSA_KEY_EXPORT_ASN1_INTEGER_MAX_SIZE(key_bits) + 11)
Gilles Peskine1be949b2018-08-10 19:06:59 +0200754
755/* Maximum size of the export encoding of an RSA key pair.
Tom Cosgrove1797b052022-12-04 17:19:59 +0000756 * Assumes that the public exponent is less than 2^32 and that the size
Gilles Peskine1be949b2018-08-10 19:06:59 +0200757 * difference between the two primes is at most 1 bit.
758 *
759 * RSAPrivateKey ::= SEQUENCE {
760 * version Version, -- 0
761 * modulus INTEGER, -- N-bit
762 * publicExponent INTEGER, -- 32-bit
763 * privateExponent INTEGER, -- N-bit
764 * prime1 INTEGER, -- N/2-bit
765 * prime2 INTEGER, -- N/2-bit
766 * exponent1 INTEGER, -- N/2-bit
767 * exponent2 INTEGER, -- N/2-bit
768 * coefficient INTEGER, -- N/2-bit
769 * }
770 *
771 * - 4 bytes of SEQUENCE overhead;
772 * - 3 bytes of version;
773 * - 7 half-size INTEGERs plus 2 full-size INTEGERs,
774 * overapproximated as 9 half-size INTEGERS;
775 * - 7 bytes for the public exponent.
776 */
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200777#define PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE(key_bits) \
Gilles Peskine1be949b2018-08-10 19:06:59 +0200778 (9 * PSA_KEY_EXPORT_ASN1_INTEGER_MAX_SIZE((key_bits) / 2 + 1) + 14)
779
780/* Maximum size of the export encoding of a DSA public key.
781 *
782 * SubjectPublicKeyInfo ::= SEQUENCE {
783 * algorithm AlgorithmIdentifier,
784 * subjectPublicKey BIT STRING } -- contains DSAPublicKey
785 * AlgorithmIdentifier ::= SEQUENCE {
786 * algorithm OBJECT IDENTIFIER,
bootstrap-prime6dbbf442022-05-17 19:30:44 -0400787 * parameters Dss-Params } -- SEQUENCE of 3 INTEGERs
Gilles Peskine1be949b2018-08-10 19:06:59 +0200788 * DSAPublicKey ::= INTEGER -- public key, Y
789 *
790 * - 3 * 4 bytes of SEQUENCE overhead;
791 * - 1 + 1 + 7 bytes of algorithm (DSA OID);
792 * - 4 bytes of BIT STRING overhead;
793 * - 3 full-size INTEGERs (p, g, y);
794 * - 1 + 1 + 32 bytes for 1 sub-size INTEGER (q <= 256 bits).
795 */
796#define PSA_KEY_EXPORT_DSA_PUBLIC_KEY_MAX_SIZE(key_bits) \
797 (PSA_KEY_EXPORT_ASN1_INTEGER_MAX_SIZE(key_bits) * 3 + 59)
798
799/* Maximum size of the export encoding of a DSA key pair.
800 *
801 * DSAPrivateKey ::= SEQUENCE {
802 * version Version, -- 0
803 * prime INTEGER, -- p
804 * subprime INTEGER, -- q
805 * generator INTEGER, -- g
806 * public INTEGER, -- y
807 * private INTEGER, -- x
808 * }
809 *
810 * - 4 bytes of SEQUENCE overhead;
811 * - 3 bytes of version;
812 * - 3 full-size INTEGERs (p, g, y);
813 * - 2 * (1 + 1 + 32) bytes for 2 sub-size INTEGERs (q, x <= 256 bits).
814 */
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200815#define PSA_KEY_EXPORT_DSA_KEY_PAIR_MAX_SIZE(key_bits) \
Gilles Peskine1be949b2018-08-10 19:06:59 +0200816 (PSA_KEY_EXPORT_ASN1_INTEGER_MAX_SIZE(key_bits) * 3 + 75)
817
818/* Maximum size of the export encoding of an ECC public key.
819 *
Jaeden Ameroccdce902019-01-10 11:42:27 +0000820 * The representation of an ECC public key is:
821 * - The byte 0x04;
822 * - `x_P` as a `ceiling(m/8)`-byte string, big-endian;
823 * - `y_P` as a `ceiling(m/8)`-byte string, big-endian;
824 * - where m is the bit size associated with the curve.
Gilles Peskine1be949b2018-08-10 19:06:59 +0200825 *
Jaeden Ameroccdce902019-01-10 11:42:27 +0000826 * - 1 byte + 2 * point size.
Gilles Peskine1be949b2018-08-10 19:06:59 +0200827 */
828#define PSA_KEY_EXPORT_ECC_PUBLIC_KEY_MAX_SIZE(key_bits) \
Jaeden Ameroccdce902019-01-10 11:42:27 +0000829 (2 * PSA_BITS_TO_BYTES(key_bits) + 1)
Gilles Peskine1be949b2018-08-10 19:06:59 +0200830
831/* Maximum size of the export encoding of an ECC key pair.
832 *
Gilles Peskine5eb15212018-10-31 13:24:35 +0100833 * An ECC key pair is represented by the secret value.
Gilles Peskine1be949b2018-08-10 19:06:59 +0200834 */
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200835#define PSA_KEY_EXPORT_ECC_KEY_PAIR_MAX_SIZE(key_bits) \
Gilles Peskine5eb15212018-10-31 13:24:35 +0100836 (PSA_BITS_TO_BYTES(key_bits))
Gilles Peskine1be949b2018-08-10 19:06:59 +0200837
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200838/* Maximum size of the export encoding of an DH key pair.
Przemek Stekieled23b612022-12-01 15:00:41 +0100839 *
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200840 * An DH key pair is represented by the secret value.
Przemek Stekieled23b612022-12-01 15:00:41 +0100841 */
842#define PSA_KEY_EXPORT_FFDH_KEY_PAIR_MAX_SIZE(key_bits) \
843 (PSA_BITS_TO_BYTES(key_bits))
844
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200845/* Maximum size of the export encoding of an DH public key.
Przemek Stekieled23b612022-12-01 15:00:41 +0100846 */
847#define PSA_KEY_EXPORT_FFDH_PUBLIC_KEY_MAX_SIZE(key_bits) \
848 (PSA_BITS_TO_BYTES(key_bits))
849
gabor-mezei-armbdae9182021-01-28 14:33:10 +0100850/** Sufficient output buffer size for psa_export_key() or
851 * psa_export_public_key().
Gilles Peskine1be949b2018-08-10 19:06:59 +0200852 *
853 * This macro returns a compile-time constant if its arguments are
854 * compile-time constants.
855 *
gabor-mezei-armcbcec212020-12-18 14:23:51 +0100856 * \warning This macro may evaluate its arguments multiple times or
Gilles Peskine1be949b2018-08-10 19:06:59 +0200857 * zero times, so you should not pass arguments that contain
858 * side effects.
859 *
860 * The following code illustrates how to allocate enough memory to export
861 * a key by querying the key type and size at runtime.
862 * \code{c}
Gilles Peskined7d43b92019-05-21 15:56:03 +0200863 * psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine1be949b2018-08-10 19:06:59 +0200864 * psa_status_t status;
Gilles Peskined7d43b92019-05-21 15:56:03 +0200865 * status = psa_get_key_attributes(key, &attributes);
Gilles Peskine1be949b2018-08-10 19:06:59 +0200866 * if (status != PSA_SUCCESS) handle_error(...);
Gilles Peskined7d43b92019-05-21 15:56:03 +0200867 * psa_key_type_t key_type = psa_get_key_type(&attributes);
868 * size_t key_bits = psa_get_key_bits(&attributes);
gabor-mezei-armcbcec212020-12-18 14:23:51 +0100869 * size_t buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(key_type, key_bits);
Gilles Peskined7d43b92019-05-21 15:56:03 +0200870 * psa_reset_key_attributes(&attributes);
Gilles Peskinef82088a2019-07-15 11:07:38 +0200871 * uint8_t *buffer = malloc(buffer_size);
Gilles Peskined7d43b92019-05-21 15:56:03 +0200872 * if (buffer == NULL) handle_error(...);
Gilles Peskine1be949b2018-08-10 19:06:59 +0200873 * size_t buffer_length;
874 * status = psa_export_key(key, buffer, buffer_size, &buffer_length);
875 * if (status != PSA_SUCCESS) handle_error(...);
876 * \endcode
877 *
Gilles Peskine1be949b2018-08-10 19:06:59 +0200878 * \param key_type A supported key type.
879 * \param key_bits The size of the key in bits.
Gilles Peskine1be949b2018-08-10 19:06:59 +0200880 *
881 * \return If the parameters are valid and supported, return
882 * a buffer size in bytes that guarantees that
gabor-mezei-armbdae9182021-01-28 14:33:10 +0100883 * psa_export_key() or psa_export_public_key() will not fail with
Gilles Peskine1be949b2018-08-10 19:06:59 +0200884 * #PSA_ERROR_BUFFER_TOO_SMALL.
gabor-mezei-armc6f24802021-02-15 15:56:29 +0100885 * If the parameters are a valid combination that is not supported,
886 * return either a sensible size or 0.
887 * If the parameters are not valid, the return value is unspecified.
Gilles Peskine1be949b2018-08-10 19:06:59 +0200888 */
gabor-mezei-armcbcec212020-12-18 14:23:51 +0100889#define PSA_EXPORT_KEY_OUTPUT_SIZE(key_type, key_bits) \
890 (PSA_KEY_TYPE_IS_UNSTRUCTURED(key_type) ? PSA_BITS_TO_BYTES(key_bits) : \
Przemek Stekieled23b612022-12-01 15:00:41 +0100891 PSA_KEY_TYPE_IS_DH(key_type) ? PSA_BITS_TO_BYTES(key_bits) : \
gabor-mezei-armcbcec212020-12-18 14:23:51 +0100892 (key_type) == PSA_KEY_TYPE_RSA_KEY_PAIR ? PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE(key_bits) : \
Gilles Peskine1be949b2018-08-10 19:06:59 +0200893 (key_type) == PSA_KEY_TYPE_RSA_PUBLIC_KEY ? PSA_KEY_EXPORT_RSA_PUBLIC_KEY_MAX_SIZE(key_bits) : \
gabor-mezei-armcbcec212020-12-18 14:23:51 +0100894 (key_type) == PSA_KEY_TYPE_DSA_KEY_PAIR ? PSA_KEY_EXPORT_DSA_KEY_PAIR_MAX_SIZE(key_bits) : \
Gilles Peskine1be949b2018-08-10 19:06:59 +0200895 (key_type) == PSA_KEY_TYPE_DSA_PUBLIC_KEY ? PSA_KEY_EXPORT_DSA_PUBLIC_KEY_MAX_SIZE(key_bits) : \
gabor-mezei-armcbcec212020-12-18 14:23:51 +0100896 PSA_KEY_TYPE_IS_ECC_KEY_PAIR(key_type) ? PSA_KEY_EXPORT_ECC_KEY_PAIR_MAX_SIZE(key_bits) : \
897 PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY(key_type) ? PSA_KEY_EXPORT_ECC_PUBLIC_KEY_MAX_SIZE(key_bits) : \
Gilles Peskine1be949b2018-08-10 19:06:59 +0200898 0)
899
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200900/** Sufficient output buffer size for psa_export_public_key().
901 *
902 * This macro returns a compile-time constant if its arguments are
903 * compile-time constants.
904 *
gabor-mezei-arme86bdca2021-01-07 14:26:12 +0100905 * \warning This macro may evaluate its arguments multiple times or
906 * zero times, so you should not pass arguments that contain
907 * side effects.
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200908 *
909 * The following code illustrates how to allocate enough memory to export
910 * a public key by querying the key type and size at runtime.
911 * \code{c}
912 * psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
913 * psa_status_t status;
914 * status = psa_get_key_attributes(key, &attributes);
gabor-mezei-arme86bdca2021-01-07 14:26:12 +0100915 * if (status != PSA_SUCCESS) handle_error(...);
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200916 * psa_key_type_t key_type = psa_get_key_type(&attributes);
917 * size_t key_bits = psa_get_key_bits(&attributes);
918 * size_t buffer_size = PSA_EXPORT_PUBLIC_KEY_OUTPUT_SIZE(key_type, key_bits);
919 * psa_reset_key_attributes(&attributes);
920 * uint8_t *buffer = malloc(buffer_size);
gabor-mezei-arme86bdca2021-01-07 14:26:12 +0100921 * if (buffer == NULL) handle_error(...);
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200922 * size_t buffer_length;
923 * status = psa_export_public_key(key, buffer, buffer_size, &buffer_length);
gabor-mezei-arme86bdca2021-01-07 14:26:12 +0100924 * if (status != PSA_SUCCESS) handle_error(...);
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200925 * \endcode
926 *
927 * \param key_type A public key or key pair key type.
928 * \param key_bits The size of the key in bits.
929 *
930 * \return If the parameters are valid and supported, return
931 * a buffer size in bytes that guarantees that
932 * psa_export_public_key() will not fail with
gabor-mezei-armc6f24802021-02-15 15:56:29 +0100933 * #PSA_ERROR_BUFFER_TOO_SMALL.
934 * If the parameters are a valid combination that is not
935 * supported, return either a sensible size or 0.
936 * If the parameters are not valid,
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200937 * the return value is unspecified.
938 *
939 * If the parameters are valid and supported,
gabor-mezei-armc6f24802021-02-15 15:56:29 +0100940 * return the same result as
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200941 * #PSA_EXPORT_KEY_OUTPUT_SIZE(
942 * \p #PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(\p key_type),
943 * \p key_bits).
944 */
gabor-mezei-arme86bdca2021-01-07 14:26:12 +0100945#define PSA_EXPORT_PUBLIC_KEY_OUTPUT_SIZE(key_type, key_bits) \
946 (PSA_KEY_TYPE_IS_RSA(key_type) ? PSA_KEY_EXPORT_RSA_PUBLIC_KEY_MAX_SIZE(key_bits) : \
947 PSA_KEY_TYPE_IS_ECC(key_type) ? PSA_KEY_EXPORT_ECC_PUBLIC_KEY_MAX_SIZE(key_bits) : \
Przemek Stekieled23b612022-12-01 15:00:41 +0100948 PSA_KEY_TYPE_IS_DH(key_type) ? PSA_BITS_TO_BYTES(key_bits) : \
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200949 0)
950
951/** Sufficient buffer size for exporting any asymmetric key pair.
952 *
gabor-mezei-armc6f24802021-02-15 15:56:29 +0100953 * This macro expands to a compile-time constant integer. This value is
954 * a sufficient buffer size when calling psa_export_key() to export any
955 * asymmetric key pair, regardless of the exact key type and key size.
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200956 *
957 * See also #PSA_EXPORT_KEY_OUTPUT_SIZE(\p key_type, \p key_bits).
958 */
Valerio Settic012a2d2023-07-28 09:34:44 +0200959#define PSA_EXPORT_KEY_PAIR_MAX_SIZE 1
Valerio Settia83d9bf2023-07-27 18:15:20 +0200960
961#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC) && \
962 (PSA_KEY_EXPORT_ECC_KEY_PAIR_MAX_SIZE(PSA_VENDOR_ECC_MAX_CURVE_BITS) > \
963 PSA_EXPORT_KEY_PAIR_MAX_SIZE)
964#undef PSA_EXPORT_KEY_PAIR_MAX_SIZE
965#define PSA_EXPORT_KEY_PAIR_MAX_SIZE \
966 PSA_KEY_EXPORT_ECC_KEY_PAIR_MAX_SIZE(PSA_VENDOR_ECC_MAX_CURVE_BITS)
967#endif
968#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) && \
969 (PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE(PSA_VENDOR_RSA_MAX_KEY_BITS) > \
970 PSA_EXPORT_KEY_PAIR_MAX_SIZE)
971#undef PSA_EXPORT_KEY_PAIR_MAX_SIZE
972#define PSA_EXPORT_KEY_PAIR_MAX_SIZE \
973 PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE(PSA_VENDOR_RSA_MAX_KEY_BITS)
974#endif
975#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_BASIC) && \
976 (PSA_KEY_EXPORT_FFDH_KEY_PAIR_MAX_SIZE(PSA_VENDOR_FFDH_MAX_KEY_BITS) > \
977 PSA_EXPORT_KEY_PAIR_MAX_SIZE)
978#undef PSA_EXPORT_KEY_PAIR_MAX_SIZE
979#define PSA_EXPORT_KEY_PAIR_MAX_SIZE \
Valerio Setti644e01d2023-07-28 09:31:51 +0200980 PSA_KEY_EXPORT_FFDH_KEY_PAIR_MAX_SIZE(PSA_VENDOR_FFDH_MAX_KEY_BITS)
Valerio Settia83d9bf2023-07-27 18:15:20 +0200981#endif
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200982
983/** Sufficient buffer size for exporting any asymmetric public key.
984 *
gabor-mezei-armc6f24802021-02-15 15:56:29 +0100985 * This macro expands to a compile-time constant integer. This value is
986 * a sufficient buffer size when calling psa_export_key() or
987 * psa_export_public_key() to export any asymmetric public key,
988 * regardless of the exact key type and key size.
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +0200989 *
990 * See also #PSA_EXPORT_PUBLIC_KEY_OUTPUT_SIZE(\p key_type, \p key_bits).
991 */
Valerio Settic012a2d2023-07-28 09:34:44 +0200992#define PSA_EXPORT_PUBLIC_KEY_MAX_SIZE 1
Przemek Stekiel654bef02022-12-15 13:28:02 +0100993
Valerio Settia83d9bf2023-07-27 18:15:20 +0200994#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY) && \
995 (PSA_KEY_EXPORT_ECC_PUBLIC_KEY_MAX_SIZE(PSA_VENDOR_ECC_MAX_CURVE_BITS) > \
996 PSA_EXPORT_PUBLIC_KEY_MAX_SIZE)
997#undef PSA_EXPORT_PUBLIC_KEY_MAX_SIZE
998#define PSA_EXPORT_PUBLIC_KEY_MAX_SIZE \
999 PSA_KEY_EXPORT_ECC_PUBLIC_KEY_MAX_SIZE(PSA_VENDOR_ECC_MAX_CURVE_BITS)
1000#endif
1001#if defined(PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY) && \
1002 (PSA_KEY_EXPORT_RSA_PUBLIC_KEY_MAX_SIZE(PSA_VENDOR_RSA_MAX_KEY_BITS) > \
1003 PSA_EXPORT_PUBLIC_KEY_MAX_SIZE)
1004#undef PSA_EXPORT_PUBLIC_KEY_MAX_SIZE
1005#define PSA_EXPORT_PUBLIC_KEY_MAX_SIZE \
1006 PSA_KEY_EXPORT_RSA_PUBLIC_KEY_MAX_SIZE(PSA_VENDOR_RSA_MAX_KEY_BITS)
1007#endif
1008#if defined(PSA_WANT_KEY_TYPE_DH_PUBLIC_KEY) && \
1009 (PSA_KEY_EXPORT_FFDH_PUBLIC_KEY_MAX_SIZE(PSA_VENDOR_FFDH_MAX_KEY_BITS) > \
1010 PSA_EXPORT_PUBLIC_KEY_MAX_SIZE)
1011#undef PSA_EXPORT_PUBLIC_KEY_MAX_SIZE
1012#define PSA_EXPORT_PUBLIC_KEY_MAX_SIZE \
1013 PSA_KEY_EXPORT_FFDH_PUBLIC_KEY_MAX_SIZE(PSA_VENDOR_FFDH_MAX_KEY_BITS)
1014#endif
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001015
1016/** Sufficient output buffer size for psa_raw_key_agreement().
1017 *
1018 * This macro returns a compile-time constant if its arguments are
1019 * compile-time constants.
1020 *
gabor-mezei-arme86bdca2021-01-07 14:26:12 +01001021 * \warning This macro may evaluate its arguments multiple times or
1022 * zero times, so you should not pass arguments that contain
1023 * side effects.
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001024 *
1025 * See also #PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE.
1026 *
1027 * \param key_type A supported key type.
1028 * \param key_bits The size of the key in bits.
1029 *
1030 * \return If the parameters are valid and supported, return
1031 * a buffer size in bytes that guarantees that
1032 * psa_raw_key_agreement() will not fail with
gabor-mezei-armc6f24802021-02-15 15:56:29 +01001033 * #PSA_ERROR_BUFFER_TOO_SMALL.
1034 * If the parameters are a valid combination that
1035 * is not supported, return either a sensible size or 0.
1036 * If the parameters are not valid,
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001037 * the return value is unspecified.
1038 */
1039#define PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(key_type, key_bits) \
Przemek Stekiel654bef02022-12-15 13:28:02 +01001040 ((PSA_KEY_TYPE_IS_ECC_KEY_PAIR(key_type) || \
1041 PSA_KEY_TYPE_IS_DH_KEY_PAIR(key_type)) ? PSA_BITS_TO_BYTES(key_bits) : 0)
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001042
1043/** Maximum size of the output from psa_raw_key_agreement().
1044 *
gabor-mezei-armc6f24802021-02-15 15:56:29 +01001045 * This macro expands to a compile-time constant integer. This value is the
1046 * maximum size of the output any raw key agreement algorithm, in bytes.
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001047 *
1048 * See also #PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(\p key_type, \p key_bits).
1049 */
Valerio Settic012a2d2023-07-28 09:34:44 +02001050#define PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE 1
Valerio Settia83d9bf2023-07-27 18:15:20 +02001051
1052#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC) && \
1053 (PSA_BITS_TO_BYTES(PSA_VENDOR_ECC_MAX_CURVE_BITS) > PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE)
1054#undef PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE
1055#define PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE PSA_BITS_TO_BYTES(PSA_VENDOR_ECC_MAX_CURVE_BITS)
1056#endif
1057#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_BASIC) && \
1058 (PSA_BITS_TO_BYTES(PSA_VENDOR_FFDH_MAX_KEY_BITS) > PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE)
1059#undef PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE
1060#define PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE PSA_BITS_TO_BYTES(PSA_VENDOR_FFDH_MAX_KEY_BITS)
1061#endif
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001062
Bence Szépkúti423d3e72020-10-29 11:07:39 +01001063/** The default IV size for a cipher algorithm, in bytes.
1064 *
1065 * The IV that is generated as part of a call to #psa_cipher_encrypt() is always
1066 * the default IV length for the algorithm.
1067 *
1068 * This macro can be used to allocate a buffer of sufficient size to
1069 * store the IV output from #psa_cipher_generate_iv() when using
1070 * a multi-part cipher operation.
1071 *
1072 * See also #PSA_CIPHER_IV_MAX_SIZE.
1073 *
1074 * \warning This macro may evaluate its arguments multiple times or
1075 * zero times, so you should not pass arguments that contain
1076 * side effects.
1077 *
1078 * \param key_type A symmetric key type that is compatible with algorithm \p alg.
1079 *
1080 * \param alg A cipher algorithm (\c PSA_ALG_XXX value such that #PSA_ALG_IS_CIPHER(\p alg) is true).
1081 *
1082 * \return The default IV size for the specified key type and algorithm.
1083 * If the algorithm does not use an IV, return 0.
1084 * If the key type or cipher algorithm is not recognized,
1085 * or the parameters are incompatible, return 0.
Bence Szépkúti423d3e72020-10-29 11:07:39 +01001086 */
1087#define PSA_CIPHER_IV_LENGTH(key_type, alg) \
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001088 (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1 && \
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 ((alg) == PSA_ALG_CTR || \
1090 (alg) == PSA_ALG_CFB || \
1091 (alg) == PSA_ALG_OFB || \
1092 (alg) == PSA_ALG_XTS || \
1093 (alg) == PSA_ALG_CBC_NO_PADDING || \
1094 (alg) == PSA_ALG_CBC_PKCS7) ? PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) : \
Bence Szépkúti423d3e72020-10-29 11:07:39 +01001095 (key_type) == PSA_KEY_TYPE_CHACHA20 && \
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 (alg) == PSA_ALG_STREAM_CIPHER ? 12 : \
1097 (alg) == PSA_ALG_CCM_STAR_NO_TAG ? 13 : \
1098 0)
Bence Szépkúti423d3e72020-10-29 11:07:39 +01001099
1100/** The maximum IV size for all supported cipher algorithms, in bytes.
1101 *
1102 * See also #PSA_CIPHER_IV_LENGTH().
1103 */
1104#define PSA_CIPHER_IV_MAX_SIZE 16
1105
gabor-mezei-arm8809fb62020-06-02 14:27:06 +02001106/** The maximum size of the output of psa_cipher_encrypt(), in bytes.
1107 *
1108 * If the size of the output buffer is at least this large, it is guaranteed
1109 * that psa_cipher_encrypt() will not fail due to an insufficient buffer size.
1110 * Depending on the algorithm, the actual size of the output might be smaller.
1111 *
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001112 * See also #PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE(\p input_length).
1113 *
gabor-mezei-arme86bdca2021-01-07 14:26:12 +01001114 * \warning This macro may evaluate its arguments multiple times or
1115 * zero times, so you should not pass arguments that contain
1116 * side effects.
gabor-mezei-arm8809fb62020-06-02 14:27:06 +02001117 *
1118 * \param key_type A symmetric key type that is compatible with algorithm
1119 * alg.
1120 * \param alg A cipher algorithm (\c PSA_ALG_XXX value such that
1121 * #PSA_ALG_IS_CIPHER(\p alg) is true).
1122 * \param input_length Size of the input in bytes.
1123 *
1124 * \return A sufficient output size for the specified key type and
1125 * algorithm. If the key type or cipher algorithm is not
1126 * recognized, or the parameters are incompatible,
gabor-mezei-arme86bdca2021-01-07 14:26:12 +01001127 * return 0.
gabor-mezei-arm8809fb62020-06-02 14:27:06 +02001128 */
gabor-mezei-arme86bdca2021-01-07 14:26:12 +01001129#define PSA_CIPHER_ENCRYPT_OUTPUT_SIZE(key_type, alg, input_length) \
1130 (alg == PSA_ALG_CBC_PKCS7 ? \
Paul Elliottc22950c2021-07-08 16:50:01 +01001131 (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) != 0 ? \
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 PSA_ROUND_UP_TO_MULTIPLE(PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type), \
1133 (input_length) + 1) + \
1134 PSA_CIPHER_IV_LENGTH((key_type), (alg)) : 0) : \
gabor-mezei-arme86bdca2021-01-07 14:26:12 +01001135 (PSA_ALG_IS_CIPHER(alg) ? \
1136 (input_length) + PSA_CIPHER_IV_LENGTH((key_type), (alg)) : \
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 0))
gabor-mezei-arm8809fb62020-06-02 14:27:06 +02001138
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001139/** A sufficient output buffer size for psa_cipher_encrypt(), for any of the
1140 * supported key types and cipher algorithms.
1141 *
1142 * If the size of the output buffer is at least this large, it is guaranteed
1143 * that psa_cipher_encrypt() will not fail due to an insufficient buffer size.
1144 *
1145 * See also #PSA_CIPHER_ENCRYPT_OUTPUT_SIZE(\p key_type, \p alg, \p input_length).
1146 *
1147 * \param input_length Size of the input in bytes.
1148 *
1149 */
1150#define PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE(input_length) \
1151 (PSA_ROUND_UP_TO_MULTIPLE(PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE, \
gabor-mezei-arm56991012021-03-10 16:43:14 +01001152 (input_length) + 1) + \
1153 PSA_CIPHER_IV_MAX_SIZE)
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001154
gabor-mezei-arm8809fb62020-06-02 14:27:06 +02001155/** The maximum size of the output of psa_cipher_decrypt(), in bytes.
1156 *
1157 * If the size of the output buffer is at least this large, it is guaranteed
1158 * that psa_cipher_decrypt() will not fail due to an insufficient buffer size.
1159 * Depending on the algorithm, the actual size of the output might be smaller.
1160 *
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001161 * See also #PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE(\p input_length).
gabor-mezei-arm8809fb62020-06-02 14:27:06 +02001162 *
1163 * \param key_type A symmetric key type that is compatible with algorithm
1164 * alg.
1165 * \param alg A cipher algorithm (\c PSA_ALG_XXX value such that
1166 * #PSA_ALG_IS_CIPHER(\p alg) is true).
1167 * \param input_length Size of the input in bytes.
1168 *
1169 * \return A sufficient output size for the specified key type and
1170 * algorithm. If the key type or cipher algorithm is not
1171 * recognized, or the parameters are incompatible,
gabor-mezei-armc6f24802021-02-15 15:56:29 +01001172 * return 0.
gabor-mezei-arm8809fb62020-06-02 14:27:06 +02001173 */
gabor-mezei-armee6bb562020-06-17 10:11:11 +02001174#define PSA_CIPHER_DECRYPT_OUTPUT_SIZE(key_type, alg, input_length) \
1175 (PSA_ALG_IS_CIPHER(alg) && \
1176 ((key_type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_SYMMETRIC ? \
1177 (input_length) : \
gabor-mezei-arm8809fb62020-06-02 14:27:06 +02001178 0)
1179
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001180/** A sufficient output buffer size for psa_cipher_decrypt(), for any of the
1181 * supported key types and cipher algorithms.
1182 *
1183 * If the size of the output buffer is at least this large, it is guaranteed
1184 * that psa_cipher_decrypt() will not fail due to an insufficient buffer size.
1185 *
1186 * See also #PSA_CIPHER_DECRYPT_OUTPUT_SIZE(\p key_type, \p alg, \p input_length).
1187 *
1188 * \param input_length Size of the input in bytes.
1189 */
1190#define PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE(input_length) \
1191 (input_length)
1192
1193/** A sufficient output buffer size for psa_cipher_update().
1194 *
1195 * If the size of the output buffer is at least this large, it is guaranteed
1196 * that psa_cipher_update() will not fail due to an insufficient buffer size.
1197 * The actual size of the output might be smaller in any given call.
1198 *
1199 * See also #PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE(\p input_length).
1200 *
1201 * \param key_type A symmetric key type that is compatible with algorithm
1202 * alg.
1203 * \param alg A cipher algorithm (PSA_ALG_XXX value such that
1204 * #PSA_ALG_IS_CIPHER(\p alg) is true).
1205 * \param input_length Size of the input in bytes.
1206 *
1207 * \return A sufficient output size for the specified key type and
1208 * algorithm. If the key type or cipher algorithm is not
1209 * recognized, or the parameters are incompatible, return 0.
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001210 */
gabor-mezei-arme86bdca2021-01-07 14:26:12 +01001211#define PSA_CIPHER_UPDATE_OUTPUT_SIZE(key_type, alg, input_length) \
1212 (PSA_ALG_IS_CIPHER(alg) ? \
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) != 0 ? \
1214 (((alg) == PSA_ALG_CBC_PKCS7 || \
1215 (alg) == PSA_ALG_CBC_NO_PADDING || \
1216 (alg) == PSA_ALG_ECB_NO_PADDING) ? \
1217 PSA_ROUND_UP_TO_MULTIPLE(PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type), \
gabor-mezei-arme86bdca2021-01-07 14:26:12 +01001218 input_length) : \
Gilles Peskine449bd832023-01-11 14:50:10 +01001219 (input_length)) : 0) : \
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001220 0)
1221
1222/** A sufficient output buffer size for psa_cipher_update(), for any of the
1223 * supported key types and cipher algorithms.
1224 *
1225 * If the size of the output buffer is at least this large, it is guaranteed
1226 * that psa_cipher_update() will not fail due to an insufficient buffer size.
1227 *
1228 * See also #PSA_CIPHER_UPDATE_OUTPUT_SIZE(\p key_type, \p alg, \p input_length).
1229 *
1230 * \param input_length Size of the input in bytes.
1231 */
1232#define PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE(input_length) \
gabor-mezei-arm286a36e2021-03-05 15:54:21 +01001233 (PSA_ROUND_UP_TO_MULTIPLE(PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE, input_length))
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001234
1235/** A sufficient ciphertext buffer size for psa_cipher_finish().
1236 *
1237 * If the size of the ciphertext buffer is at least this large, it is
1238 * guaranteed that psa_cipher_finish() will not fail due to an insufficient
1239 * ciphertext buffer size. The actual size of the output might be smaller in
1240 * any given call.
1241 *
1242 * See also #PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE().
1243 *
1244 * \param key_type A symmetric key type that is compatible with algorithm
1245 * alg.
1246 * \param alg A cipher algorithm (PSA_ALG_XXX value such that
1247 * #PSA_ALG_IS_CIPHER(\p alg) is true).
1248 * \return A sufficient output size for the specified key type and
1249 * algorithm. If the key type or cipher algorithm is not
1250 * recognized, or the parameters are incompatible, return 0.
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001251 */
gabor-mezei-arme86bdca2021-01-07 14:26:12 +01001252#define PSA_CIPHER_FINISH_OUTPUT_SIZE(key_type, alg) \
1253 (PSA_ALG_IS_CIPHER(alg) ? \
1254 (alg == PSA_ALG_CBC_PKCS7 ? \
1255 PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) : \
1256 0) : \
gabor-mezei-armfbd9f1e2020-06-29 10:38:39 +02001257 0)
1258
1259/** A sufficient ciphertext buffer size for psa_cipher_finish(), for any of the
1260 * supported key types and cipher algorithms.
1261 *
1262 * See also #PSA_CIPHER_FINISH_OUTPUT_SIZE(\p key_type, \p alg).
1263 */
1264#define PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE \
1265 (PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE)
1266
Gilles Peskine0cad07c2018-06-27 19:49:02 +02001267#endif /* PSA_CRYPTO_SIZES_H */