blob: 73b01624f293ca410ae29e7d1166f94f3830d14d [file] [log] [blame]
Neil Armstronga4cc7d62022-05-25 11:30:48 +02001/*
2 * PSA PAKE layer on top of Mbed TLS software crypto
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.h>
26#include "psa_crypto_core.h"
27#include "psa_crypto_slot_management.h"
28
29#include <mbedtls/ecjpake.h>
30#include <mbedtls/psa_util.h>
31
32#include <mbedtls/platform.h>
33#include <mbedtls/error.h>
34#include <string.h>
35
Neil Armstronga4cc7d62022-05-25 11:30:48 +020036/*
37 * State sequence:
38 *
39 * psa_pake_setup()
40 * |
41 * |-- In any order:
42 * | | psa_pake_set_password_key()
43 * | | psa_pake_set_user()
44 * | | psa_pake_set_peer()
Neil Armstrongc29f8472022-06-08 13:34:49 +020045 * | | psa_pake_set_role()
Neil Armstronga4cc7d62022-05-25 11:30:48 +020046 * |
47 * |--- In any order: (First round input before or after first round output)
48 * | |
49 * | |------ In Order
50 * | | | psa_pake_output(PSA_PAKE_STEP_KEY_SHARE)
51 * | | | psa_pake_output(PSA_PAKE_STEP_ZK_PUBLIC)
52 * | | | psa_pake_output(PSA_PAKE_STEP_ZK_PROOF)
53 * | | | psa_pake_output(PSA_PAKE_STEP_KEY_SHARE)
54 * | | | psa_pake_output(PSA_PAKE_STEP_ZK_PUBLIC)
55 * | | | psa_pake_output(PSA_PAKE_STEP_ZK_PROOF)
56 * | |
57 * | |------ In Order:
58 * | | psa_pake_input(PSA_PAKE_STEP_KEY_SHARE)
59 * | | psa_pake_input(PSA_PAKE_STEP_ZK_PUBLIC)
60 * | | psa_pake_input(PSA_PAKE_STEP_ZK_PROOF)
61 * | | psa_pake_input(PSA_PAKE_STEP_KEY_SHARE)
62 * | | psa_pake_input(PSA_PAKE_STEP_ZK_PUBLIC)
63 * | | psa_pake_input(PSA_PAKE_STEP_ZK_PROOF)
64 * |
65 * |--- In any order: (Second round input before or after second round output)
66 * | |
67 * | |------ In Order
68 * | | | psa_pake_output(PSA_PAKE_STEP_KEY_SHARE)
69 * | | | psa_pake_output(PSA_PAKE_STEP_ZK_PUBLIC)
70 * | | | psa_pake_output(PSA_PAKE_STEP_ZK_PROOF)
71 * | |
72 * | |------ In Order:
73 * | | psa_pake_input(PSA_PAKE_STEP_KEY_SHARE)
74 * | | psa_pake_input(PSA_PAKE_STEP_ZK_PUBLIC)
75 * | | psa_pake_input(PSA_PAKE_STEP_ZK_PROOF)
76 * |
77 * psa_pake_get_implicit_key()
78 * psa_pake_abort()
79 */
80
81enum psa_pake_step
82{
83 PSA_PAKE_STEP_INVALID = 0,
84 PSA_PAKE_STEP_X1_X2 = 1,
85 PSA_PAKE_STEP_X2S = 2,
86 PSA_PAKE_STEP_DERIVE = 3,
87};
88
89enum psa_pake_state
90{
91 PSA_PAKE_STATE_INVALID = 0,
92 PSA_PAKE_STATE_SETUP = 1,
93 PSA_PAKE_STATE_READY = 2,
94 PSA_PAKE_OUTPUT_X1_X2 = 3,
95 PSA_PAKE_OUTPUT_X2S = 4,
96 PSA_PAKE_INPUT_X1_X2 = 5,
97 PSA_PAKE_INPUT_X4S = 6,
98};
99
Neil Armstrongbcd5bd92022-09-05 18:33:23 +0200100/*
101 * The first PAKE step shares the same sequences of the second PAKE step
102 * but with a second set of KEY_SHARE/ZK_PUBLIC/ZK_PROOF outputs/inputs.
Neil Armstrongb39833c2022-09-06 11:36:02 +0200103 * It's simpler to share the same sequences numbers of the first
Neil Armstrongbcd5bd92022-09-05 18:33:23 +0200104 * set of KEY_SHARE/ZK_PUBLIC/ZK_PROOF outputs/inputs in both PAKE steps.
105 *
106 * State sequence with step, state & sequence enums:
107 * => Input & Output Step = PSA_PAKE_STEP_INVALID
108 * => state = PSA_PAKE_STATE_INVALID
109 * psa_pake_setup()
110 * => Input & Output Step = PSA_PAKE_STEP_X1_X2
111 * => state = PSA_PAKE_STATE_SETUP
112 * => sequence = PSA_PAKE_SEQ_INVALID
113 * |
114 * |--- In any order: (First round input before or after first round output)
115 * | | First call of psa_pake_output() or psa_pake_input() sets
116 * | | state = PSA_PAKE_STATE_READY
117 * | |
118 * | |------ In Order: => state = PSA_PAKE_OUTPUT_X1_X2
119 * | | | psa_pake_output() => sequence = PSA_PAKE_X1_STEP_KEY_SHARE
120 * | | | psa_pake_output() => sequence = PSA_PAKE_X1_STEP_ZK_PUBLIC
121 * | | | psa_pake_output() => sequence = PSA_PAKE_X1_STEP_ZK_PROOF
122 * | | | psa_pake_output() => sequence = PSA_PAKE_X2_STEP_KEY_SHARE
123 * | | | psa_pake_output() => sequence = PSA_PAKE_X2_STEP_ZK_PUBLIC
124 * | | | psa_pake_output() => sequence = PSA_PAKE_X2_STEP_ZK_PROOF
125 * | | | => state = PSA_PAKE_STATE_READY
126 * | | | => sequence = PSA_PAKE_SEQ_INVALID
Neil Armstrong9720b882022-09-06 11:39:21 +0200127 * | | | => Output Step = PSA_PAKE_STEP_X2S
Neil Armstrongbcd5bd92022-09-05 18:33:23 +0200128 * | |
129 * | |------ In Order: => state = PSA_PAKE_INPUT_X1_X2
130 * | | | psa_pake_input() => sequence = PSA_PAKE_X1_STEP_KEY_SHARE
131 * | | | psa_pake_input() => sequence = PSA_PAKE_X1_STEP_ZK_PUBLIC
132 * | | | psa_pake_input() => sequence = PSA_PAKE_X1_STEP_ZK_PROOF
133 * | | | psa_pake_input() => sequence = PSA_PAKE_X2_STEP_KEY_SHARE
134 * | | | psa_pake_input() => sequence = PSA_PAKE_X2_STEP_ZK_PUBLIC
135 * | | | psa_pake_input() => sequence = PSA_PAKE_X2_STEP_ZK_PROOF
136 * | | | => state = PSA_PAKE_STATE_READY
137 * | | | => sequence = PSA_PAKE_SEQ_INVALID
Neil Armstrong9720b882022-09-06 11:39:21 +0200138 * | | | => Output Step = PSA_PAKE_INPUT_X4S
Neil Armstrongbcd5bd92022-09-05 18:33:23 +0200139 * |
140 * |--- In any order: (Second round input before or after second round output)
141 * | |
142 * | |------ In Order: => state = PSA_PAKE_OUTPUT_X2S
143 * | | | psa_pake_output() => sequence = PSA_PAKE_X1_STEP_KEY_SHARE
144 * | | | psa_pake_output() => sequence = PSA_PAKE_X1_STEP_ZK_PUBLIC
145 * | | | psa_pake_output() => sequence = PSA_PAKE_X1_STEP_ZK_PROOF
146 * | | | => state = PSA_PAKE_STATE_READY
147 * | | | => sequence = PSA_PAKE_SEQ_INVALID
Neil Armstrong9720b882022-09-06 11:39:21 +0200148 * | | | => Output Step = PSA_PAKE_STEP_DERIVE
Neil Armstrongbcd5bd92022-09-05 18:33:23 +0200149 * | |
150 * | |------ In Order: => state = PSA_PAKE_INPUT_X4S
151 * | | | psa_pake_input() => sequence = PSA_PAKE_X1_STEP_KEY_SHARE
152 * | | | psa_pake_input() => sequence = PSA_PAKE_X1_STEP_ZK_PUBLIC
153 * | | | psa_pake_input() => sequence = PSA_PAKE_X1_STEP_ZK_PROOF
154 * | | | => state = PSA_PAKE_STATE_READY
155 * | | | => sequence = PSA_PAKE_SEQ_INVALID
Neil Armstrong9720b882022-09-06 11:39:21 +0200156 * | | | => Output Step = PSA_PAKE_STEP_DERIVE
Neil Armstrongbcd5bd92022-09-05 18:33:23 +0200157 * |
158 * psa_pake_get_implicit_key()
159 * => Input & Output Step = PSA_PAKE_STEP_INVALID
160 */
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200161enum psa_pake_sequence
162{
163 PSA_PAKE_SEQ_INVALID = 0,
164 PSA_PAKE_X1_STEP_KEY_SHARE = 1, /* also X2S & X4S KEY_SHARE */
165 PSA_PAKE_X1_STEP_ZK_PUBLIC = 2, /* also X2S & X4S ZK_PUBLIC */
166 PSA_PAKE_X1_STEP_ZK_PROOF = 3, /* also X2S & X4S ZK_PROOF */
167 PSA_PAKE_X2_STEP_KEY_SHARE = 4,
168 PSA_PAKE_X2_STEP_ZK_PUBLIC = 5,
169 PSA_PAKE_X2_STEP_ZK_PROOF = 6,
170 PSA_PAKE_SEQ_END = 7,
171};
172
Neil Armstrongdb05cbf2022-06-15 15:25:45 +0200173#if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
174static psa_status_t mbedtls_ecjpake_to_psa_error( int ret )
175{
176 switch( ret )
177 {
178 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
179 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
180 case MBEDTLS_ERR_ECP_INVALID_KEY:
181 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
182 return( PSA_ERROR_DATA_INVALID );
183 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
184 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
185 return( PSA_ERROR_BUFFER_TOO_SMALL );
186 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
187 return( PSA_ERROR_NOT_SUPPORTED );
188 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
189 return( PSA_ERROR_CORRUPTION_DETECTED );
190 default:
191 return( PSA_ERROR_GENERIC_ERROR );
192 }
193}
194#endif
195
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200196#if defined(MBEDTLS_PSA_BUILTIN_PAKE)
197psa_status_t psa_pake_setup( psa_pake_operation_t *operation,
198 const psa_pake_cipher_suite_t *cipher_suite)
199{
200 /* A context must be freshly initialized before it can be set up. */
Neil Armstrongcb679f22022-09-13 14:43:07 +0200201 if( operation->alg != PSA_ALG_NONE )
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200202 return( PSA_ERROR_BAD_STATE );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200203
204 if( cipher_suite == NULL ||
205 PSA_ALG_IS_PAKE(cipher_suite->algorithm ) == 0 ||
206 ( cipher_suite->type != PSA_PAKE_PRIMITIVE_TYPE_ECC &&
207 cipher_suite->type != PSA_PAKE_PRIMITIVE_TYPE_DH ) ||
208 PSA_ALG_IS_HASH( cipher_suite->hash ) == 0 )
209 {
210 return( PSA_ERROR_INVALID_ARGUMENT );
211 }
212
Neil Armstronga557cb82022-06-10 08:58:32 +0200213#if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200214 if( cipher_suite->algorithm == PSA_ALG_JPAKE )
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200215 {
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200216 if( cipher_suite->type != PSA_PAKE_PRIMITIVE_TYPE_ECC ||
217 cipher_suite->family != PSA_ECC_FAMILY_SECP_R1 ||
218 cipher_suite->bits != 256 ||
219 cipher_suite->hash != PSA_ALG_SHA_256 )
220 {
221 return( PSA_ERROR_NOT_SUPPORTED );
222 }
223
224 operation->alg = cipher_suite->algorithm;
225
226 mbedtls_ecjpake_init( &operation->ctx.ecjpake );
227
228 operation->state = PSA_PAKE_STATE_SETUP;
229 operation->sequence = PSA_PAKE_SEQ_INVALID;
230 operation->input_step = PSA_PAKE_STEP_X1_X2;
231 operation->output_step = PSA_PAKE_STEP_X1_X2;
232
Neil Armstrongecb221b2022-09-08 11:21:07 +0200233 mbedtls_platform_zeroize( operation->buffer, PSA_PAKE_BUFFER_SIZE );
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200234 operation->buffer_length = 0;
235 operation->buffer_offset = 0;
236
237 return( PSA_SUCCESS );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200238 }
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200239 else
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200240#endif
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200241 return( PSA_ERROR_NOT_SUPPORTED );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200242}
243
244psa_status_t psa_pake_set_password_key( psa_pake_operation_t *operation,
245 mbedtls_svc_key_id_t password )
246{
247 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
248 psa_key_attributes_t attributes = psa_key_attributes_init();
249 psa_key_type_t type;
250 psa_key_usage_t usage;
251
Neil Armstrongcb679f22022-09-13 14:43:07 +0200252 if( operation->alg == PSA_ALG_NONE ||
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200253 operation->state != PSA_PAKE_STATE_SETUP )
254 {
255 return( PSA_ERROR_BAD_STATE );
256 }
257
258 status = psa_get_key_attributes( password, &attributes );
259 if( status != PSA_SUCCESS )
Neil Armstronge9231112022-06-10 09:03:41 +0200260 return( status );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200261
262 type = psa_get_key_type( &attributes );
263 usage = psa_get_key_usage_flags( &attributes );
264
265 psa_reset_key_attributes( &attributes );
266
267 if( type != PSA_KEY_TYPE_PASSWORD &&
268 type != PSA_KEY_TYPE_PASSWORD_HASH )
269 {
Neil Armstronge9231112022-06-10 09:03:41 +0200270 return( PSA_ERROR_INVALID_ARGUMENT );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200271 }
272
Neil Armstrongdf598ab2022-06-08 17:17:08 +0200273 if( ( usage & PSA_KEY_USAGE_DERIVE ) == 0 )
Neil Armstronge9231112022-06-10 09:03:41 +0200274 return( PSA_ERROR_NOT_PERMITTED );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200275
276 operation->password = password;
277
278 return( PSA_SUCCESS );
279}
280
281psa_status_t psa_pake_set_user( psa_pake_operation_t *operation,
282 const uint8_t *user_id,
283 size_t user_id_len )
284{
Neil Armstrongcb679f22022-09-13 14:43:07 +0200285 if( operation->alg == PSA_ALG_NONE ||
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200286 operation->state != PSA_PAKE_STATE_SETUP )
287 {
288 return( PSA_ERROR_BAD_STATE );
289 }
290
291 if( user_id_len == 0 || user_id == NULL )
Neil Armstronge9231112022-06-10 09:03:41 +0200292 return( PSA_ERROR_INVALID_ARGUMENT );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200293
294 return( PSA_ERROR_NOT_SUPPORTED );
295}
296
297psa_status_t psa_pake_set_peer( psa_pake_operation_t *operation,
298 const uint8_t *peer_id,
299 size_t peer_id_len )
300{
Neil Armstrongcb679f22022-09-13 14:43:07 +0200301 if( operation->alg == PSA_ALG_NONE ||
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200302 operation->state != PSA_PAKE_STATE_SETUP )
303 {
304 return( PSA_ERROR_BAD_STATE );
305 }
306
307 if( peer_id_len == 0 || peer_id == NULL )
Neil Armstronge9231112022-06-10 09:03:41 +0200308 return( PSA_ERROR_INVALID_ARGUMENT );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200309
310 return( PSA_ERROR_NOT_SUPPORTED );
311}
312
313psa_status_t psa_pake_set_role( psa_pake_operation_t *operation,
314 psa_pake_role_t role )
315{
Neil Armstrongcb679f22022-09-13 14:43:07 +0200316 if( operation->alg == PSA_ALG_NONE ||
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200317 operation->state != PSA_PAKE_STATE_SETUP )
318 {
319 return( PSA_ERROR_BAD_STATE );
320 }
321
322 if( role != PSA_PAKE_ROLE_NONE &&
323 role != PSA_PAKE_ROLE_FIRST &&
324 role != PSA_PAKE_ROLE_SECOND &&
325 role != PSA_PAKE_ROLE_CLIENT &&
326 role != PSA_PAKE_ROLE_SERVER )
327 {
Neil Armstronge9231112022-06-10 09:03:41 +0200328 return( PSA_ERROR_INVALID_ARGUMENT );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200329 }
330
Neil Armstronga557cb82022-06-10 08:58:32 +0200331#if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200332 if( operation->alg == PSA_ALG_JPAKE )
333 {
334 if( role != PSA_PAKE_ROLE_CLIENT &&
335 role != PSA_PAKE_ROLE_SERVER )
Neil Armstronge9231112022-06-10 09:03:41 +0200336 return( PSA_ERROR_NOT_SUPPORTED );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200337
338 operation->role = role;
339
340 return( PSA_SUCCESS );
341 }
342 else
343#endif
344 return( PSA_ERROR_NOT_SUPPORTED );
345}
346
Neil Armstronga557cb82022-06-10 08:58:32 +0200347#if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200348static psa_status_t psa_pake_ecjpake_setup( psa_pake_operation_t *operation )
349{
350 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
351 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
352 mbedtls_ecjpake_role role;
353 psa_key_slot_t *slot = NULL;
354
355 if( operation->role == PSA_PAKE_ROLE_CLIENT )
356 role = MBEDTLS_ECJPAKE_CLIENT;
357 else if( operation->role == PSA_PAKE_ROLE_SERVER )
358 role = MBEDTLS_ECJPAKE_SERVER;
359 else
360 return( PSA_ERROR_BAD_STATE );
361
362 if( psa_is_valid_key_id( operation->password, 1 ) == 0 )
363 return( PSA_ERROR_BAD_STATE );
364
365 status = psa_get_and_lock_key_slot( operation->password, &slot );
366 if( status != PSA_SUCCESS )
367 return( status );
368
369
370 ret = mbedtls_ecjpake_setup( &operation->ctx.ecjpake,
371 role,
372 MBEDTLS_MD_SHA256,
373 MBEDTLS_ECP_DP_SECP256R1,
374 slot->key.data, slot->key.bytes );
375
376 psa_unlock_key_slot( slot );
377 slot = NULL;
378
379 if( ret != 0 )
Neil Armstrongdb05cbf2022-06-15 15:25:45 +0200380 return( mbedtls_ecjpake_to_psa_error( ret ) );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200381
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200382 operation->state = PSA_PAKE_STATE_READY;
383
384 return( PSA_SUCCESS );
385}
386#endif
387
388psa_status_t psa_pake_output( psa_pake_operation_t *operation,
389 psa_pake_step_t step,
390 uint8_t *output,
391 size_t output_size,
392 size_t *output_length )
393{
394 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
395 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
396 size_t length;
397
Neil Armstrongcb679f22022-09-13 14:43:07 +0200398 if( operation->alg == PSA_ALG_NONE ||
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200399 operation->state == PSA_PAKE_STATE_INVALID )
400 return( PSA_ERROR_BAD_STATE );
401
Neil Armstrong0d001ef2022-06-08 17:42:52 +0200402 if( output == NULL || output_size == 0 || output_length == NULL )
403 return( PSA_ERROR_INVALID_ARGUMENT );
404
Neil Armstronga557cb82022-06-10 08:58:32 +0200405#if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200406 if( operation->alg == PSA_ALG_JPAKE )
407 {
Neil Armstrong3d4966a2022-09-13 14:54:15 +0200408 if( step != PSA_PAKE_STEP_KEY_SHARE &&
409 step != PSA_PAKE_STEP_ZK_PUBLIC &&
410 step != PSA_PAKE_STEP_ZK_PROOF )
411 return( PSA_ERROR_INVALID_ARGUMENT );
412
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200413 if( operation->state == PSA_PAKE_STATE_SETUP ) {
414 status = psa_pake_ecjpake_setup( operation );
415 if( status != PSA_SUCCESS )
416 {
417 psa_pake_abort( operation );
418 return( status );
419 }
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200420 }
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200421
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200422 if( operation->state != PSA_PAKE_STATE_READY &&
423 operation->state != PSA_PAKE_OUTPUT_X1_X2 &&
424 operation->state != PSA_PAKE_OUTPUT_X2S )
425 {
426 return( PSA_ERROR_BAD_STATE );
427 }
428
429 if( operation->state == PSA_PAKE_STATE_READY )
430 {
431 if( step != PSA_PAKE_STEP_KEY_SHARE )
432 return( PSA_ERROR_BAD_STATE );
433
434 switch( operation->output_step )
435 {
436 case PSA_PAKE_STEP_X1_X2:
437 operation->state = PSA_PAKE_OUTPUT_X1_X2;
438 break;
439 case PSA_PAKE_STEP_X2S:
440 operation->state = PSA_PAKE_OUTPUT_X2S;
441 break;
442 default:
443 return( PSA_ERROR_BAD_STATE );
444 }
445
446 operation->sequence = PSA_PAKE_X1_STEP_KEY_SHARE;
447 }
448
449 /* Check if step matches current sequence */
450 switch( operation->sequence )
451 {
452 case PSA_PAKE_X1_STEP_KEY_SHARE:
453 case PSA_PAKE_X2_STEP_KEY_SHARE:
454 if( step != PSA_PAKE_STEP_KEY_SHARE )
455 return( PSA_ERROR_BAD_STATE );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200456 break;
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200457
458 case PSA_PAKE_X1_STEP_ZK_PUBLIC:
459 case PSA_PAKE_X2_STEP_ZK_PUBLIC:
460 if( step != PSA_PAKE_STEP_ZK_PUBLIC )
461 return( PSA_ERROR_BAD_STATE );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200462 break;
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200463
464 case PSA_PAKE_X1_STEP_ZK_PROOF:
465 case PSA_PAKE_X2_STEP_ZK_PROOF:
466 if( step != PSA_PAKE_STEP_ZK_PROOF )
467 return( PSA_ERROR_BAD_STATE );
468 break;
469
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200470 default:
471 return( PSA_ERROR_BAD_STATE );
472 }
473
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200474 /* Initialize & write round on KEY_SHARE sequences */
475 if( operation->state == PSA_PAKE_OUTPUT_X1_X2 &&
476 operation->sequence == PSA_PAKE_X1_STEP_KEY_SHARE )
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200477 {
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200478 ret = mbedtls_ecjpake_write_round_one( &operation->ctx.ecjpake,
479 operation->buffer,
480 PSA_PAKE_BUFFER_SIZE,
481 &operation->buffer_length,
482 mbedtls_psa_get_random,
483 MBEDTLS_PSA_RANDOM_STATE );
484 if( ret != 0 )
485 {
486 psa_pake_abort( operation );
Neil Armstrongdb05cbf2022-06-15 15:25:45 +0200487 return( mbedtls_ecjpake_to_psa_error( ret ) );
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200488 }
489
490 operation->buffer_offset = 0;
491 }
492 else if( operation->state == PSA_PAKE_OUTPUT_X2S &&
493 operation->sequence == PSA_PAKE_X1_STEP_KEY_SHARE )
494 {
495 ret = mbedtls_ecjpake_write_round_two( &operation->ctx.ecjpake,
496 operation->buffer,
497 PSA_PAKE_BUFFER_SIZE,
498 &operation->buffer_length,
499 mbedtls_psa_get_random,
500 MBEDTLS_PSA_RANDOM_STATE );
501 if( ret != 0 )
502 {
503 psa_pake_abort( operation );
Neil Armstrongdb05cbf2022-06-15 15:25:45 +0200504 return( mbedtls_ecjpake_to_psa_error( ret ) );
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200505 }
506
507 operation->buffer_offset = 0;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200508 }
509
Neil Armstrong1d0294f2022-09-13 14:49:24 +0200510 /*
511 * Steps sequences are stored as:
512 * struct {
513 * opaque point <1..2^8-1>;
514 * } ECPoint;
515 *
516 * Where byte 0 stores the ECPoint curve point length.
517 *
518 * The sequence length is equal to:
519 * - data length extracted from byte 0
520 * - byte 0 size (1)
521 */
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200522 if( operation->state == PSA_PAKE_OUTPUT_X2S &&
523 operation->sequence == PSA_PAKE_X1_STEP_KEY_SHARE )
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200524 {
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200525 if( operation->role == PSA_PAKE_ROLE_SERVER )
Neil Armstrong1d0294f2022-09-13 14:49:24 +0200526 /*
527 * The X2S KEY SHARE Server steps sequence is stored as:
528 * struct {
529 * ECPoint X;
530 * opaque r <1..2^8-1>;
531 * } ECSchnorrZKP;
532 *
533 * And MbedTLS uses a 3 bytes Ephemeral public key ECPoint,
534 * so byte 3 stores the r Schnorr signature length.
535 *
536 * The sequence length is equal to:
537 * - curve storage size (3)
538 * - data length extracted from byte 3
539 * - byte 3 size (1)
540 */
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200541 length = 3 + operation->buffer[3] + 1;
542 else
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200543 length = operation->buffer[0] + 1;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200544 }
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200545 else
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200546 length = operation->buffer[operation->buffer_offset] + 1;
547
548 if( length > operation->buffer_length )
549 return( PSA_ERROR_DATA_CORRUPT );
550
551 if( output_size < length )
552 {
553 psa_pake_abort( operation );
554 return( PSA_ERROR_BUFFER_TOO_SMALL );
555 }
556
557 memcpy( output,
558 operation->buffer + operation->buffer_offset,
559 length );
560 *output_length = length;
561
562 operation->buffer_offset += length;
563
564 /* Reset buffer after ZK_PROOF sequence */
565 if( ( operation->state == PSA_PAKE_OUTPUT_X1_X2 &&
566 operation->sequence == PSA_PAKE_X2_STEP_ZK_PROOF ) ||
567 ( operation->state == PSA_PAKE_OUTPUT_X2S &&
568 operation->sequence == PSA_PAKE_X1_STEP_ZK_PROOF ) )
569 {
570 mbedtls_platform_zeroize( operation->buffer, PSA_PAKE_BUFFER_SIZE );
571 operation->buffer_length = 0;
572 operation->buffer_offset = 0;
573
574 operation->state = PSA_PAKE_STATE_READY;
575 operation->output_step++;
Neil Armstrongcb679f22022-09-13 14:43:07 +0200576 operation->sequence = PSA_PAKE_SEQ_INVALID;
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200577 }
578 else
579 operation->sequence++;
580
581 return( PSA_SUCCESS );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200582 }
583 else
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200584#endif
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200585 return( PSA_ERROR_NOT_SUPPORTED );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200586}
587
588psa_status_t psa_pake_input( psa_pake_operation_t *operation,
589 psa_pake_step_t step,
590 const uint8_t *input,
591 size_t input_length )
592{
593 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
594 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
595 size_t buffer_remain;
596
Neil Armstrongcb679f22022-09-13 14:43:07 +0200597 if( operation->alg == PSA_ALG_NONE ||
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200598 operation->state == PSA_PAKE_STATE_INVALID )
599 return( PSA_ERROR_BAD_STATE );
600
Neil Armstrong0d001ef2022-06-08 17:42:52 +0200601 if( input == NULL || input_length == 0 )
602 return( PSA_ERROR_INVALID_ARGUMENT );
603
Neil Armstronga557cb82022-06-10 08:58:32 +0200604#if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200605 if( operation->alg == PSA_ALG_JPAKE )
606 {
Neil Armstrong3d4966a2022-09-13 14:54:15 +0200607 if( step != PSA_PAKE_STEP_KEY_SHARE &&
608 step != PSA_PAKE_STEP_ZK_PUBLIC &&
609 step != PSA_PAKE_STEP_ZK_PROOF )
610 return( PSA_ERROR_INVALID_ARGUMENT );
611
Neil Armstrong5bbdb702022-09-05 17:54:15 +0200612 if( operation->state == PSA_PAKE_STATE_SETUP )
613 {
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200614 status = psa_pake_ecjpake_setup( operation );
615 if( status != PSA_SUCCESS )
616 {
617 psa_pake_abort( operation );
618 return( status );
619 }
620 }
621
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200622 if( operation->state != PSA_PAKE_STATE_READY &&
623 operation->state != PSA_PAKE_INPUT_X1_X2 &&
624 operation->state != PSA_PAKE_INPUT_X4S )
625 {
626 return( PSA_ERROR_BAD_STATE );
627 }
628
629 if( operation->state == PSA_PAKE_STATE_READY )
630 {
631 if( step != PSA_PAKE_STEP_KEY_SHARE )
632 return( PSA_ERROR_BAD_STATE );
633
634 switch( operation->input_step )
635 {
636 case PSA_PAKE_STEP_X1_X2:
637 operation->state = PSA_PAKE_INPUT_X1_X2;
638 break;
639 case PSA_PAKE_STEP_X2S:
640 operation->state = PSA_PAKE_INPUT_X4S;
641 break;
642 default:
643 return( PSA_ERROR_BAD_STATE );
644 }
645
646 operation->sequence = PSA_PAKE_X1_STEP_KEY_SHARE;
647 }
648
649 buffer_remain = PSA_PAKE_BUFFER_SIZE - operation->buffer_length;
650
651 if( input_length == 0 ||
652 input_length > buffer_remain )
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200653 {
654 psa_pake_abort( operation );
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200655 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200656 }
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200657
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200658 /* Check if step matches current sequence */
659 switch( operation->sequence )
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200660 {
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200661 case PSA_PAKE_X1_STEP_KEY_SHARE:
662 case PSA_PAKE_X2_STEP_KEY_SHARE:
663 if( step != PSA_PAKE_STEP_KEY_SHARE )
664 return( PSA_ERROR_BAD_STATE );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200665 break;
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200666
667 case PSA_PAKE_X1_STEP_ZK_PUBLIC:
668 case PSA_PAKE_X2_STEP_ZK_PUBLIC:
669 if( step != PSA_PAKE_STEP_ZK_PUBLIC )
670 return( PSA_ERROR_BAD_STATE );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200671 break;
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200672
673 case PSA_PAKE_X1_STEP_ZK_PROOF:
674 case PSA_PAKE_X2_STEP_ZK_PROOF:
675 if( step != PSA_PAKE_STEP_ZK_PROOF )
676 return( PSA_ERROR_BAD_STATE );
677 break;
678
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200679 default:
680 return( PSA_ERROR_BAD_STATE );
681 }
682
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200683 /* Copy input to local buffer */
684 memcpy( operation->buffer + operation->buffer_length,
685 input, input_length );
686 operation->buffer_length += input_length;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200687
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200688 /* Load buffer at each last round ZK_PROOF */
689 if( operation->state == PSA_PAKE_INPUT_X1_X2 &&
690 operation->sequence == PSA_PAKE_X2_STEP_ZK_PROOF )
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200691 {
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200692 ret = mbedtls_ecjpake_read_round_one( &operation->ctx.ecjpake,
693 operation->buffer,
694 operation->buffer_length );
695
696 mbedtls_platform_zeroize( operation->buffer, PSA_PAKE_BUFFER_SIZE );
697 operation->buffer_length = 0;
698
699 if( ret != 0 )
700 {
701 psa_pake_abort( operation );
Neil Armstrongdb05cbf2022-06-15 15:25:45 +0200702 return( mbedtls_ecjpake_to_psa_error( ret ) );
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200703 }
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200704 }
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200705 else if( operation->state == PSA_PAKE_INPUT_X4S &&
706 operation->sequence == PSA_PAKE_X1_STEP_ZK_PROOF )
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200707 {
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200708 ret = mbedtls_ecjpake_read_round_two( &operation->ctx.ecjpake,
709 operation->buffer,
710 operation->buffer_length );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200711
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200712 mbedtls_platform_zeroize( operation->buffer, PSA_PAKE_BUFFER_SIZE );
713 operation->buffer_length = 0;
714
715 if( ret != 0 )
716 {
717 psa_pake_abort( operation );
Neil Armstrongdb05cbf2022-06-15 15:25:45 +0200718 return( mbedtls_ecjpake_to_psa_error( ret ) );
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200719 }
720 }
721
722 if( ( operation->state == PSA_PAKE_INPUT_X1_X2 &&
723 operation->sequence == PSA_PAKE_X2_STEP_ZK_PROOF ) ||
724 ( operation->state == PSA_PAKE_INPUT_X4S &&
725 operation->sequence == PSA_PAKE_X1_STEP_ZK_PROOF ) )
726 {
727 operation->state = PSA_PAKE_STATE_READY;
728 operation->input_step++;
Neil Armstrongcb679f22022-09-13 14:43:07 +0200729 operation->sequence = PSA_PAKE_SEQ_INVALID;
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200730 }
731 else
732 operation->sequence++;
733
734 return( PSA_SUCCESS );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200735 }
736 else
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200737#endif
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200738 return( PSA_ERROR_NOT_SUPPORTED );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200739}
740
741psa_status_t psa_pake_get_implicit_key(psa_pake_operation_t *operation,
742 psa_key_derivation_operation_t *output)
743{
744 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
745 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
746
Neil Armstrongcb679f22022-09-13 14:43:07 +0200747 if( operation->alg == PSA_ALG_NONE ||
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200748 operation->state != PSA_PAKE_STATE_READY ||
Neil Armstrong1e855602022-06-15 11:32:11 +0200749 operation->input_step != PSA_PAKE_STEP_DERIVE ||
750 operation->output_step != PSA_PAKE_STEP_DERIVE )
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200751 return( PSA_ERROR_BAD_STATE );
752
Neil Armstronga557cb82022-06-10 08:58:32 +0200753#if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200754 if( operation->alg == PSA_ALG_JPAKE )
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200755 {
Neil Armstrongf19a3cb2022-06-15 16:00:29 +0200756 ret = mbedtls_ecjpake_write_shared_key( &operation->ctx.ecjpake,
757 operation->buffer,
758 PSA_PAKE_BUFFER_SIZE,
759 &operation->buffer_length,
760 mbedtls_psa_get_random,
761 MBEDTLS_PSA_RANDOM_STATE );
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200762 if( ret != 0)
763 {
764 psa_pake_abort( operation );
Neil Armstrongdb05cbf2022-06-15 15:25:45 +0200765 return( mbedtls_ecjpake_to_psa_error( ret ) );
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200766 }
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200767
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200768 status = psa_key_derivation_input_bytes( output,
769 PSA_KEY_DERIVATION_INPUT_SECRET,
770 operation->buffer,
771 operation->buffer_length );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200772
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200773 mbedtls_platform_zeroize( operation->buffer, PSA_PAKE_BUFFER_SIZE );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200774
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200775 psa_pake_abort( operation );
776
777 return( status );
778 }
779 else
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200780#endif
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200781 return( PSA_ERROR_NOT_SUPPORTED );
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200782}
783
784psa_status_t psa_pake_abort(psa_pake_operation_t * operation)
785{
Neil Armstrongcb679f22022-09-13 14:43:07 +0200786 if( operation->alg == PSA_ALG_NONE )
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200787 {
788 return( PSA_SUCCESS );
789 }
790
Neil Armstronga557cb82022-06-10 08:58:32 +0200791#if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200792 if( operation->alg == PSA_ALG_JPAKE )
793 {
Neil Armstrongcb679f22022-09-13 14:43:07 +0200794 operation->input_step = PSA_PAKE_STEP_INVALID;
795 operation->output_step = PSA_PAKE_STEP_INVALID;
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200796 operation->password = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcb679f22022-09-13 14:43:07 +0200797 operation->role = PSA_PAKE_ROLE_NONE;
Neil Armstrongecb221b2022-09-08 11:21:07 +0200798 mbedtls_platform_zeroize( operation->buffer, PSA_PAKE_BUFFER_SIZE );
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200799 operation->buffer_length = 0;
800 operation->buffer_offset = 0;
801 mbedtls_ecjpake_free( &operation->ctx.ecjpake );
802 }
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200803#endif
804
Neil Armstrongcb679f22022-09-13 14:43:07 +0200805 operation->alg = PSA_ALG_NONE;
806 operation->state = PSA_PAKE_STATE_INVALID;
807 operation->sequence = PSA_PAKE_SEQ_INVALID;
Neil Armstrongfbc4b4a2022-06-10 08:54:53 +0200808
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200809 return( PSA_SUCCESS );
810}
811
812#endif /* MBEDTLS_PSA_BUILTIN_PAKE */
813
814#endif /* MBEDTLS_PSA_CRYPTO_C */