blob: 01998a6d535d418def01649388491000bc1119a8 [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"
Neil Armstrong56b8d232022-06-01 18:05:57 +020027#include "psa_crypto_pake.h"
Neil Armstronga4cc7d62022-05-25 11:30:48 +020028#include "psa_crypto_slot_management.h"
29
30#include <mbedtls/ecjpake.h>
31#include <mbedtls/psa_util.h>
32
33#include <mbedtls/platform.h>
34#include <mbedtls/error.h>
35#include <string.h>
36
Neil Armstronga4cc7d62022-05-25 11:30:48 +020037/*
38 * State sequence:
39 *
40 * psa_pake_setup()
41 * |
42 * |-- In any order:
43 * | | psa_pake_set_password_key()
44 * | | psa_pake_set_user()
45 * | | psa_pake_set_peer()
Neil Armstrongc29f8472022-06-08 13:34:49 +020046 * | | psa_pake_set_role()
Neil Armstronga4cc7d62022-05-25 11:30:48 +020047 * |
48 * |--- In any order: (First round input before or after first round output)
49 * | |
50 * | |------ In Order
51 * | | | psa_pake_output(PSA_PAKE_STEP_KEY_SHARE)
52 * | | | psa_pake_output(PSA_PAKE_STEP_ZK_PUBLIC)
53 * | | | psa_pake_output(PSA_PAKE_STEP_ZK_PROOF)
54 * | | | psa_pake_output(PSA_PAKE_STEP_KEY_SHARE)
55 * | | | psa_pake_output(PSA_PAKE_STEP_ZK_PUBLIC)
56 * | | | psa_pake_output(PSA_PAKE_STEP_ZK_PROOF)
57 * | |
58 * | |------ In Order:
59 * | | psa_pake_input(PSA_PAKE_STEP_KEY_SHARE)
60 * | | psa_pake_input(PSA_PAKE_STEP_ZK_PUBLIC)
61 * | | psa_pake_input(PSA_PAKE_STEP_ZK_PROOF)
62 * | | psa_pake_input(PSA_PAKE_STEP_KEY_SHARE)
63 * | | psa_pake_input(PSA_PAKE_STEP_ZK_PUBLIC)
64 * | | psa_pake_input(PSA_PAKE_STEP_ZK_PROOF)
65 * |
66 * |--- In any order: (Second round input before or after second round output)
67 * | |
68 * | |------ In Order
69 * | | | psa_pake_output(PSA_PAKE_STEP_KEY_SHARE)
70 * | | | psa_pake_output(PSA_PAKE_STEP_ZK_PUBLIC)
71 * | | | psa_pake_output(PSA_PAKE_STEP_ZK_PROOF)
72 * | |
73 * | |------ In Order:
74 * | | psa_pake_input(PSA_PAKE_STEP_KEY_SHARE)
75 * | | psa_pake_input(PSA_PAKE_STEP_ZK_PUBLIC)
76 * | | psa_pake_input(PSA_PAKE_STEP_ZK_PROOF)
77 * |
78 * psa_pake_get_implicit_key()
79 * psa_pake_abort()
80 */
81
Neil Armstrongbcd5bd92022-09-05 18:33:23 +020082/*
83 * The first PAKE step shares the same sequences of the second PAKE step
84 * but with a second set of KEY_SHARE/ZK_PUBLIC/ZK_PROOF outputs/inputs.
Neil Armstrongb39833c2022-09-06 11:36:02 +020085 * It's simpler to share the same sequences numbers of the first
Neil Armstrongbcd5bd92022-09-05 18:33:23 +020086 * set of KEY_SHARE/ZK_PUBLIC/ZK_PROOF outputs/inputs in both PAKE steps.
87 *
88 * State sequence with step, state & sequence enums:
89 * => Input & Output Step = PSA_PAKE_STEP_INVALID
90 * => state = PSA_PAKE_STATE_INVALID
91 * psa_pake_setup()
92 * => Input & Output Step = PSA_PAKE_STEP_X1_X2
93 * => state = PSA_PAKE_STATE_SETUP
94 * => sequence = PSA_PAKE_SEQ_INVALID
95 * |
96 * |--- In any order: (First round input before or after first round output)
97 * | | First call of psa_pake_output() or psa_pake_input() sets
98 * | | state = PSA_PAKE_STATE_READY
99 * | |
100 * | |------ In Order: => state = PSA_PAKE_OUTPUT_X1_X2
101 * | | | psa_pake_output() => sequence = PSA_PAKE_X1_STEP_KEY_SHARE
102 * | | | psa_pake_output() => sequence = PSA_PAKE_X1_STEP_ZK_PUBLIC
103 * | | | psa_pake_output() => sequence = PSA_PAKE_X1_STEP_ZK_PROOF
104 * | | | psa_pake_output() => sequence = PSA_PAKE_X2_STEP_KEY_SHARE
105 * | | | psa_pake_output() => sequence = PSA_PAKE_X2_STEP_ZK_PUBLIC
106 * | | | psa_pake_output() => sequence = PSA_PAKE_X2_STEP_ZK_PROOF
107 * | | | => state = PSA_PAKE_STATE_READY
108 * | | | => sequence = PSA_PAKE_SEQ_INVALID
Neil Armstrong9720b882022-09-06 11:39:21 +0200109 * | | | => Output Step = PSA_PAKE_STEP_X2S
Neil Armstrongbcd5bd92022-09-05 18:33:23 +0200110 * | |
111 * | |------ In Order: => state = PSA_PAKE_INPUT_X1_X2
112 * | | | psa_pake_input() => sequence = PSA_PAKE_X1_STEP_KEY_SHARE
113 * | | | psa_pake_input() => sequence = PSA_PAKE_X1_STEP_ZK_PUBLIC
114 * | | | psa_pake_input() => sequence = PSA_PAKE_X1_STEP_ZK_PROOF
115 * | | | psa_pake_input() => sequence = PSA_PAKE_X2_STEP_KEY_SHARE
116 * | | | psa_pake_input() => sequence = PSA_PAKE_X2_STEP_ZK_PUBLIC
117 * | | | psa_pake_input() => sequence = PSA_PAKE_X2_STEP_ZK_PROOF
118 * | | | => state = PSA_PAKE_STATE_READY
119 * | | | => sequence = PSA_PAKE_SEQ_INVALID
Neil Armstrong9720b882022-09-06 11:39:21 +0200120 * | | | => Output Step = PSA_PAKE_INPUT_X4S
Neil Armstrongbcd5bd92022-09-05 18:33:23 +0200121 * |
122 * |--- In any order: (Second round input before or after second round output)
123 * | |
124 * | |------ In Order: => state = PSA_PAKE_OUTPUT_X2S
125 * | | | psa_pake_output() => sequence = PSA_PAKE_X1_STEP_KEY_SHARE
126 * | | | psa_pake_output() => sequence = PSA_PAKE_X1_STEP_ZK_PUBLIC
127 * | | | psa_pake_output() => sequence = PSA_PAKE_X1_STEP_ZK_PROOF
128 * | | | => state = PSA_PAKE_STATE_READY
129 * | | | => sequence = PSA_PAKE_SEQ_INVALID
Neil Armstrong9720b882022-09-06 11:39:21 +0200130 * | | | => Output Step = PSA_PAKE_STEP_DERIVE
Neil Armstrongbcd5bd92022-09-05 18:33:23 +0200131 * | |
132 * | |------ In Order: => state = PSA_PAKE_INPUT_X4S
133 * | | | psa_pake_input() => sequence = PSA_PAKE_X1_STEP_KEY_SHARE
134 * | | | psa_pake_input() => sequence = PSA_PAKE_X1_STEP_ZK_PUBLIC
135 * | | | psa_pake_input() => sequence = PSA_PAKE_X1_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_STEP_DERIVE
Neil Armstrongbcd5bd92022-09-05 18:33:23 +0200139 * |
140 * psa_pake_get_implicit_key()
141 * => Input & Output Step = PSA_PAKE_STEP_INVALID
142 */
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200143
Neil Armstrongdb05cbf2022-06-15 15:25:45 +0200144#if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100145static psa_status_t mbedtls_ecjpake_to_psa_error(int ret)
Neil Armstrongdb05cbf2022-06-15 15:25:45 +0200146{
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 switch (ret) {
Neil Armstrongdb05cbf2022-06-15 15:25:45 +0200148 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
149 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
150 case MBEDTLS_ERR_ECP_INVALID_KEY:
151 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100152 return PSA_ERROR_DATA_INVALID;
Neil Armstrongdb05cbf2022-06-15 15:25:45 +0200153 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
154 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100155 return PSA_ERROR_BUFFER_TOO_SMALL;
Neil Armstrongdb05cbf2022-06-15 15:25:45 +0200156 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100157 return PSA_ERROR_NOT_SUPPORTED;
Neil Armstrongdb05cbf2022-06-15 15:25:45 +0200158 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 return PSA_ERROR_CORRUPTION_DETECTED;
Neil Armstrongdb05cbf2022-06-15 15:25:45 +0200160 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100161 return PSA_ERROR_GENERIC_ERROR;
Neil Armstrongdb05cbf2022-06-15 15:25:45 +0200162 }
163}
164#endif
165
Neil Armstronga557cb82022-06-10 08:58:32 +0200166#if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
Przemek Stekiel6c764412022-11-22 14:05:12 +0100167static psa_status_t psa_pake_ecjpake_setup(mbedtls_psa_pake_operation_t *operation)
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200168{
169 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200170 mbedtls_ecjpake_role role;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200171
Gilles Peskine449bd832023-01-11 14:50:10 +0100172 if (operation->role == PSA_PAKE_ROLE_CLIENT) {
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200173 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100174 } else if (operation->role == PSA_PAKE_ROLE_SERVER) {
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200175 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +0100176 } else {
177 return PSA_ERROR_BAD_STATE;
178 }
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200179
Gilles Peskine449bd832023-01-11 14:50:10 +0100180 if (operation->password_len == 0) {
181 return PSA_ERROR_BAD_STATE;
182 }
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200183
Przemek Stekiel6c764412022-11-22 14:05:12 +0100184 ret = mbedtls_ecjpake_setup(&operation->ctx.pake,
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 role,
186 MBEDTLS_MD_SHA256,
187 MBEDTLS_ECP_DP_SECP256R1,
188 operation->password,
189 operation->password_len);
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200190
Gilles Peskine449bd832023-01-11 14:50:10 +0100191 mbedtls_platform_zeroize(operation->password, operation->password_len);
192 mbedtls_free(operation->password);
Przemek Stekielad0f3572022-11-21 15:04:37 +0100193 operation->password = NULL;
194 operation->password_len = 0;
195
Gilles Peskine449bd832023-01-11 14:50:10 +0100196 if (ret != 0) {
197 return mbedtls_ecjpake_to_psa_error(ret);
198 }
Przemek Stekiel0bdec192022-11-22 09:10:35 +0100199
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 return PSA_SUCCESS;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200201}
Przemek Stekiele12ed362022-12-21 12:54:46 +0100202
203psa_status_t mbedtls_psa_pake_setup(mbedtls_psa_pake_operation_t *operation,
204 const psa_crypto_driver_pake_inputs_t *inputs)
205{
206 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
207
208 uint8_t *password = inputs->password;
209 size_t password_len = inputs->password_len;
210 psa_pake_role_t role = inputs->role;
211 psa_pake_cipher_suite_t cipher_suite = inputs->cipher_suite;
212
213 memset(operation, 0, sizeof(mbedtls_psa_pake_operation_t));
214
215#if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
216 if (cipher_suite.algorithm == PSA_ALG_JPAKE) {
217 if (cipher_suite.type != PSA_PAKE_PRIMITIVE_TYPE_ECC ||
218 cipher_suite.family != PSA_ECC_FAMILY_SECP_R1 ||
219 cipher_suite.bits != 256 ||
220 cipher_suite.hash != PSA_ALG_SHA_256) {
221 status = PSA_ERROR_NOT_SUPPORTED;
222 goto error;
223 }
224
225 if (role != PSA_PAKE_ROLE_CLIENT &&
226 role != PSA_PAKE_ROLE_SERVER) {
227 status = PSA_ERROR_NOT_SUPPORTED;
228 goto error;
229 }
230
231 mbedtls_ecjpake_init(&operation->ctx.pake);
232
Przemek Stekiel2797d372022-12-22 11:19:22 +0100233 operation->password = mbedtls_calloc(1, password_len);
234 if (operation->password == NULL) {
235 status = PSA_ERROR_INSUFFICIENT_MEMORY;
236 goto error;
237 }
238
239 memcpy(operation->password, password, password_len);
Przemek Stekiele12ed362022-12-21 12:54:46 +0100240 operation->password_len = password_len;
Przemek Stekiele12ed362022-12-21 12:54:46 +0100241 operation->role = role;
242 operation->alg = cipher_suite.algorithm;
243
244 mbedtls_platform_zeroize(operation->buffer, MBEDTLS_PSA_PAKE_BUFFER_SIZE);
245 operation->buffer_length = 0;
246 operation->buffer_offset = 0;
247
248 status = psa_pake_ecjpake_setup(operation);
249
250 if (status != PSA_SUCCESS) {
251 goto error;
252 }
253
254 return PSA_SUCCESS;
255 } else
256#else
257 (void) operation;
258 (void) inputs;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200259#endif
Przemek Stekiele12ed362022-12-21 12:54:46 +0100260 { status = PSA_ERROR_NOT_SUPPORTED; }
261
262error:
Przemek Stekiele12ed362022-12-21 12:54:46 +0100263 mbedtls_psa_pake_abort(operation);
264 return status;
265}
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200266
Neil Armstrong56b8d232022-06-01 18:05:57 +0200267static psa_status_t mbedtls_psa_pake_output_internal(
Przemek Stekiel6c764412022-11-22 14:05:12 +0100268 mbedtls_psa_pake_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 psa_pake_step_t step,
Przemek Stekiele12ed362022-12-21 12:54:46 +0100270 const psa_pake_computation_stage_t *computation_stage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 uint8_t *output,
272 size_t output_size,
273 size_t *output_length)
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200274{
275 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200276 size_t length;
Przemek Stekiele12ed362022-12-21 12:54:46 +0100277 (void) step;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200278
Przemek Stekiel6c764412022-11-22 14:05:12 +0100279 if (operation->alg == PSA_ALG_NONE) {
280 return PSA_ERROR_BAD_STATE;
281 }
282
Neil Armstronga557cb82022-06-10 08:58:32 +0200283#if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
Neil Armstrongfa849622022-09-13 15:10:46 +0200284 /*
285 * The PSA CRYPTO PAKE and MbedTLS JPAKE API have a different
286 * handling of output sequencing.
287 *
Neil Armstrong6a12a772022-09-14 12:17:42 +0200288 * The MbedTLS JPAKE API outputs the whole X1+X2 and X2S steps data
Neil Armstrongfa849622022-09-13 15:10:46 +0200289 * at once, on the other side the PSA CRYPTO PAKE api requires
290 * the KEY_SHARE/ZP_PUBLIC/ZK_PROOF parts of X1, X2 & X2S to be
291 * retrieved in sequence.
292 *
293 * In order to achieve API compatibility, the whole X1+X2 or X2S steps
294 * data is stored in an intermediate buffer at first step output call,
295 * and data is sliced down by parsing the ECPoint records in order
296 * to return the right parts on each step.
297 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiele12ed362022-12-21 12:54:46 +0100299 const psa_jpake_computation_stage_t *jpake_computation_stage =
300 &computation_stage->data.jpake_computation_stage;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200301
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200302 /* Initialize & write round on KEY_SHARE sequences */
Przemek Stekiele12ed362022-12-21 12:54:46 +0100303 if (jpake_computation_stage->state == PSA_PAKE_OUTPUT_X1_X2 &&
304 jpake_computation_stage->sequence == PSA_PAKE_X1_STEP_KEY_SHARE) {
Przemek Stekiel6c764412022-11-22 14:05:12 +0100305 ret = mbedtls_ecjpake_write_round_one(&operation->ctx.pake,
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 operation->buffer,
307 MBEDTLS_PSA_PAKE_BUFFER_SIZE,
308 &operation->buffer_length,
309 mbedtls_psa_get_random,
310 MBEDTLS_PSA_RANDOM_STATE);
311 if (ret != 0) {
312 return mbedtls_ecjpake_to_psa_error(ret);
313 }
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200314
315 operation->buffer_offset = 0;
Przemek Stekiele12ed362022-12-21 12:54:46 +0100316 } else if (jpake_computation_stage->state == PSA_PAKE_OUTPUT_X2S &&
317 jpake_computation_stage->sequence == PSA_PAKE_X1_STEP_KEY_SHARE) {
Przemek Stekiel6c764412022-11-22 14:05:12 +0100318 ret = mbedtls_ecjpake_write_round_two(&operation->ctx.pake,
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 operation->buffer,
320 MBEDTLS_PSA_PAKE_BUFFER_SIZE,
321 &operation->buffer_length,
322 mbedtls_psa_get_random,
323 MBEDTLS_PSA_RANDOM_STATE);
324 if (ret != 0) {
325 return mbedtls_ecjpake_to_psa_error(ret);
326 }
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200327
328 operation->buffer_offset = 0;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200329 }
330
Neil Armstrong1d0294f2022-09-13 14:49:24 +0200331 /*
Manuel Pégourié-Gonnardec7012d2022-10-05 12:17:34 +0200332 * mbedtls_ecjpake_write_round_xxx() outputs thing in the format
333 * defined by draft-cragie-tls-ecjpake-01 section 7. The summary is
334 * that the data for each step is prepended with a length byte, and
335 * then they're concatenated. Additionally, the server's second round
336 * output is prepended with a 3-bytes ECParameters structure.
Neil Armstrong1d0294f2022-09-13 14:49:24 +0200337 *
Manuel Pégourié-Gonnardec7012d2022-10-05 12:17:34 +0200338 * In PSA, we output each step separately, and don't prepend the
339 * output with a length byte, even less a curve identifier, as that
340 * information is already available.
Neil Armstrong1d0294f2022-09-13 14:49:24 +0200341 */
Przemek Stekiele12ed362022-12-21 12:54:46 +0100342 if (jpake_computation_stage->state == PSA_PAKE_OUTPUT_X2S &&
343 jpake_computation_stage->sequence == PSA_PAKE_X1_STEP_KEY_SHARE &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 operation->role == PSA_PAKE_ROLE_SERVER) {
Manuel Pégourié-Gonnardec7012d2022-10-05 12:17:34 +0200345 /* Skip ECParameters, with is 3 bytes (RFC 8422) */
346 operation->buffer_offset += 3;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200347 }
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200348
Manuel Pégourié-Gonnardec7012d2022-10-05 12:17:34 +0200349 /* Read the length byte then move past it to the data */
350 length = operation->buffer[operation->buffer_offset];
351 operation->buffer_offset += 1;
352
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 if (operation->buffer_offset + length > operation->buffer_length) {
354 return PSA_ERROR_DATA_CORRUPT;
355 }
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200356
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 if (output_size < length) {
358 return PSA_ERROR_BUFFER_TOO_SMALL;
359 }
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200360
Gilles Peskine449bd832023-01-11 14:50:10 +0100361 memcpy(output,
362 operation->buffer + operation->buffer_offset,
363 length);
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200364 *output_length = length;
365
366 operation->buffer_offset += length;
367
368 /* Reset buffer after ZK_PROOF sequence */
Przemek Stekiele12ed362022-12-21 12:54:46 +0100369 if ((jpake_computation_stage->state == PSA_PAKE_OUTPUT_X1_X2 &&
370 jpake_computation_stage->sequence == PSA_PAKE_X2_STEP_ZK_PROOF) ||
371 (jpake_computation_stage->state == PSA_PAKE_OUTPUT_X2S &&
372 jpake_computation_stage->sequence == PSA_PAKE_X1_STEP_ZK_PROOF)) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100373 mbedtls_platform_zeroize(operation->buffer, MBEDTLS_PSA_PAKE_BUFFER_SIZE);
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200374 operation->buffer_length = 0;
375 operation->buffer_offset = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100376 }
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200377
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 return PSA_SUCCESS;
379 } else
Neil Armstrong5ae60962022-09-15 11:29:46 +0200380#else
381 (void) step;
Przemek Stekiele12ed362022-12-21 12:54:46 +0100382 (void) computation_stage;
Neil Armstrong5ae60962022-09-15 11:29:46 +0200383 (void) output;
384 (void) output_size;
385 (void) output_length;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200386#endif
Neil Armstrong5ae60962022-09-15 11:29:46 +0200387 { return PSA_ERROR_NOT_SUPPORTED; }
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200388}
389
Przemek Stekiel6c764412022-11-22 14:05:12 +0100390psa_status_t mbedtls_psa_pake_output(mbedtls_psa_pake_operation_t *operation,
Neil Armstrong56b8d232022-06-01 18:05:57 +0200391 psa_pake_step_t step,
Przemek Stekiele12ed362022-12-21 12:54:46 +0100392 const psa_pake_computation_stage_t *computation_stage,
Neil Armstrong56b8d232022-06-01 18:05:57 +0200393 uint8_t *output,
394 size_t output_size,
395 size_t *output_length)
Manuel Pégourié-Gonnardf155ab92022-10-13 13:11:52 +0200396{
Neil Armstrong56b8d232022-06-01 18:05:57 +0200397 psa_status_t status = mbedtls_psa_pake_output_internal(
Przemek Stekiele12ed362022-12-21 12:54:46 +0100398 operation, step, computation_stage, output, output_size, output_length);
Manuel Pégourié-Gonnardf155ab92022-10-13 13:11:52 +0200399
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 if (status != PSA_SUCCESS) {
Przemek Stekiel6c764412022-11-22 14:05:12 +0100401 mbedtls_psa_pake_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 }
Manuel Pégourié-Gonnardf155ab92022-10-13 13:11:52 +0200403
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 return status;
Manuel Pégourié-Gonnardf155ab92022-10-13 13:11:52 +0200405}
406
Neil Armstrong56b8d232022-06-01 18:05:57 +0200407static psa_status_t mbedtls_psa_pake_input_internal(
Przemek Stekiel6c764412022-11-22 14:05:12 +0100408 mbedtls_psa_pake_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +0100409 psa_pake_step_t step,
Przemek Stekiele12ed362022-12-21 12:54:46 +0100410 const psa_pake_computation_stage_t *computation_stage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 const uint8_t *input,
412 size_t input_length)
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200413{
414 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiele12ed362022-12-21 12:54:46 +0100415 (void) step;
Przemek Stekiel6c764412022-11-22 14:05:12 +0100416 if (operation->alg == PSA_ALG_NONE) {
417 return PSA_ERROR_BAD_STATE;
418 }
419
Neil Armstronga557cb82022-06-10 08:58:32 +0200420#if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
Neil Armstrongfa849622022-09-13 15:10:46 +0200421 /*
422 * The PSA CRYPTO PAKE and MbedTLS JPAKE API have a different
423 * handling of input sequencing.
424 *
425 * The MbedTLS JPAKE API takes the whole X1+X2 or X4S steps data
426 * at once as input, on the other side the PSA CRYPTO PAKE api requires
427 * the KEY_SHARE/ZP_PUBLIC/ZK_PROOF parts of X1, X2 & X4S to be
428 * given in sequence.
429 *
430 * In order to achieve API compatibility, each X1+X2 or X4S step data
431 * is stored sequentially in an intermediate buffer and given to the
432 * MbedTLS JPAKE API on the last step.
433 *
434 * This causes any input error to be only detected on the last step.
435 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100436 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiele12ed362022-12-21 12:54:46 +0100437 const psa_jpake_computation_stage_t *jpake_computation_stage =
438 &computation_stage->data.jpake_computation_stage;
Manuel Pégourié-Gonnardec7012d2022-10-05 12:17:34 +0200439 /*
440 * Copy input to local buffer and format it as the Mbed TLS API
441 * expects, i.e. as defined by draft-cragie-tls-ecjpake-01 section 7.
442 * The summary is that the data for each step is prepended with a
443 * length byte, and then they're concatenated. Additionally, the
444 * server's second round output is prepended with a 3-bytes
445 * ECParameters structure - which means we have to prepend that when
446 * we're a client.
447 */
Przemek Stekiele12ed362022-12-21 12:54:46 +0100448 if (jpake_computation_stage->state == PSA_PAKE_INPUT_X4S &&
449 jpake_computation_stage->sequence == PSA_PAKE_X1_STEP_KEY_SHARE &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100450 operation->role == PSA_PAKE_ROLE_CLIENT) {
Manuel Pégourié-Gonnardec7012d2022-10-05 12:17:34 +0200451 /* We only support secp256r1. */
452 /* This is the ECParameters structure defined by RFC 8422. */
453 unsigned char ecparameters[3] = {
454 3, /* named_curve */
455 0, 23 /* secp256r1 */
456 };
Gilles Peskine449bd832023-01-11 14:50:10 +0100457 memcpy(operation->buffer + operation->buffer_length,
458 ecparameters, sizeof(ecparameters));
459 operation->buffer_length += sizeof(ecparameters);
Manuel Pégourié-Gonnardec7012d2022-10-05 12:17:34 +0200460 }
461
462 /* Write the length byte */
Manuel Pégourié-Gonnard0771d412022-10-06 09:30:34 +0200463 operation->buffer[operation->buffer_length] = (uint8_t) input_length;
Manuel Pégourié-Gonnardec7012d2022-10-05 12:17:34 +0200464 operation->buffer_length += 1;
465
466 /* Finally copy the data */
Gilles Peskine449bd832023-01-11 14:50:10 +0100467 memcpy(operation->buffer + operation->buffer_length,
468 input, input_length);
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200469 operation->buffer_length += input_length;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200470
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200471 /* Load buffer at each last round ZK_PROOF */
Przemek Stekiele12ed362022-12-21 12:54:46 +0100472 if (jpake_computation_stage->state == PSA_PAKE_INPUT_X1_X2 &&
473 jpake_computation_stage->sequence == PSA_PAKE_X2_STEP_ZK_PROOF) {
Przemek Stekiel6c764412022-11-22 14:05:12 +0100474 ret = mbedtls_ecjpake_read_round_one(&operation->ctx.pake,
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 operation->buffer,
476 operation->buffer_length);
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200477
Gilles Peskine449bd832023-01-11 14:50:10 +0100478 mbedtls_platform_zeroize(operation->buffer, MBEDTLS_PSA_PAKE_BUFFER_SIZE);
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200479 operation->buffer_length = 0;
480
Gilles Peskine449bd832023-01-11 14:50:10 +0100481 if (ret != 0) {
482 return mbedtls_ecjpake_to_psa_error(ret);
483 }
Przemek Stekiele12ed362022-12-21 12:54:46 +0100484 } else if (jpake_computation_stage->state == PSA_PAKE_INPUT_X4S &&
485 jpake_computation_stage->sequence == PSA_PAKE_X1_STEP_ZK_PROOF) {
Przemek Stekiel6c764412022-11-22 14:05:12 +0100486 ret = mbedtls_ecjpake_read_round_two(&operation->ctx.pake,
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 operation->buffer,
488 operation->buffer_length);
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200489
Gilles Peskine449bd832023-01-11 14:50:10 +0100490 mbedtls_platform_zeroize(operation->buffer, MBEDTLS_PSA_PAKE_BUFFER_SIZE);
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200491 operation->buffer_length = 0;
492
Gilles Peskine449bd832023-01-11 14:50:10 +0100493 if (ret != 0) {
494 return mbedtls_ecjpake_to_psa_error(ret);
495 }
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200496 }
497
Gilles Peskine449bd832023-01-11 14:50:10 +0100498 return PSA_SUCCESS;
499 } else
Neil Armstrong5ae60962022-09-15 11:29:46 +0200500#else
501 (void) step;
Przemek Stekiele12ed362022-12-21 12:54:46 +0100502 (void) computation_stage;
Neil Armstrong5ae60962022-09-15 11:29:46 +0200503 (void) input;
504 (void) input_length;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200505#endif
Neil Armstrong5ae60962022-09-15 11:29:46 +0200506 { return PSA_ERROR_NOT_SUPPORTED; }
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200507}
508
Przemek Stekiel6c764412022-11-22 14:05:12 +0100509psa_status_t mbedtls_psa_pake_input(mbedtls_psa_pake_operation_t *operation,
Neil Armstrong56b8d232022-06-01 18:05:57 +0200510 psa_pake_step_t step,
Przemek Stekiele12ed362022-12-21 12:54:46 +0100511 const psa_pake_computation_stage_t *computation_stage,
Neil Armstrong56b8d232022-06-01 18:05:57 +0200512 const uint8_t *input,
513 size_t input_length)
Manuel Pégourié-Gonnardf155ab92022-10-13 13:11:52 +0200514{
Neil Armstrong56b8d232022-06-01 18:05:57 +0200515 psa_status_t status = mbedtls_psa_pake_input_internal(
Przemek Stekiele12ed362022-12-21 12:54:46 +0100516 operation, step, computation_stage, input, input_length);
Manuel Pégourié-Gonnardf155ab92022-10-13 13:11:52 +0200517
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 if (status != PSA_SUCCESS) {
Przemek Stekiel6c764412022-11-22 14:05:12 +0100519 mbedtls_psa_pake_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 }
Manuel Pégourié-Gonnardf155ab92022-10-13 13:11:52 +0200521
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return status;
Manuel Pégourié-Gonnardf155ab92022-10-13 13:11:52 +0200523}
524
Neil Armstrong56b8d232022-06-01 18:05:57 +0200525psa_status_t mbedtls_psa_pake_get_implicit_key(
Przemek Stekiel6c764412022-11-22 14:05:12 +0100526 mbedtls_psa_pake_operation_t *operation,
Przemek Stekiel0c781802022-11-29 14:53:13 +0100527 uint8_t *output, size_t *output_size)
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200528{
529 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200530
Przemek Stekiel6c764412022-11-22 14:05:12 +0100531 if (operation->alg == PSA_ALG_NONE) {
532 return PSA_ERROR_BAD_STATE;
533 }
534
Neil Armstronga557cb82022-06-10 08:58:32 +0200535#if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100536 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel6c764412022-11-22 14:05:12 +0100537 ret = mbedtls_ecjpake_write_shared_key(&operation->ctx.pake,
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 operation->buffer,
539 MBEDTLS_PSA_PAKE_BUFFER_SIZE,
540 &operation->buffer_length,
541 mbedtls_psa_get_random,
542 MBEDTLS_PSA_RANDOM_STATE);
543 if (ret != 0) {
Przemek Stekiel6c764412022-11-22 14:05:12 +0100544 mbedtls_psa_pake_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +0100545 return mbedtls_ecjpake_to_psa_error(ret);
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200546 }
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200547
Przemek Stekiel0c781802022-11-29 14:53:13 +0100548 memcpy(output, operation->buffer, operation->buffer_length);
549 *output_size = operation->buffer_length;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200550
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 mbedtls_platform_zeroize(operation->buffer, MBEDTLS_PSA_PAKE_BUFFER_SIZE);
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200552
Przemek Stekiel6c764412022-11-22 14:05:12 +0100553 mbedtls_psa_pake_abort(operation);
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200554
Przemek Stekiel0c781802022-11-29 14:53:13 +0100555 return PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 } else
Neil Armstrong5ae60962022-09-15 11:29:46 +0200557#else
558 (void) output;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200559#endif
Przemek Stekiele12ed362022-12-21 12:54:46 +0100560 { return PSA_ERROR_NOT_SUPPORTED; }
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200561}
562
Przemek Stekiel6c764412022-11-22 14:05:12 +0100563psa_status_t mbedtls_psa_pake_abort(mbedtls_psa_pake_operation_t *operation)
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200564{
Przemek Stekiel6c764412022-11-22 14:05:12 +0100565 if (operation->alg == PSA_ALG_NONE) {
566 return PSA_SUCCESS;
567 }
568
Neil Armstronga557cb82022-06-10 08:58:32 +0200569#if defined(MBEDTLS_PSA_BUILTIN_ALG_JPAKE)
Przemek Stekiel6c764412022-11-22 14:05:12 +0100570
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 if (operation->alg == PSA_ALG_JPAKE) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100572 if (operation->password_len > 0) {
573 mbedtls_platform_zeroize(operation->password, operation->password_len);
574 }
575 mbedtls_free(operation->password);
Przemek Stekiel152ae072022-11-17 13:24:36 +0100576 operation->password = NULL;
577 operation->password_len = 0;
Neil Armstrongcb679f22022-09-13 14:43:07 +0200578 operation->role = PSA_PAKE_ROLE_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 mbedtls_platform_zeroize(operation->buffer, MBEDTLS_PSA_PAKE_BUFFER_SIZE);
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200580 operation->buffer_length = 0;
581 operation->buffer_offset = 0;
Przemek Stekiel6c764412022-11-22 14:05:12 +0100582 mbedtls_ecjpake_free(&operation->ctx.pake);
Neil Armstrong4efd7a42022-06-08 17:18:31 +0200583 }
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200584#endif
585
Neil Armstrongcb679f22022-09-13 14:43:07 +0200586 operation->alg = PSA_ALG_NONE;
Neil Armstrongfbc4b4a2022-06-10 08:54:53 +0200587
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return PSA_SUCCESS;
Neil Armstronga4cc7d62022-05-25 11:30:48 +0200589}
590
591#endif /* MBEDTLS_PSA_BUILTIN_PAKE */
592
593#endif /* MBEDTLS_PSA_CRYPTO_C */