blob: 3b8fdc8b6e740da359e07981c7a3b074c251de8c [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
139psa_status_t mbedtls_psa_aead_encrypt(
140 const psa_key_attributes_t *attributes,
141 const uint8_t *key_buffer, size_t key_buffer_size,
142 psa_algorithm_t alg,
143 const uint8_t *nonce, size_t nonce_length,
144 const uint8_t *additional_data, size_t additional_data_length,
145 const uint8_t *plaintext, size_t plaintext_length,
146 uint8_t *ciphertext, size_t ciphertext_size, size_t *ciphertext_length )
147{
148 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottcbbde5f2021-05-10 18:19:46 +0100149 mbedtls_psa_aead_operation_t operation = MBEDTLS_PSA_AEAD_OPERATION_INIT;
Ronald Cron46f91782021-03-17 08:16:34 +0100150 uint8_t *tag;
Ronald Cron46f91782021-03-17 08:16:34 +0100151
Paul Elliottcc358592021-05-12 12:22:28 +0100152 status = psa_aead_setup( &operation, attributes, key_buffer,
153 key_buffer_size, alg );
154
Ronald Cron46f91782021-03-17 08:16:34 +0100155 if( status != PSA_SUCCESS )
156 goto exit;
157
158 /* For all currently supported modes, the tag is at the end of the
159 * ciphertext. */
160 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
161 {
162 status = PSA_ERROR_BUFFER_TOO_SMALL;
163 goto exit;
164 }
165 tag = ciphertext + plaintext_length;
166
Ronald Cron46f91782021-03-17 08:16:34 +0100167#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
Paul Elliott07a30c42021-04-20 14:13:23 +0100168 if( operation.alg == PSA_ALG_CCM )
Ronald Cron46f91782021-03-17 08:16:34 +0100169 {
170 status = mbedtls_to_psa_error(
171 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
172 plaintext_length,
173 nonce, nonce_length,
174 additional_data,
175 additional_data_length,
176 plaintext, ciphertext,
177 tag, operation.tag_length ) );
178 }
179 else
180#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
Ronald Cron810eb162021-04-06 09:01:39 +0200181#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
Paul Elliott07a30c42021-04-20 14:13:23 +0100182 if( operation.alg == PSA_ALG_GCM )
Ronald Cron810eb162021-04-06 09:01:39 +0200183 {
184 status = mbedtls_to_psa_error(
185 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
186 MBEDTLS_GCM_ENCRYPT,
187 plaintext_length,
188 nonce, nonce_length,
189 additional_data, additional_data_length,
190 plaintext, ciphertext,
191 operation.tag_length, tag ) );
192 }
193 else
194#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
Ronald Cron46f91782021-03-17 08:16:34 +0100195#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
Paul Elliott07a30c42021-04-20 14:13:23 +0100196 if( operation.alg == PSA_ALG_CHACHA20_POLY1305 )
Ronald Cron46f91782021-03-17 08:16:34 +0100197 {
198 if( nonce_length != 12 || operation.tag_length != 16 )
199 {
200 status = PSA_ERROR_NOT_SUPPORTED;
201 goto exit;
202 }
203 status = mbedtls_to_psa_error(
204 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
205 plaintext_length,
206 nonce,
207 additional_data,
208 additional_data_length,
209 plaintext,
210 ciphertext,
211 tag ) );
212 }
213 else
214#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
215 {
216 (void) tag;
217 return( PSA_ERROR_NOT_SUPPORTED );
218 }
219
220 if( status == PSA_SUCCESS )
221 *ciphertext_length = plaintext_length + operation.tag_length;
222
223exit:
Paul Elliottadb8b162021-04-20 16:06:57 +0100224 mbedtls_psa_aead_abort( &operation );
Ronald Cron46f91782021-03-17 08:16:34 +0100225
226 return( status );
227}
228
229/* Locate the tag in a ciphertext buffer containing the encrypted data
230 * followed by the tag. Return the length of the part preceding the tag in
231 * *plaintext_length. This is the size of the plaintext in modes where
232 * the encrypted data has the same size as the plaintext, such as
233 * CCM and GCM. */
234static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
235 const uint8_t *ciphertext,
236 size_t ciphertext_length,
237 size_t plaintext_size,
238 const uint8_t **p_tag )
239{
240 size_t payload_length;
241 if( tag_length > ciphertext_length )
242 return( PSA_ERROR_INVALID_ARGUMENT );
243 payload_length = ciphertext_length - tag_length;
244 if( payload_length > plaintext_size )
245 return( PSA_ERROR_BUFFER_TOO_SMALL );
246 *p_tag = ciphertext + payload_length;
247 return( PSA_SUCCESS );
248}
249
250psa_status_t mbedtls_psa_aead_decrypt(
251 const psa_key_attributes_t *attributes,
252 const uint8_t *key_buffer, size_t key_buffer_size,
253 psa_algorithm_t alg,
254 const uint8_t *nonce, size_t nonce_length,
255 const uint8_t *additional_data, size_t additional_data_length,
256 const uint8_t *ciphertext, size_t ciphertext_length,
257 uint8_t *plaintext, size_t plaintext_size, size_t *plaintext_length )
258{
259 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottcbbde5f2021-05-10 18:19:46 +0100260 mbedtls_psa_aead_operation_t operation = MBEDTLS_PSA_AEAD_OPERATION_INIT;
Ronald Cron46f91782021-03-17 08:16:34 +0100261 const uint8_t *tag = NULL;
Ronald Cron46f91782021-03-17 08:16:34 +0100262
Paul Elliottcc358592021-05-12 12:22:28 +0100263 status = psa_aead_setup( &operation, attributes, key_buffer,
264 key_buffer_size, alg );
265
Ronald Cron46f91782021-03-17 08:16:34 +0100266 if( status != PSA_SUCCESS )
267 goto exit;
268
269 status = psa_aead_unpadded_locate_tag( operation.tag_length,
270 ciphertext, ciphertext_length,
271 plaintext_size, &tag );
272 if( status != PSA_SUCCESS )
273 goto exit;
274
Ronald Cron46f91782021-03-17 08:16:34 +0100275#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
Paul Elliott07a30c42021-04-20 14:13:23 +0100276 if( operation.alg == PSA_ALG_CCM )
Ronald Cron46f91782021-03-17 08:16:34 +0100277 {
278 status = mbedtls_to_psa_error(
279 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
280 ciphertext_length - operation.tag_length,
281 nonce, nonce_length,
282 additional_data,
283 additional_data_length,
284 ciphertext, plaintext,
285 tag, operation.tag_length ) );
286 }
287 else
288#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
Ronald Cron810eb162021-04-06 09:01:39 +0200289#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
Paul Elliott07a30c42021-04-20 14:13:23 +0100290 if( operation.alg == PSA_ALG_GCM )
Ronald Cron810eb162021-04-06 09:01:39 +0200291 {
292 status = mbedtls_to_psa_error(
293 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
294 ciphertext_length - operation.tag_length,
295 nonce, nonce_length,
296 additional_data,
297 additional_data_length,
298 tag, operation.tag_length,
299 ciphertext, plaintext ) );
300 }
301 else
302#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
Ronald Cron46f91782021-03-17 08:16:34 +0100303#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
Paul Elliott07a30c42021-04-20 14:13:23 +0100304 if( operation.alg == PSA_ALG_CHACHA20_POLY1305 )
Ronald Cron46f91782021-03-17 08:16:34 +0100305 {
306 if( nonce_length != 12 || operation.tag_length != 16 )
307 {
308 status = PSA_ERROR_NOT_SUPPORTED;
309 goto exit;
310 }
311 status = mbedtls_to_psa_error(
312 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
313 ciphertext_length - operation.tag_length,
314 nonce,
315 additional_data,
316 additional_data_length,
317 tag,
318 ciphertext,
319 plaintext ) );
320 }
321 else
322#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
323 {
324 return( PSA_ERROR_NOT_SUPPORTED );
325 }
326
327 if( status == PSA_SUCCESS )
328 *plaintext_length = ciphertext_length - operation.tag_length;
329
330exit:
Paul Elliottadb8b162021-04-20 16:06:57 +0100331 mbedtls_psa_aead_abort( &operation );
Ronald Cron46f91782021-03-17 08:16:34 +0100332
333 if( status == PSA_SUCCESS )
334 *plaintext_length = ciphertext_length - operation.tag_length;
335 return( status );
336}
Ronald Cron7ceee8d2021-03-17 16:55:43 +0100337
Paul Elliottadb8b162021-04-20 16:06:57 +0100338/* Set the key and algorithm for a multipart authenticated encryption
339 * operation. */
Paul Elliottbb8bf662021-05-19 17:29:42 +0100340psa_status_t mbedtls_psa_aead_encrypt_setup(
341 mbedtls_psa_aead_operation_t *operation,
342 const psa_key_attributes_t *attributes,
343 const uint8_t *key_buffer,
344 size_t key_buffer_size,
345 psa_algorithm_t alg )
Paul Elliottadb8b162021-04-20 16:06:57 +0100346{
Paul Elliott9e8ccd72021-05-13 14:30:53 +0100347 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottadb8b162021-04-20 16:06:57 +0100348
Paul Elliott60aa2032021-05-20 18:57:02 +0100349#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
350 if( operation->alg == PSA_ALG_CCM )
351 {
Paul Elliotte95259f2021-05-21 17:09:21 +0100352 return( PSA_ERROR_NOT_SUPPORTED );
Paul Elliott60aa2032021-05-20 18:57:02 +0100353 }
354#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
355
Paul Elliottcc358592021-05-12 12:22:28 +0100356 status = psa_aead_setup( operation, attributes, key_buffer,
357 key_buffer_size, alg );
Paul Elliottadb8b162021-04-20 16:06:57 +0100358
359 if( status == PSA_SUCCESS )
Paul Elliottadb8b162021-04-20 16:06:57 +0100360 operation->is_encrypt = 1;
Paul Elliottadb8b162021-04-20 16:06:57 +0100361
362 return ( status );
363}
364
365/* Set the key and algorithm for a multipart authenticated decryption
366 * operation. */
Paul Elliottbb8bf662021-05-19 17:29:42 +0100367psa_status_t mbedtls_psa_aead_decrypt_setup(
368 mbedtls_psa_aead_operation_t *operation,
369 const psa_key_attributes_t *attributes,
370 const uint8_t *key_buffer,
371 size_t key_buffer_size,
372 psa_algorithm_t alg )
Paul Elliottadb8b162021-04-20 16:06:57 +0100373{
Paul Elliott9e8ccd72021-05-13 14:30:53 +0100374 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottadb8b162021-04-20 16:06:57 +0100375
Paul Elliotte95259f2021-05-21 17:09:21 +0100376#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
Paul Elliott60aa2032021-05-20 18:57:02 +0100377 if( operation->alg == PSA_ALG_CCM )
378 {
Paul Elliotte95259f2021-05-21 17:09:21 +0100379 return( PSA_ERROR_NOT_SUPPORTED );
Paul Elliott60aa2032021-05-20 18:57:02 +0100380 }
381#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
Paul Elliottadb8b162021-04-20 16:06:57 +0100382
Paul Elliottcc358592021-05-12 12:22:28 +0100383 status = psa_aead_setup( operation, attributes, key_buffer,
384 key_buffer_size, alg );
Paul Elliottadb8b162021-04-20 16:06:57 +0100385
386 if( status == PSA_SUCCESS )
Paul Elliottadb8b162021-04-20 16:06:57 +0100387 operation->is_encrypt = 0;
Paul Elliottadb8b162021-04-20 16:06:57 +0100388
389 return ( status );
390}
391
Paul Elliottadb8b162021-04-20 16:06:57 +0100392/* Set a nonce for the multipart AEAD operation*/
Paul Elliottbb8bf662021-05-19 17:29:42 +0100393psa_status_t mbedtls_psa_aead_set_nonce(
394 mbedtls_psa_aead_operation_t *operation,
395 const uint8_t *nonce,
396 size_t nonce_length )
Paul Elliottadb8b162021-04-20 16:06:57 +0100397{
Paul Elliott9e8ccd72021-05-13 14:30:53 +0100398 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottadb8b162021-04-20 16:06:57 +0100399
Paul Elliottbc949782021-06-03 15:29:00 +0100400#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
Paul Elliottadb8b162021-04-20 16:06:57 +0100401 if( operation->alg == PSA_ALG_GCM )
402 {
Paul Elliott83f09ef2021-05-21 19:28:26 +0100403 status = mbedtls_to_psa_error(
404 mbedtls_gcm_starts( &operation->ctx.gcm,
405 operation->is_encrypt ?
406 MBEDTLS_GCM_ENCRYPT : MBEDTLS_GCM_DECRYPT,
407 nonce,
408 nonce_length ) );
Paul Elliottadb8b162021-04-20 16:06:57 +0100409 }
410 else
411#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
Paul Elliottadb8b162021-04-20 16:06:57 +0100412#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
413 if( operation->alg == PSA_ALG_CHACHA20_POLY1305 )
414 {
415 if( nonce_length != 12 && nonce_length != 8)
416 {
417 return( PSA_ERROR_INVALID_ARGUMENT );
418 }
419
Paul Elliott2df40052021-05-07 17:52:18 +0100420 status = mbedtls_to_psa_error(
421 mbedtls_chachapoly_starts( &operation->ctx.chachapoly,
422 nonce,
423 operation->is_encrypt ?
424 MBEDTLS_CHACHAPOLY_ENCRYPT :
425 MBEDTLS_CHACHAPOLY_DECRYPT ) );
Paul Elliottadb8b162021-04-20 16:06:57 +0100426 }
427 else
428#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
429 {
Paul Elliottbc949782021-06-03 15:29:00 +0100430 ( void ) operation;
Paul Elliottadb8b162021-04-20 16:06:57 +0100431 ( void ) nonce;
432 ( void ) nonce_length;
433
434 return ( PSA_ERROR_NOT_SUPPORTED );
435 }
436
Paul Elliottadb8b162021-04-20 16:06:57 +0100437 return( status );
438}
439 /* Declare the lengths of the message and additional data for AEAD. */
Paul Elliottbb8bf662021-05-19 17:29:42 +0100440psa_status_t mbedtls_psa_aead_set_lengths(
441 mbedtls_psa_aead_operation_t *operation,
442 size_t ad_length,
443 size_t plaintext_length )
Paul Elliottadb8b162021-04-20 16:06:57 +0100444{
445
Paul Elliottadb8b162021-04-20 16:06:57 +0100446#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
447 if( operation->alg == PSA_ALG_GCM )
448 {
Paul Elliottef29e172021-05-10 19:33:03 +0100449 /* Lengths can only be too large for GCM if size_t is bigger than 32
Paul Elliotte9eeea32021-05-19 14:32:58 +0100450 * bits. Without the guard this code will generate warnings on 32bit
Paul Elliotte95259f2021-05-21 17:09:21 +0100451 * builds */
Paul Elliottadb8b162021-04-20 16:06:57 +0100452#if SIZE_MAX > UINT32_MAX
453 if( ( (uint64_t) ad_length ) >> 61 != 0 ||
454 ( (uint64_t) plaintext_length ) > 0xFFFFFFFE0ull )
455 {
456 return ( PSA_ERROR_INVALID_ARGUMENT );
457 }
458#endif
459 }
460 else
461#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
462#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
463 if( operation->alg == PSA_ALG_CCM )
464 {
465 if( ad_length > 0xFF00 )
Paul Elliottadb8b162021-04-20 16:06:57 +0100466 return ( PSA_ERROR_INVALID_ARGUMENT );
Paul Elliottadb8b162021-04-20 16:06:57 +0100467 }
468 else
469#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
470#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
471 if( operation->alg == PSA_ALG_CHACHA20_POLY1305 )
472 {
473 /* No length restrictions for ChaChaPoly. */
474 }
475 else
476#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
477 {
Paul Elliottbc949782021-06-03 15:29:00 +0100478 ( void ) operation;
Paul Elliottadb8b162021-04-20 16:06:57 +0100479 ( void ) ad_length;
480 ( void ) plaintext_length;
481
482 return ( PSA_ERROR_NOT_SUPPORTED );
483 }
484
Paul Elliottadb8b162021-04-20 16:06:57 +0100485 return ( PSA_SUCCESS );
486}
487
488/* Pass additional data to an active multipart AEAD operation. */
Paul Elliottbb8bf662021-05-19 17:29:42 +0100489psa_status_t mbedtls_psa_aead_update_ad(
490 mbedtls_psa_aead_operation_t *operation,
491 const uint8_t *input,
492 size_t input_length )
Paul Elliottadb8b162021-04-20 16:06:57 +0100493{
494 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
495
Paul Elliottadb8b162021-04-20 16:06:57 +0100496#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
497 if( operation->alg == PSA_ALG_GCM )
498 {
Paul Elliott2df40052021-05-07 17:52:18 +0100499 status = mbedtls_to_psa_error(
Paul Elliott83f09ef2021-05-21 19:28:26 +0100500 mbedtls_gcm_update_ad( &operation->ctx.gcm, input, input_length ) );
Paul Elliottadb8b162021-04-20 16:06:57 +0100501 }
502 else
503#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
Paul Elliottadb8b162021-04-20 16:06:57 +0100504#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
505 if( operation->alg == PSA_ALG_CHACHA20_POLY1305 )
506 {
Paul Elliott2df40052021-05-07 17:52:18 +0100507 status = mbedtls_to_psa_error(
508 mbedtls_chachapoly_update_aad( &operation->ctx.chachapoly,
509 input,
510 input_length ) );
Paul Elliottadb8b162021-04-20 16:06:57 +0100511 }
512 else
513#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
514 {
Paul Elliottbc949782021-06-03 15:29:00 +0100515 ( void ) operation;
516 ( void ) input;
517 ( void ) input_length;
Paul Elliottadb8b162021-04-20 16:06:57 +0100518
519 return ( PSA_ERROR_NOT_SUPPORTED );
520 }
521
Paul Elliottadb8b162021-04-20 16:06:57 +0100522 return ( status );
523}
524
525/* Encrypt or decrypt a message fragment in an active multipart AEAD
526 * operation.*/
Paul Elliottbb8bf662021-05-19 17:29:42 +0100527psa_status_t mbedtls_psa_aead_update(
528 mbedtls_psa_aead_operation_t *operation,
529 const uint8_t *input,
530 size_t input_length,
531 uint8_t *output,
532 size_t output_size,
533 size_t *output_length )
Paul Elliottadb8b162021-04-20 16:06:57 +0100534{
Paul Elliotte2c788d2021-05-13 17:16:01 +0100535 size_t update_output_length;
Paul Elliottadb8b162021-04-20 16:06:57 +0100536 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
537
Paul Elliotte2c788d2021-05-13 17:16:01 +0100538 update_output_length = input_length;
Paul Elliottadb8b162021-04-20 16:06:57 +0100539
Paul Elliott72c10082021-04-23 19:02:16 +0100540 if( PSA_AEAD_UPDATE_OUTPUT_SIZE( operation->key_type, operation->alg,
541 input_length ) > output_size )
Paul Elliottadb8b162021-04-20 16:06:57 +0100542 return ( PSA_ERROR_BUFFER_TOO_SMALL );
Paul Elliottadb8b162021-04-20 16:06:57 +0100543
Paul Elliottadb8b162021-04-20 16:06:57 +0100544#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
545 if( operation->alg == PSA_ALG_GCM )
546 {
Paul Elliott83f09ef2021-05-21 19:28:26 +0100547 status = mbedtls_to_psa_error(
548 mbedtls_gcm_update( &operation->ctx.gcm,
549 input, input_length,
550 output, output_size,
551 &update_output_length ) );
Paul Elliottadb8b162021-04-20 16:06:57 +0100552 }
553 else
554#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
Paul Elliottadb8b162021-04-20 16:06:57 +0100555#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
556 if( operation->alg == PSA_ALG_CHACHA20_POLY1305 )
557 {
Paul Elliott2df40052021-05-07 17:52:18 +0100558 status = mbedtls_to_psa_error(
559 mbedtls_chachapoly_update( &operation->ctx.chachapoly,
560 input_length,
561 input,
562 output ) );
Paul Elliottadb8b162021-04-20 16:06:57 +0100563 }
564 else
565#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
566 {
Paul Elliottbc949782021-06-03 15:29:00 +0100567 ( void ) input;
568 ( void ) input_length;
Paul Elliottadb8b162021-04-20 16:06:57 +0100569
570 return ( PSA_ERROR_NOT_SUPPORTED );
571 }
572
573 if( status == PSA_SUCCESS )
Paul Elliotte2c788d2021-05-13 17:16:01 +0100574 *output_length = update_output_length;
Paul Elliottadb8b162021-04-20 16:06:57 +0100575
576 return( status );
577}
578
579/* Common checks for both mbedtls_psa_aead_finish() and
580 mbedtls_psa_aead_verify() */
Paul Elliottbb8bf662021-05-19 17:29:42 +0100581static psa_status_t mbedtls_psa_aead_finish_checks(
582 mbedtls_psa_aead_operation_t *operation,
583 size_t output_size,
584 size_t tag_size )
Paul Elliottadb8b162021-04-20 16:06:57 +0100585{
Paul Elliottfd3ca242021-04-25 18:10:42 +0100586 size_t finish_output_size;
587
Paul Elliottfd3ca242021-04-25 18:10:42 +0100588 if( tag_size < operation->tag_length )
Paul Elliottadb8b162021-04-20 16:06:57 +0100589 return ( PSA_ERROR_BUFFER_TOO_SMALL );
Paul Elliottadb8b162021-04-20 16:06:57 +0100590
Paul Elliott80acb7e2021-05-12 12:41:33 +0100591 finish_output_size = operation->is_encrypt ?
592 PSA_AEAD_FINISH_OUTPUT_SIZE( operation->key_type, operation->alg ) :
593 PSA_AEAD_VERIFY_OUTPUT_SIZE( operation->key_type, operation->alg );
Paul Elliottadb8b162021-04-20 16:06:57 +0100594
Paul Elliottfd3ca242021-04-25 18:10:42 +0100595 if( output_size < finish_output_size )
Paul Elliottadb8b162021-04-20 16:06:57 +0100596 return ( PSA_ERROR_BUFFER_TOO_SMALL );
Paul Elliottadb8b162021-04-20 16:06:57 +0100597
598 return ( PSA_SUCCESS );
Paul Elliottadb8b162021-04-20 16:06:57 +0100599}
600
601/* Finish encrypting a message in a multipart AEAD operation. */
Paul Elliottbb8bf662021-05-19 17:29:42 +0100602psa_status_t mbedtls_psa_aead_finish(
603 mbedtls_psa_aead_operation_t *operation,
604 uint8_t *ciphertext,
605 size_t ciphertext_size,
606 size_t *ciphertext_length,
607 uint8_t *tag,
608 size_t tag_size,
609 size_t *tag_length )
Paul Elliottadb8b162021-04-20 16:06:57 +0100610{
611 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottfd3ca242021-04-25 18:10:42 +0100612 size_t finish_output_size = 0;
Paul Elliottadb8b162021-04-20 16:06:57 +0100613
Paul Elliott2df40052021-05-07 17:52:18 +0100614 status = mbedtls_psa_aead_finish_checks( operation, ciphertext_size,
615 tag_size );
Paul Elliottadb8b162021-04-20 16:06:57 +0100616
617 if( status != PSA_SUCCESS )
Paul Elliottadb8b162021-04-20 16:06:57 +0100618 return status;
Paul Elliottadb8b162021-04-20 16:06:57 +0100619
620#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
621 if( operation->alg == PSA_ALG_GCM )
Paul Elliott83f09ef2021-05-21 19:28:26 +0100622 status = mbedtls_to_psa_error(
623 mbedtls_gcm_finish( &operation->ctx.gcm,
624 ciphertext, ciphertext_size,
625 tag, tag_size ) );
Paul Elliottadb8b162021-04-20 16:06:57 +0100626 else
627#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
Paul Elliottadb8b162021-04-20 16:06:57 +0100628#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
629 if( operation->alg == PSA_ALG_CHACHA20_POLY1305 )
Paul Elliott2df40052021-05-07 17:52:18 +0100630 status = mbedtls_to_psa_error(
Paul Elliott83f09ef2021-05-21 19:28:26 +0100631 mbedtls_chachapoly_finish( &operation->ctx.chachapoly,
632 tag ) );
Paul Elliottadb8b162021-04-20 16:06:57 +0100633 else
634#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
635 {
636 ( void ) ciphertext;
637 ( void ) ciphertext_size;
638 ( void ) ciphertext_length;
639 ( void ) tag;
640 ( void ) tag_size;
641 ( void ) tag_length;
642
643 return ( PSA_ERROR_NOT_SUPPORTED );
644 }
645
646 if( status == PSA_SUCCESS )
647 {
648 *ciphertext_length = finish_output_size;
Paul Elliottfd3ca242021-04-25 18:10:42 +0100649 *tag_length = operation->tag_length;
Paul Elliottadb8b162021-04-20 16:06:57 +0100650 }
651
Paul Elliottadb8b162021-04-20 16:06:57 +0100652 return ( status );
653}
654
655/* Finish authenticating and decrypting a message in a multipart AEAD
656 * operation.*/
Paul Elliottbb8bf662021-05-19 17:29:42 +0100657psa_status_t mbedtls_psa_aead_verify(
658 mbedtls_psa_aead_operation_t *operation,
659 uint8_t *plaintext,
660 size_t plaintext_size,
661 size_t *plaintext_length,
662 const uint8_t *tag,
663 size_t tag_length )
Paul Elliottadb8b162021-04-20 16:06:57 +0100664{
665 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottfd3ca242021-04-25 18:10:42 +0100666 size_t finish_output_size = 0;
Paul Elliottadb8b162021-04-20 16:06:57 +0100667 int do_tag_check = 1;
Paul Elliottccaea402021-05-13 14:22:52 +0100668 uint8_t check_tag[PSA_AEAD_TAG_MAX_SIZE];
Paul Elliottadb8b162021-04-20 16:06:57 +0100669
Paul Elliott2df40052021-05-07 17:52:18 +0100670 status = mbedtls_psa_aead_finish_checks( operation, plaintext_size,
671 tag_length );
Paul Elliottadb8b162021-04-20 16:06:57 +0100672
673 if( status != PSA_SUCCESS )
Paul Elliottadb8b162021-04-20 16:06:57 +0100674 return status;
Paul Elliottadb8b162021-04-20 16:06:57 +0100675
676#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
677 if( operation->alg == PSA_ALG_GCM )
Paul Elliottadb8b162021-04-20 16:06:57 +0100678 /* Call finish to get the tag for comparison */
Paul Elliott2df40052021-05-07 17:52:18 +0100679 status = mbedtls_to_psa_error(
680 mbedtls_gcm_finish( &operation->ctx.gcm,
Paul Elliott83f09ef2021-05-21 19:28:26 +0100681 plaintext, plaintext_size,
682 check_tag, operation->tag_length ) );
Paul Elliottadb8b162021-04-20 16:06:57 +0100683 else
684#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
Paul Elliottadb8b162021-04-20 16:06:57 +0100685#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
686 if( operation->alg == PSA_ALG_CHACHA20_POLY1305 )
Paul Elliottadb8b162021-04-20 16:06:57 +0100687 // call finish to get the tag for comparison.
Paul Elliott2df40052021-05-07 17:52:18 +0100688 status = mbedtls_to_psa_error(
689 mbedtls_chachapoly_finish( &operation->ctx.chachapoly,
690 check_tag ) );
Paul Elliottfd3ca242021-04-25 18:10:42 +0100691
Paul Elliottadb8b162021-04-20 16:06:57 +0100692 else
693#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
694 {
695 ( void ) plaintext;
696 ( void ) plaintext_size;
697 ( void ) plaintext_length;
698 ( void ) tag;
699 ( void ) tag_length;
700
701 return ( PSA_ERROR_NOT_SUPPORTED );
702 }
703
704 if( status == PSA_SUCCESS )
705 {
Paul Elliott72c10082021-04-23 19:02:16 +0100706 *plaintext_length = finish_output_size;
707
Paul Elliott3a16e012021-05-21 18:03:15 +0100708 if( do_tag_check && ( tag_length != operation->tag_length ||
709 mbedtls_psa_safer_memcmp(tag, check_tag, tag_length) != 0 ) )
Paul Elliott811d8d42021-04-22 11:31:14 +0100710 status = PSA_ERROR_INVALID_SIGNATURE;
Paul Elliottadb8b162021-04-20 16:06:57 +0100711 }
712
Paul Elliottadb8b162021-04-20 16:06:57 +0100713 return ( status );
714}
715
716/* Abort an AEAD operation */
Paul Elliottbb8bf662021-05-19 17:29:42 +0100717psa_status_t mbedtls_psa_aead_abort(
718 mbedtls_psa_aead_operation_t *operation )
Paul Elliottadb8b162021-04-20 16:06:57 +0100719{
Paul Elliott811d8d42021-04-22 11:31:14 +0100720 switch( operation->alg )
Paul Elliottadb8b162021-04-20 16:06:57 +0100721 {
Paul Elliott811d8d42021-04-22 11:31:14 +0100722#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
723 case PSA_ALG_CCM:
Paul Elliottadb8b162021-04-20 16:06:57 +0100724 mbedtls_ccm_free( &operation->ctx.ccm );
725 break;
726#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
727#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
728 case PSA_ALG_GCM:
729 mbedtls_gcm_free( &operation->ctx.gcm );
730 break;
731#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
732#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
Paul Elliott811d8d42021-04-22 11:31:14 +0100733 case PSA_ALG_CHACHA20_POLY1305:
734 mbedtls_chachapoly_free( &operation->ctx.chachapoly );
735 break;
Paul Elliottadb8b162021-04-20 16:06:57 +0100736#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
737 }
738
Paul Elliottcbbde5f2021-05-10 18:19:46 +0100739 operation->is_encrypt = 0;
Paul Elliott1a98aca2021-05-20 18:24:07 +0100740
Paul Elliottadb8b162021-04-20 16:06:57 +0100741 return( PSA_SUCCESS );
742}
743
Ronald Cron7ceee8d2021-03-17 16:55:43 +0100744#endif /* MBEDTLS_PSA_CRYPTO_C */
745