blob: 92c5ccf9eab7cc6105d8a2ea1d8f17da3343671f [file] [log] [blame]
Ronald Cron7ceee8d2021-03-17 16:55:43 +01001/*
2 * PSA AEAD entry points
3 */
4/*
5 * Copyright The Mbed TLS Contributors
6 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 */
20
21#include "common.h"
22
23#if defined(MBEDTLS_PSA_CRYPTO_C)
24
25#include "psa_crypto_aead.h"
Ronald Cron46f91782021-03-17 08:16:34 +010026#include "psa_crypto_core.h"
27
Paul Elliottadb8b162021-04-20 16:06:57 +010028#include <string.h>
29#include "mbedtls/platform.h"
30#if !defined(MBEDTLS_PLATFORM_C)
31#define mbedtls_calloc calloc
32#define mbedtls_free free
33#endif
34
Ronald Cron46f91782021-03-17 08:16:34 +010035#include "mbedtls/ccm.h"
36#include "mbedtls/chachapoly.h"
37#include "mbedtls/cipher.h"
38#include "mbedtls/gcm.h"
Paul Elliottadb8b162021-04-20 16:06:57 +010039#include "mbedtls/error.h"
Ronald Cron46f91782021-03-17 08:16:34 +010040
Ronald Cron46f91782021-03-17 08:16:34 +010041static psa_status_t psa_aead_setup(
Paul Elliottcbbde5f2021-05-10 18:19:46 +010042 mbedtls_psa_aead_operation_t *operation,
Ronald Cron46f91782021-03-17 08:16:34 +010043 const psa_key_attributes_t *attributes,
44 const uint8_t *key_buffer,
Paul Elliottcc358592021-05-12 12:22:28 +010045 size_t key_buffer_size,
Ronald Cron46f91782021-03-17 08:16:34 +010046 psa_algorithm_t alg )
47{
48 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
49 size_t key_bits;
Ronald Cronecbc0682021-03-26 13:25:17 +010050 const mbedtls_cipher_info_t *cipher_info;
Ronald Cron46f91782021-03-17 08:16:34 +010051 mbedtls_cipher_id_t cipher_id;
Ronald Cronecbc0682021-03-26 13:25:17 +010052 size_t full_tag_length = 0;
Ronald Cron46f91782021-03-17 08:16:34 +010053
Paul Elliottcc358592021-05-12 12:22:28 +010054 ( void ) key_buffer_size;
55
Ronald Cron46f91782021-03-17 08:16:34 +010056 key_bits = attributes->core.bits;
57
Ronald Cronecbc0682021-03-26 13:25:17 +010058 cipher_info = mbedtls_cipher_info_from_psa( alg,
59 attributes->core.type, key_bits,
60 &cipher_id );
61 if( cipher_info == NULL )
Ronald Cron46f91782021-03-17 08:16:34 +010062 return( PSA_ERROR_NOT_SUPPORTED );
63
64 switch( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 ) )
65 {
66#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
67 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
Paul Elliott07a30c42021-04-20 14:13:23 +010068 operation->alg = PSA_ALG_CCM;
Ronald Cronecbc0682021-03-26 13:25:17 +010069 full_tag_length = 16;
Ronald Cron46f91782021-03-17 08:16:34 +010070 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
71 * The call to mbedtls_ccm_encrypt_and_tag or
72 * mbedtls_ccm_auth_decrypt will validate the tag length. */
73 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( attributes->core.type ) != 16 )
74 return( PSA_ERROR_INVALID_ARGUMENT );
75
76 mbedtls_ccm_init( &operation->ctx.ccm );
77 status = mbedtls_to_psa_error(
78 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
79 key_buffer, (unsigned int) key_bits ) );
80 if( status != PSA_SUCCESS )
81 return( status );
82 break;
83#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
84
85#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
86 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
Paul Elliott07a30c42021-04-20 14:13:23 +010087 operation->alg = PSA_ALG_GCM;
Ronald Cronecbc0682021-03-26 13:25:17 +010088 full_tag_length = 16;
Ronald Cron46f91782021-03-17 08:16:34 +010089 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
90 * The call to mbedtls_gcm_crypt_and_tag or
91 * mbedtls_gcm_auth_decrypt will validate the tag length. */
92 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( attributes->core.type ) != 16 )
93 return( PSA_ERROR_INVALID_ARGUMENT );
94
95 mbedtls_gcm_init( &operation->ctx.gcm );
96 status = mbedtls_to_psa_error(
97 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
98 key_buffer, (unsigned int) key_bits ) );
99 if( status != PSA_SUCCESS )
100 return( status );
101 break;
102#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
103
104#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
105 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
Paul Elliott07a30c42021-04-20 14:13:23 +0100106 operation->alg = PSA_ALG_CHACHA20_POLY1305;
Ronald Cronecbc0682021-03-26 13:25:17 +0100107 full_tag_length = 16;
Ronald Cron46f91782021-03-17 08:16:34 +0100108 /* We only support the default tag length. */
109 if( alg != PSA_ALG_CHACHA20_POLY1305 )
110 return( PSA_ERROR_NOT_SUPPORTED );
111
112 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
113 status = mbedtls_to_psa_error(
114 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
115 key_buffer ) );
116 if( status != PSA_SUCCESS )
117 return( status );
118 break;
119#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
120
121 default:
122 return( PSA_ERROR_NOT_SUPPORTED );
123 }
124
Bence Szépkútiec174e22021-03-19 18:46:15 +0100125 if( PSA_AEAD_TAG_LENGTH( attributes->core.type,
126 key_bits, alg )
127 > full_tag_length )
Ronald Cron46f91782021-03-17 08:16:34 +0100128 return( PSA_ERROR_INVALID_ARGUMENT );
129
Paul Elliottcbbde5f2021-05-10 18:19:46 +0100130 operation->key_type = psa_get_key_type( attributes );
131
132 operation->tag_length = PSA_AEAD_TAG_LENGTH( operation->key_type,
Bence Szépkútiec174e22021-03-19 18:46:15 +0100133 key_bits,
134 alg );
Ronald Cron46f91782021-03-17 08:16:34 +0100135
136 return( PSA_SUCCESS );
137}
138
Paul Elliott96b01732021-07-16 17:00:26 +0100139/* Perform common nonce length checks */
140static psa_status_t mbedtls_aead_check_nonce_length(
141 mbedtls_psa_aead_operation_t *operation,
142 size_t nonce_length )
143{
Paul Elliott66696b52021-08-16 18:42:41 +0100144#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
145 if( operation->alg == PSA_ALG_GCM )
146 {
147 if( nonce_length == 0 )
148 return( PSA_ERROR_NOT_SUPPORTED );
149 }
150#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
151#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
152 if( operation->alg == PSA_ALG_CCM )
153 {
154 if( nonce_length < 7 || nonce_length > 13 )
155 return( PSA_ERROR_NOT_SUPPORTED );
156 }
157 else
158#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
Paul Elliott96b01732021-07-16 17:00:26 +0100159#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
160 if( operation->alg == PSA_ALG_CHACHA20_POLY1305 )
161 {
162 if( nonce_length != 12 )
163 return( PSA_ERROR_NOT_SUPPORTED );
164 }
165#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
166
167 return PSA_SUCCESS;
168}
169
Ronald Cron46f91782021-03-17 08:16:34 +0100170psa_status_t mbedtls_psa_aead_encrypt(
171 const psa_key_attributes_t *attributes,
172 const uint8_t *key_buffer, size_t key_buffer_size,
173 psa_algorithm_t alg,
174 const uint8_t *nonce, size_t nonce_length,
175 const uint8_t *additional_data, size_t additional_data_length,
176 const uint8_t *plaintext, size_t plaintext_length,
177 uint8_t *ciphertext, size_t ciphertext_size, size_t *ciphertext_length )
178{
179 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottcbbde5f2021-05-10 18:19:46 +0100180 mbedtls_psa_aead_operation_t operation = MBEDTLS_PSA_AEAD_OPERATION_INIT;
Ronald Cron46f91782021-03-17 08:16:34 +0100181 uint8_t *tag;
Ronald Cron46f91782021-03-17 08:16:34 +0100182
Paul Elliottcc358592021-05-12 12:22:28 +0100183 status = psa_aead_setup( &operation, attributes, key_buffer,
184 key_buffer_size, alg );
185
Ronald Cron46f91782021-03-17 08:16:34 +0100186 if( status != PSA_SUCCESS )
187 goto exit;
188
189 /* For all currently supported modes, the tag is at the end of the
190 * ciphertext. */
191 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
192 {
193 status = PSA_ERROR_BUFFER_TOO_SMALL;
194 goto exit;
195 }
196 tag = ciphertext + plaintext_length;
197
Paul Elliott96b01732021-07-16 17:00:26 +0100198 if( mbedtls_aead_check_nonce_length( &operation, nonce_length )
199 != PSA_SUCCESS )
200 {
201 status = PSA_ERROR_NOT_SUPPORTED;
202 goto exit;
203 }
204
Ronald Cron46f91782021-03-17 08:16:34 +0100205#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
Paul Elliott07a30c42021-04-20 14:13:23 +0100206 if( operation.alg == PSA_ALG_CCM )
Ronald Cron46f91782021-03-17 08:16:34 +0100207 {
208 status = mbedtls_to_psa_error(
209 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
210 plaintext_length,
211 nonce, nonce_length,
212 additional_data,
213 additional_data_length,
214 plaintext, ciphertext,
215 tag, operation.tag_length ) );
216 }
217 else
218#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
Ronald Cron810eb162021-04-06 09:01:39 +0200219#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
Paul Elliott07a30c42021-04-20 14:13:23 +0100220 if( operation.alg == PSA_ALG_GCM )
Ronald Cron810eb162021-04-06 09:01:39 +0200221 {
222 status = mbedtls_to_psa_error(
223 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
224 MBEDTLS_GCM_ENCRYPT,
225 plaintext_length,
226 nonce, nonce_length,
227 additional_data, additional_data_length,
228 plaintext, ciphertext,
229 operation.tag_length, tag ) );
230 }
231 else
232#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
Ronald Cron46f91782021-03-17 08:16:34 +0100233#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
Paul Elliott07a30c42021-04-20 14:13:23 +0100234 if( operation.alg == PSA_ALG_CHACHA20_POLY1305 )
Ronald Cron46f91782021-03-17 08:16:34 +0100235 {
Paul Elliott96b01732021-07-16 17:00:26 +0100236 if( operation.tag_length != 16 )
Ronald Cron46f91782021-03-17 08:16:34 +0100237 {
238 status = PSA_ERROR_NOT_SUPPORTED;
239 goto exit;
240 }
241 status = mbedtls_to_psa_error(
242 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
243 plaintext_length,
244 nonce,
245 additional_data,
246 additional_data_length,
247 plaintext,
248 ciphertext,
249 tag ) );
250 }
251 else
252#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
253 {
254 (void) tag;
255 return( PSA_ERROR_NOT_SUPPORTED );
256 }
257
258 if( status == PSA_SUCCESS )
259 *ciphertext_length = plaintext_length + operation.tag_length;
260
261exit:
Paul Elliottadb8b162021-04-20 16:06:57 +0100262 mbedtls_psa_aead_abort( &operation );
Ronald Cron46f91782021-03-17 08:16:34 +0100263
264 return( status );
265}
266
267/* Locate the tag in a ciphertext buffer containing the encrypted data
268 * followed by the tag. Return the length of the part preceding the tag in
269 * *plaintext_length. This is the size of the plaintext in modes where
270 * the encrypted data has the same size as the plaintext, such as
271 * CCM and GCM. */
272static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
273 const uint8_t *ciphertext,
274 size_t ciphertext_length,
275 size_t plaintext_size,
276 const uint8_t **p_tag )
277{
278 size_t payload_length;
279 if( tag_length > ciphertext_length )
280 return( PSA_ERROR_INVALID_ARGUMENT );
281 payload_length = ciphertext_length - tag_length;
282 if( payload_length > plaintext_size )
283 return( PSA_ERROR_BUFFER_TOO_SMALL );
284 *p_tag = ciphertext + payload_length;
285 return( PSA_SUCCESS );
286}
287
288psa_status_t mbedtls_psa_aead_decrypt(
289 const psa_key_attributes_t *attributes,
290 const uint8_t *key_buffer, size_t key_buffer_size,
291 psa_algorithm_t alg,
292 const uint8_t *nonce, size_t nonce_length,
293 const uint8_t *additional_data, size_t additional_data_length,
294 const uint8_t *ciphertext, size_t ciphertext_length,
295 uint8_t *plaintext, size_t plaintext_size, size_t *plaintext_length )
296{
297 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottcbbde5f2021-05-10 18:19:46 +0100298 mbedtls_psa_aead_operation_t operation = MBEDTLS_PSA_AEAD_OPERATION_INIT;
Ronald Cron46f91782021-03-17 08:16:34 +0100299 const uint8_t *tag = NULL;
Ronald Cron46f91782021-03-17 08:16:34 +0100300
Paul Elliottcc358592021-05-12 12:22:28 +0100301 status = psa_aead_setup( &operation, attributes, key_buffer,
302 key_buffer_size, alg );
303
Ronald Cron46f91782021-03-17 08:16:34 +0100304 if( status != PSA_SUCCESS )
305 goto exit;
306
307 status = psa_aead_unpadded_locate_tag( operation.tag_length,
308 ciphertext, ciphertext_length,
309 plaintext_size, &tag );
310 if( status != PSA_SUCCESS )
311 goto exit;
312
Paul Elliottcf2d66e2021-06-23 18:49:56 +0100313 if( mbedtls_aead_check_nonce_length( &operation, nonce_length )
Paul Elliott99f548d2021-07-22 18:03:50 +0100314 != PSA_SUCCESS )
Paul Elliottcf2d66e2021-06-23 18:49:56 +0100315 {
316 status = PSA_ERROR_NOT_SUPPORTED;
317 goto exit;
318 }
319
Ronald Cron46f91782021-03-17 08:16:34 +0100320#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
Paul Elliott07a30c42021-04-20 14:13:23 +0100321 if( operation.alg == PSA_ALG_CCM )
Ronald Cron46f91782021-03-17 08:16:34 +0100322 {
323 status = mbedtls_to_psa_error(
324 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
325 ciphertext_length - operation.tag_length,
326 nonce, nonce_length,
327 additional_data,
328 additional_data_length,
329 ciphertext, plaintext,
330 tag, operation.tag_length ) );
331 }
332 else
333#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
Ronald Cron810eb162021-04-06 09:01:39 +0200334#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
Paul Elliott07a30c42021-04-20 14:13:23 +0100335 if( operation.alg == PSA_ALG_GCM )
Ronald Cron810eb162021-04-06 09:01:39 +0200336 {
337 status = mbedtls_to_psa_error(
338 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
339 ciphertext_length - operation.tag_length,
340 nonce, nonce_length,
341 additional_data,
342 additional_data_length,
343 tag, operation.tag_length,
344 ciphertext, plaintext ) );
345 }
346 else
347#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
Ronald Cron46f91782021-03-17 08:16:34 +0100348#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
Paul Elliott07a30c42021-04-20 14:13:23 +0100349 if( operation.alg == PSA_ALG_CHACHA20_POLY1305 )
Ronald Cron46f91782021-03-17 08:16:34 +0100350 {
Paul Elliottcf2d66e2021-06-23 18:49:56 +0100351 if( operation.tag_length != 16 )
Ronald Cron46f91782021-03-17 08:16:34 +0100352 {
353 status = PSA_ERROR_NOT_SUPPORTED;
354 goto exit;
355 }
356 status = mbedtls_to_psa_error(
357 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
358 ciphertext_length - operation.tag_length,
359 nonce,
360 additional_data,
361 additional_data_length,
362 tag,
363 ciphertext,
364 plaintext ) );
365 }
366 else
367#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
368 {
369 return( PSA_ERROR_NOT_SUPPORTED );
370 }
371
372 if( status == PSA_SUCCESS )
373 *plaintext_length = ciphertext_length - operation.tag_length;
374
375exit:
Paul Elliottadb8b162021-04-20 16:06:57 +0100376 mbedtls_psa_aead_abort( &operation );
Ronald Cron46f91782021-03-17 08:16:34 +0100377
378 if( status == PSA_SUCCESS )
379 *plaintext_length = ciphertext_length - operation.tag_length;
380 return( status );
381}
Ronald Cron7ceee8d2021-03-17 16:55:43 +0100382
Paul Elliottadb8b162021-04-20 16:06:57 +0100383/* Set the key and algorithm for a multipart authenticated encryption
384 * operation. */
Paul Elliottbb8bf662021-05-19 17:29:42 +0100385psa_status_t mbedtls_psa_aead_encrypt_setup(
386 mbedtls_psa_aead_operation_t *operation,
387 const psa_key_attributes_t *attributes,
388 const uint8_t *key_buffer,
389 size_t key_buffer_size,
390 psa_algorithm_t alg )
Paul Elliottadb8b162021-04-20 16:06:57 +0100391{
Paul Elliott9e8ccd72021-05-13 14:30:53 +0100392 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottadb8b162021-04-20 16:06:57 +0100393
Paul Elliott60aa2032021-05-20 18:57:02 +0100394#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
395 if( operation->alg == PSA_ALG_CCM )
396 {
Paul Elliotte95259f2021-05-21 17:09:21 +0100397 return( PSA_ERROR_NOT_SUPPORTED );
Paul Elliott60aa2032021-05-20 18:57:02 +0100398 }
399#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
400
Paul Elliottcc358592021-05-12 12:22:28 +0100401 status = psa_aead_setup( operation, attributes, key_buffer,
402 key_buffer_size, alg );
Paul Elliottadb8b162021-04-20 16:06:57 +0100403
404 if( status == PSA_SUCCESS )
Paul Elliottadb8b162021-04-20 16:06:57 +0100405 operation->is_encrypt = 1;
Paul Elliottadb8b162021-04-20 16:06:57 +0100406
407 return ( status );
408}
409
410/* Set the key and algorithm for a multipart authenticated decryption
411 * operation. */
Paul Elliottbb8bf662021-05-19 17:29:42 +0100412psa_status_t mbedtls_psa_aead_decrypt_setup(
413 mbedtls_psa_aead_operation_t *operation,
414 const psa_key_attributes_t *attributes,
415 const uint8_t *key_buffer,
416 size_t key_buffer_size,
417 psa_algorithm_t alg )
Paul Elliottadb8b162021-04-20 16:06:57 +0100418{
Paul Elliott9e8ccd72021-05-13 14:30:53 +0100419 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottadb8b162021-04-20 16:06:57 +0100420
Paul Elliotte95259f2021-05-21 17:09:21 +0100421#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
Paul Elliott60aa2032021-05-20 18:57:02 +0100422 if( operation->alg == PSA_ALG_CCM )
423 {
Paul Elliotte95259f2021-05-21 17:09:21 +0100424 return( PSA_ERROR_NOT_SUPPORTED );
Paul Elliott60aa2032021-05-20 18:57:02 +0100425 }
426#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
Paul Elliottadb8b162021-04-20 16:06:57 +0100427
Paul Elliottcc358592021-05-12 12:22:28 +0100428 status = psa_aead_setup( operation, attributes, key_buffer,
429 key_buffer_size, alg );
Paul Elliottadb8b162021-04-20 16:06:57 +0100430
431 if( status == PSA_SUCCESS )
Paul Elliottadb8b162021-04-20 16:06:57 +0100432 operation->is_encrypt = 0;
Paul Elliottadb8b162021-04-20 16:06:57 +0100433
434 return ( status );
435}
436
Paul Elliottadb8b162021-04-20 16:06:57 +0100437/* Set a nonce for the multipart AEAD operation*/
Paul Elliottbb8bf662021-05-19 17:29:42 +0100438psa_status_t mbedtls_psa_aead_set_nonce(
439 mbedtls_psa_aead_operation_t *operation,
440 const uint8_t *nonce,
441 size_t nonce_length )
Paul Elliottadb8b162021-04-20 16:06:57 +0100442{
Paul Elliott9e8ccd72021-05-13 14:30:53 +0100443 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottadb8b162021-04-20 16:06:57 +0100444
Paul Elliottcf2d66e2021-06-23 18:49:56 +0100445 if( mbedtls_aead_check_nonce_length( operation, nonce_length )
Paul Elliott66696b52021-08-16 18:42:41 +0100446 != PSA_SUCCESS || nonce == NULL )
Paul Elliottcf2d66e2021-06-23 18:49:56 +0100447 {
448 return( PSA_ERROR_INVALID_ARGUMENT );
449 }
450
Paul Elliottbc949782021-06-03 15:29:00 +0100451#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
Paul Elliottadb8b162021-04-20 16:06:57 +0100452 if( operation->alg == PSA_ALG_GCM )
453 {
Paul Elliott83f09ef2021-05-21 19:28:26 +0100454 status = mbedtls_to_psa_error(
455 mbedtls_gcm_starts( &operation->ctx.gcm,
456 operation->is_encrypt ?
457 MBEDTLS_GCM_ENCRYPT : MBEDTLS_GCM_DECRYPT,
458 nonce,
459 nonce_length ) );
Paul Elliottadb8b162021-04-20 16:06:57 +0100460 }
461 else
462#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
Paul Elliottadb8b162021-04-20 16:06:57 +0100463#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
464 if( operation->alg == PSA_ALG_CHACHA20_POLY1305 )
465 {
Paul Elliott2df40052021-05-07 17:52:18 +0100466 status = mbedtls_to_psa_error(
467 mbedtls_chachapoly_starts( &operation->ctx.chachapoly,
468 nonce,
469 operation->is_encrypt ?
470 MBEDTLS_CHACHAPOLY_ENCRYPT :
471 MBEDTLS_CHACHAPOLY_DECRYPT ) );
Paul Elliottadb8b162021-04-20 16:06:57 +0100472 }
473 else
474#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
475 {
Paul Elliottbc949782021-06-03 15:29:00 +0100476 ( void ) operation;
Paul Elliottadb8b162021-04-20 16:06:57 +0100477 ( void ) nonce;
478 ( void ) nonce_length;
479
480 return ( PSA_ERROR_NOT_SUPPORTED );
481 }
482
Paul Elliottadb8b162021-04-20 16:06:57 +0100483 return( status );
484}
485 /* Declare the lengths of the message and additional data for AEAD. */
Paul Elliottbb8bf662021-05-19 17:29:42 +0100486psa_status_t mbedtls_psa_aead_set_lengths(
487 mbedtls_psa_aead_operation_t *operation,
488 size_t ad_length,
489 size_t plaintext_length )
Paul Elliottadb8b162021-04-20 16:06:57 +0100490{
491
Paul Elliottadb8b162021-04-20 16:06:57 +0100492#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
493 if( operation->alg == PSA_ALG_GCM )
494 {
Paul Elliottef29e172021-05-10 19:33:03 +0100495 /* Lengths can only be too large for GCM if size_t is bigger than 32
Paul Elliotte9eeea32021-05-19 14:32:58 +0100496 * bits. Without the guard this code will generate warnings on 32bit
Paul Elliotte95259f2021-05-21 17:09:21 +0100497 * builds */
Paul Elliottadb8b162021-04-20 16:06:57 +0100498#if SIZE_MAX > UINT32_MAX
499 if( ( (uint64_t) ad_length ) >> 61 != 0 ||
500 ( (uint64_t) plaintext_length ) > 0xFFFFFFFE0ull )
501 {
502 return ( PSA_ERROR_INVALID_ARGUMENT );
503 }
504#endif
505 }
506 else
507#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
508#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
509 if( operation->alg == PSA_ALG_CCM )
510 {
511 if( ad_length > 0xFF00 )
Paul Elliottadb8b162021-04-20 16:06:57 +0100512 return ( PSA_ERROR_INVALID_ARGUMENT );
Paul Elliottadb8b162021-04-20 16:06:57 +0100513 }
514 else
515#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
516#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
517 if( operation->alg == PSA_ALG_CHACHA20_POLY1305 )
518 {
519 /* No length restrictions for ChaChaPoly. */
520 }
521 else
522#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
523 {
Paul Elliottbc949782021-06-03 15:29:00 +0100524 ( void ) operation;
Paul Elliottadb8b162021-04-20 16:06:57 +0100525 ( void ) ad_length;
526 ( void ) plaintext_length;
527
528 return ( PSA_ERROR_NOT_SUPPORTED );
529 }
530
Paul Elliottadb8b162021-04-20 16:06:57 +0100531 return ( PSA_SUCCESS );
532}
533
534/* Pass additional data to an active multipart AEAD operation. */
Paul Elliottbb8bf662021-05-19 17:29:42 +0100535psa_status_t mbedtls_psa_aead_update_ad(
536 mbedtls_psa_aead_operation_t *operation,
537 const uint8_t *input,
538 size_t input_length )
Paul Elliottadb8b162021-04-20 16:06:57 +0100539{
540 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
541
Paul Elliottadb8b162021-04-20 16:06:57 +0100542#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
543 if( operation->alg == PSA_ALG_GCM )
544 {
Paul Elliott2df40052021-05-07 17:52:18 +0100545 status = mbedtls_to_psa_error(
Paul Elliott83f09ef2021-05-21 19:28:26 +0100546 mbedtls_gcm_update_ad( &operation->ctx.gcm, input, input_length ) );
Paul Elliottadb8b162021-04-20 16:06:57 +0100547 }
548 else
549#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
Paul Elliottadb8b162021-04-20 16:06:57 +0100550#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
551 if( operation->alg == PSA_ALG_CHACHA20_POLY1305 )
552 {
Paul Elliott2df40052021-05-07 17:52:18 +0100553 status = mbedtls_to_psa_error(
554 mbedtls_chachapoly_update_aad( &operation->ctx.chachapoly,
555 input,
556 input_length ) );
Paul Elliottadb8b162021-04-20 16:06:57 +0100557 }
558 else
559#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
560 {
Paul Elliottbc949782021-06-03 15:29:00 +0100561 ( void ) operation;
562 ( void ) input;
563 ( void ) input_length;
Paul Elliottadb8b162021-04-20 16:06:57 +0100564
565 return ( PSA_ERROR_NOT_SUPPORTED );
566 }
567
Paul Elliottadb8b162021-04-20 16:06:57 +0100568 return ( status );
569}
570
571/* Encrypt or decrypt a message fragment in an active multipart AEAD
572 * operation.*/
Paul Elliottbb8bf662021-05-19 17:29:42 +0100573psa_status_t mbedtls_psa_aead_update(
574 mbedtls_psa_aead_operation_t *operation,
575 const uint8_t *input,
576 size_t input_length,
577 uint8_t *output,
578 size_t output_size,
579 size_t *output_length )
Paul Elliottadb8b162021-04-20 16:06:57 +0100580{
Paul Elliotte2c788d2021-05-13 17:16:01 +0100581 size_t update_output_length;
Paul Elliottadb8b162021-04-20 16:06:57 +0100582 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
583
Paul Elliotte2c788d2021-05-13 17:16:01 +0100584 update_output_length = input_length;
Paul Elliottadb8b162021-04-20 16:06:57 +0100585
Paul Elliottadb8b162021-04-20 16:06:57 +0100586#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
587 if( operation->alg == PSA_ALG_GCM )
588 {
Paul Elliottecce9012021-07-23 15:44:11 +0100589 if( output_size < input_length )
590 return( PSA_ERROR_BUFFER_TOO_SMALL );
591
Paul Elliott83f09ef2021-05-21 19:28:26 +0100592 status = mbedtls_to_psa_error(
593 mbedtls_gcm_update( &operation->ctx.gcm,
594 input, input_length,
595 output, output_size,
596 &update_output_length ) );
Paul Elliottadb8b162021-04-20 16:06:57 +0100597 }
598 else
599#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
Paul Elliottadb8b162021-04-20 16:06:57 +0100600#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
601 if( operation->alg == PSA_ALG_CHACHA20_POLY1305 )
602 {
Paul Elliottecce9012021-07-23 15:44:11 +0100603 if( output_size < input_length )
604 return( PSA_ERROR_BUFFER_TOO_SMALL );
605
Paul Elliott2df40052021-05-07 17:52:18 +0100606 status = mbedtls_to_psa_error(
607 mbedtls_chachapoly_update( &operation->ctx.chachapoly,
608 input_length,
609 input,
610 output ) );
Paul Elliottadb8b162021-04-20 16:06:57 +0100611 }
612 else
613#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
614 {
Paul Elliottbc949782021-06-03 15:29:00 +0100615 ( void ) input;
616 ( void ) input_length;
Paul Elliottadb8b162021-04-20 16:06:57 +0100617
618 return ( PSA_ERROR_NOT_SUPPORTED );
619 }
620
621 if( status == PSA_SUCCESS )
Paul Elliotte2c788d2021-05-13 17:16:01 +0100622 *output_length = update_output_length;
Paul Elliottadb8b162021-04-20 16:06:57 +0100623
624 return( status );
625}
626
Paul Elliottadb8b162021-04-20 16:06:57 +0100627/* Finish encrypting a message in a multipart AEAD operation. */
Paul Elliottbb8bf662021-05-19 17:29:42 +0100628psa_status_t mbedtls_psa_aead_finish(
629 mbedtls_psa_aead_operation_t *operation,
630 uint8_t *ciphertext,
631 size_t ciphertext_size,
632 size_t *ciphertext_length,
633 uint8_t *tag,
634 size_t tag_size,
635 size_t *tag_length )
Paul Elliottadb8b162021-04-20 16:06:57 +0100636{
637 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottfd3ca242021-04-25 18:10:42 +0100638 size_t finish_output_size = 0;
Paul Elliottadb8b162021-04-20 16:06:57 +0100639
Paul Elliott315628d2021-07-20 18:25:54 +0100640 if( tag_size < operation->tag_length )
641 return( PSA_ERROR_BUFFER_TOO_SMALL );
Paul Elliottadb8b162021-04-20 16:06:57 +0100642
643#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
644 if( operation->alg == PSA_ALG_GCM )
Paul Elliottecce9012021-07-23 15:44:11 +0100645 {
646 if( ciphertext_size < 15 )
647 return( PSA_ERROR_BUFFER_TOO_SMALL );
648
Paul Elliott83f09ef2021-05-21 19:28:26 +0100649 status = mbedtls_to_psa_error(
650 mbedtls_gcm_finish( &operation->ctx.gcm,
651 ciphertext, ciphertext_size,
Paul Elliott2fe5db82021-07-22 18:10:43 +0100652 tag, operation->tag_length ) );
Paul Elliottecce9012021-07-23 15:44:11 +0100653 }
Paul Elliottadb8b162021-04-20 16:06:57 +0100654 else
655#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
Paul Elliottadb8b162021-04-20 16:06:57 +0100656#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
657 if( operation->alg == PSA_ALG_CHACHA20_POLY1305 )
Paul Elliotted08cf82021-07-22 18:48:24 +0100658 {
659 /* Belt and braces. Although the above tag_size check should have
660 * already done this, if we later start supporting smaller tag sizes
661 * for chachapoly, then passing a tag buffer smaller than 16 into here
662 * could cause a buffer overflow, so better safe than sorry. */
663 if( tag_size < 16 )
664 return( PSA_ERROR_BUFFER_TOO_SMALL );
665
Paul Elliott2df40052021-05-07 17:52:18 +0100666 status = mbedtls_to_psa_error(
Paul Elliott83f09ef2021-05-21 19:28:26 +0100667 mbedtls_chachapoly_finish( &operation->ctx.chachapoly,
668 tag ) );
Paul Elliotted08cf82021-07-22 18:48:24 +0100669 }
Paul Elliottadb8b162021-04-20 16:06:57 +0100670 else
671#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
672 {
673 ( void ) ciphertext;
674 ( void ) ciphertext_size;
675 ( void ) ciphertext_length;
676 ( void ) tag;
677 ( void ) tag_size;
678 ( void ) tag_length;
679
680 return ( PSA_ERROR_NOT_SUPPORTED );
681 }
682
683 if( status == PSA_SUCCESS )
684 {
685 *ciphertext_length = finish_output_size;
Paul Elliottfd3ca242021-04-25 18:10:42 +0100686 *tag_length = operation->tag_length;
Paul Elliottadb8b162021-04-20 16:06:57 +0100687 }
688
Paul Elliottadb8b162021-04-20 16:06:57 +0100689 return ( status );
690}
691
Paul Elliottadb8b162021-04-20 16:06:57 +0100692/* Abort an AEAD operation */
Paul Elliottbb8bf662021-05-19 17:29:42 +0100693psa_status_t mbedtls_psa_aead_abort(
694 mbedtls_psa_aead_operation_t *operation )
Paul Elliottadb8b162021-04-20 16:06:57 +0100695{
Paul Elliott811d8d42021-04-22 11:31:14 +0100696 switch( operation->alg )
Paul Elliottadb8b162021-04-20 16:06:57 +0100697 {
Paul Elliott811d8d42021-04-22 11:31:14 +0100698#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
699 case PSA_ALG_CCM:
Paul Elliottadb8b162021-04-20 16:06:57 +0100700 mbedtls_ccm_free( &operation->ctx.ccm );
701 break;
702#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
703#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
704 case PSA_ALG_GCM:
705 mbedtls_gcm_free( &operation->ctx.gcm );
706 break;
707#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
708#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
Paul Elliott811d8d42021-04-22 11:31:14 +0100709 case PSA_ALG_CHACHA20_POLY1305:
710 mbedtls_chachapoly_free( &operation->ctx.chachapoly );
711 break;
Paul Elliottadb8b162021-04-20 16:06:57 +0100712#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
713 }
714
Paul Elliottcbbde5f2021-05-10 18:19:46 +0100715 operation->is_encrypt = 0;
Paul Elliott1a98aca2021-05-20 18:24:07 +0100716
Paul Elliottadb8b162021-04-20 16:06:57 +0100717 return( PSA_SUCCESS );
718}
719
Ronald Cron7ceee8d2021-03-17 16:55:43 +0100720#endif /* MBEDTLS_PSA_CRYPTO_C */
721