blob: 171fb85e52e74b5deea4f681079341763da480ce [file] [log] [blame]
Paul Bakkered27a042013-04-18 22:46:23 +02001/**
2 * \file pk.h
3 *
4 * \brief Public Key abstraction layer
Darryl Greena40a1012018-01-05 15:33:17 +00005 */
6/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02007 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02008 * SPDX-License-Identifier: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
Paul Bakkered27a042013-04-18 22:46:23 +020021 */
Manuel Pégourié-Gonnardd73b3c12013-08-12 17:06:05 +020022
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020023#ifndef MBEDTLS_PK_H
24#define MBEDTLS_PK_H
Mateusz Starzyk846f0212021-05-19 19:44:07 +020025#include "mbedtls/private_access.h"
Paul Bakkered27a042013-04-18 22:46:23 +020026
Bence Szépkútic662b362021-05-27 11:25:03 +020027#include "mbedtls/build_info.h"
Manuel Pégourié-Gonnard244569f2013-07-10 09:46:30 +020028
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010029#include "mbedtls/md.h"
Manuel Pégourié-Gonnardf73da022013-08-17 14:36:32 +020030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020031#if defined(MBEDTLS_RSA_C)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010032#include "mbedtls/rsa.h"
Manuel Pégourié-Gonnard244569f2013-07-10 09:46:30 +020033#endif
34
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020035#if defined(MBEDTLS_ECP_C)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010036#include "mbedtls/ecp.h"
Manuel Pégourié-Gonnardd73b3c12013-08-12 17:06:05 +020037#endif
38
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020039#if defined(MBEDTLS_ECDSA_C)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010040#include "mbedtls/ecdsa.h"
Manuel Pégourié-Gonnard211a64c2013-08-09 15:04:26 +020041#endif
42
Valerio Settie00954d2023-04-28 15:24:32 +020043#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_PSA_CRYPTO_C)
Manuel Pégourié-Gonnard20678b22018-10-22 12:11:15 +020044#include "psa/crypto.h"
45#endif
46
Gilles Peskined2971572021-07-26 18:48:10 +020047/** Memory allocation failed. */
48#define MBEDTLS_ERR_PK_ALLOC_FAILED -0x3F80
49/** Type mismatch, eg attempt to encrypt with an ECDSA key */
50#define MBEDTLS_ERR_PK_TYPE_MISMATCH -0x3F00
51/** Bad input parameters to function. */
52#define MBEDTLS_ERR_PK_BAD_INPUT_DATA -0x3E80
53/** Read/write of file failed. */
54#define MBEDTLS_ERR_PK_FILE_IO_ERROR -0x3E00
55/** Unsupported key version */
56#define MBEDTLS_ERR_PK_KEY_INVALID_VERSION -0x3D80
57/** Invalid key tag or value. */
58#define MBEDTLS_ERR_PK_KEY_INVALID_FORMAT -0x3D00
59/** Key algorithm is unsupported (only RSA and EC are supported). */
60#define MBEDTLS_ERR_PK_UNKNOWN_PK_ALG -0x3C80
61/** Private key password can't be empty. */
62#define MBEDTLS_ERR_PK_PASSWORD_REQUIRED -0x3C00
63/** Given private key password does not allow for correct decryption. */
64#define MBEDTLS_ERR_PK_PASSWORD_MISMATCH -0x3B80
65/** The pubkey tag or value is invalid (only RSA and EC are supported). */
66#define MBEDTLS_ERR_PK_INVALID_PUBKEY -0x3B00
67/** The algorithm tag or value is invalid. */
68#define MBEDTLS_ERR_PK_INVALID_ALG -0x3A80
69/** Elliptic curve is unsupported (only NIST curves are supported). */
70#define MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE -0x3A00
71/** Unavailable feature, e.g. RSA disabled for RSA key. */
72#define MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE -0x3980
73/** The buffer contains a valid signature followed by more data. */
74#define MBEDTLS_ERR_PK_SIG_LEN_MISMATCH -0x3900
75/** The output buffer is too small. */
76#define MBEDTLS_ERR_PK_BUFFER_TOO_SMALL -0x3880
Ron Eldor9924bdc2018-10-04 10:59:13 +030077
Paul Bakkered27a042013-04-18 22:46:23 +020078#ifdef __cplusplus
79extern "C" {
80#endif
81
82/**
83 * \brief Public key types
84 */
85typedef enum {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020086 MBEDTLS_PK_NONE=0,
87 MBEDTLS_PK_RSA,
88 MBEDTLS_PK_ECKEY,
89 MBEDTLS_PK_ECKEY_DH,
90 MBEDTLS_PK_ECDSA,
91 MBEDTLS_PK_RSA_ALT,
92 MBEDTLS_PK_RSASSA_PSS,
Manuel Pégourié-Gonnard69baf702018-11-06 09:34:30 +010093 MBEDTLS_PK_OPAQUE,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020094} mbedtls_pk_type_t;
Paul Bakkered27a042013-04-18 22:46:23 +020095
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +020096/**
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +020097 * \brief Options for RSASSA-PSS signature verification.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020098 * See \c mbedtls_rsa_rsassa_pss_verify_ext()
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +020099 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100100typedef struct mbedtls_pk_rsassa_pss_options {
Gilles Peskine34c43a82023-02-02 23:06:37 +0100101 /** The digest to use for MGF1 in PSS.
102 *
103 * \note When #MBEDTLS_USE_PSA_CRYPTO is enabled and #MBEDTLS_RSA_C is
104 * disabled, this must be equal to the \c md_alg argument passed
105 * to mbedtls_pk_verify_ext(). In a future version of the library,
106 * this constraint may apply whenever #MBEDTLS_USE_PSA_CRYPTO is
107 * enabled regardless of the status of #MBEDTLS_RSA_C.
108 */
109 mbedtls_md_type_t mgf1_hash_id;
110
111 /** The expected length of the salt, in bytes. This may be
112 * #MBEDTLS_RSA_SALT_LEN_ANY to accept any salt length.
113 *
114 * \note When #MBEDTLS_USE_PSA_CRYPTO is enabled, only
115 * #MBEDTLS_RSA_SALT_LEN_ANY is valid. Any other value may be
116 * ignored (allowing any salt length).
117 */
118 int expected_salt_len;
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200119
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200120} mbedtls_pk_rsassa_pss_options;
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200121
122/**
Gilles Peskineda252be2019-11-05 16:23:49 +0100123 * \brief Maximum size of a signature made by mbedtls_pk_sign().
124 */
Gilles Peskine54605652019-11-08 16:24:16 +0100125/* We need to set MBEDTLS_PK_SIGNATURE_MAX_SIZE to the maximum signature
126 * size among the supported signature types. Do it by starting at 0,
127 * then incrementally increasing to be large enough for each supported
128 * signature mechanism.
129 *
130 * The resulting value can be 0, for example if MBEDTLS_ECDH_C is enabled
131 * (which allows the pk module to be included) but neither MBEDTLS_ECDSA_C
132 * nor MBEDTLS_RSA_C nor any opaque signature mechanism (PSA or RSA_ALT).
133 */
134#define MBEDTLS_PK_SIGNATURE_MAX_SIZE 0
135
Gilles Peskine449bd832023-01-11 14:50:10 +0100136#if (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_RSA_ALT_SUPPORT)) && \
Gilles Peskineb22a24b2019-11-05 16:56:39 +0100137 MBEDTLS_MPI_MAX_SIZE > MBEDTLS_PK_SIGNATURE_MAX_SIZE
Gilles Peskine54605652019-11-08 16:24:16 +0100138/* For RSA, the signature can be as large as the bignum module allows.
139 * For RSA_ALT, the signature size is not necessarily tied to what the
140 * bignum module can do, but in the absence of any specific setting,
Chris Jones3848e312021-03-11 16:17:59 +0000141 * we use that (rsa_alt_sign_wrap in library/pk_wrap.h will check). */
Gilles Peskineb22a24b2019-11-05 16:56:39 +0100142#undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
143#define MBEDTLS_PK_SIGNATURE_MAX_SIZE MBEDTLS_MPI_MAX_SIZE
144#endif
Gilles Peskine54605652019-11-08 16:24:16 +0100145
Gilles Peskineb22a24b2019-11-05 16:56:39 +0100146#if defined(MBEDTLS_ECDSA_C) && \
147 MBEDTLS_ECDSA_MAX_LEN > MBEDTLS_PK_SIGNATURE_MAX_SIZE
Gilles Peskine54605652019-11-08 16:24:16 +0100148/* For ECDSA, the ecdsa module exports a constant for the maximum
149 * signature size. */
Gilles Peskineb22a24b2019-11-05 16:56:39 +0100150#undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
151#define MBEDTLS_PK_SIGNATURE_MAX_SIZE MBEDTLS_ECDSA_MAX_LEN
152#endif
Gilles Peskine54605652019-11-08 16:24:16 +0100153
154#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100155#if PSA_SIGNATURE_MAX_SIZE > MBEDTLS_PK_SIGNATURE_MAX_SIZE
156/* PSA_SIGNATURE_MAX_SIZE is the maximum size of a signature made
Gilles Peskine54605652019-11-08 16:24:16 +0100157 * through the PSA API in the PSA representation. */
158#undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100159#define MBEDTLS_PK_SIGNATURE_MAX_SIZE PSA_SIGNATURE_MAX_SIZE
Gilles Peskine54605652019-11-08 16:24:16 +0100160#endif
161
162#if PSA_VENDOR_ECDSA_SIGNATURE_MAX_SIZE + 11 > MBEDTLS_PK_SIGNATURE_MAX_SIZE
163/* The Mbed TLS representation is different for ECDSA signatures:
Gilles Peskineb22a24b2019-11-05 16:56:39 +0100164 * PSA uses the raw concatenation of r and s,
165 * whereas Mbed TLS uses the ASN.1 representation (SEQUENCE of two INTEGERs).
166 * Add the overhead of ASN.1: up to (1+2) + 2 * (1+2+1) for the
167 * types, lengths (represented by up to 2 bytes), and potential leading
168 * zeros of the INTEGERs and the SEQUENCE. */
169#undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
Gilles Peskine449bd832023-01-11 14:50:10 +0100170#define MBEDTLS_PK_SIGNATURE_MAX_SIZE (PSA_VENDOR_ECDSA_SIGNATURE_MAX_SIZE + 11)
Gilles Peskineb22a24b2019-11-05 16:56:39 +0100171#endif
Gilles Peskine54605652019-11-08 16:24:16 +0100172#endif /* defined(MBEDTLS_USE_PSA_CRYPTO) */
Gilles Peskineda252be2019-11-05 16:23:49 +0100173
174/**
Valerio Setticf084ae2023-01-26 14:30:12 +0100175 * \brief The following defines are meant to list ECDSA capabilities of the
176 * PK module in a general way (without any reference to how this
177 * is achieved, which can be either through PSA driver or
178 * MBEDTLS_ECDSA_C)
179 */
180#if !defined(MBEDTLS_USE_PSA_CRYPTO)
181#if defined(MBEDTLS_ECDSA_C)
182#define MBEDTLS_PK_CAN_ECDSA_SIGN
183#define MBEDTLS_PK_CAN_ECDSA_VERIFY
184#endif
185#else /* MBEDTLS_USE_PSA_CRYPTO */
186#if defined(PSA_WANT_ALG_ECDSA)
Valerio Setti27c501a2023-06-27 16:58:52 +0200187#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC)
Valerio Setticf084ae2023-01-26 14:30:12 +0100188#define MBEDTLS_PK_CAN_ECDSA_SIGN
189#endif
190#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
191#define MBEDTLS_PK_CAN_ECDSA_VERIFY
192#endif
193#endif /* PSA_WANT_ALG_ECDSA */
194#endif /* MBEDTLS_USE_PSA_CRYPTO */
195
Valerio Setti178b5bd2023-02-13 10:04:28 +0100196#if defined(MBEDTLS_PK_CAN_ECDSA_VERIFY) || defined(MBEDTLS_PK_CAN_ECDSA_SIGN)
197#define MBEDTLS_PK_CAN_ECDSA_SOME
198#endif
199
Valerio Settia9aab1a2023-06-19 13:39:54 +0200200/* Internal helper to define which fields in the pk_context structure below
201 * should be used for EC keys: legacy ecp_keypair or the raw (PSA friendly)
202 * format. It should be noticed that this only affect how data is stored, not
203 * which functions are used for various operations. The overall picture looks
204 * like this:
205 * - if USE_PSA is not defined and ECP_C is then use ecp_keypair data structure
206 * and legacy functions
207 * - if USE_PSA is defined and
208 * - if ECP_C then use ecp_keypair structure, convert data to a PSA friendly
209 * format and use PSA functions
210 * - if !ECP_C then use new raw data and PSA functions directly.
211 *
212 * The main reason for the "intermediate" (USE_PSA + ECP_C) above is that as long
213 * as ECP_C is defined mbedtls_pk_ec() gives the user a read/write access to the
214 * ecp_keypair structure inside the pk_context so he/she can modify it using
215 * ECP functions which are not under PK module's control.
216 */
217#if defined(MBEDTLS_USE_PSA_CRYPTO) && defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY) && \
218 !defined(MBEDTLS_ECP_C)
219#define MBEDTLS_PK_USE_PSA_EC_DATA
220#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_ECP_C */
221
222/* Helper symbol to state that the PK module has support for EC keys. This
223 * can either be provided through the legacy ECP solution or through the
224 * PSA friendly MBEDTLS_PK_USE_PSA_EC_DATA. */
225#if defined(MBEDTLS_PK_USE_PSA_EC_DATA) || defined(MBEDTLS_ECP_C)
226#define MBEDTLS_PK_HAVE_ECC_KEYS
227#endif /* MBEDTLS_PK_USE_PSA_EC_DATA || MBEDTLS_ECP_C */
228
Valerio Setticf084ae2023-01-26 14:30:12 +0100229/**
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200230 * \brief Types for interfacing with the debug module
231 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100232typedef enum {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200233 MBEDTLS_PK_DEBUG_NONE = 0,
234 MBEDTLS_PK_DEBUG_MPI,
235 MBEDTLS_PK_DEBUG_ECP,
Valerio Setti92c3f362023-05-17 15:36:44 +0200236 MBEDTLS_PK_DEBUG_PSA_EC,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237} mbedtls_pk_debug_type;
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200238
239/**
240 * \brief Item to send to the debug module
241 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100242typedef struct mbedtls_pk_debug_item {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200243 mbedtls_pk_debug_type MBEDTLS_PRIVATE(type);
244 const char *MBEDTLS_PRIVATE(name);
245 void *MBEDTLS_PRIVATE(value);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200246} mbedtls_pk_debug_item;
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200247
248/** Maximum number of item send for debugging, plus 1 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249#define MBEDTLS_PK_DEBUG_MAX_ITEMS 3
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200250
251/**
Manuel Pégourié-Gonnard3fb5c5e2013-08-14 18:26:41 +0200252 * \brief Public key information and operations
Gilles Peskine2e9d65f2021-08-31 23:05:19 +0200253 *
254 * \note The library does not support custom pk info structures,
255 * only built-in structures returned by
256 * mbedtls_cipher_info_from_type().
Manuel Pégourié-Gonnardd73b3c12013-08-12 17:06:05 +0200257 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200258typedef struct mbedtls_pk_info_t mbedtls_pk_info_t;
Manuel Pégourié-Gonnardd73b3c12013-08-12 17:06:05 +0200259
Valerio Setti722f8f72023-05-17 15:31:21 +0200260#define MBEDTLS_PK_MAX_EC_PUBKEY_RAW_LEN \
261 PSA_KEY_EXPORT_ECC_PUBLIC_KEY_MAX_SIZE(PSA_VENDOR_ECC_MAX_CURVE_BITS)
Manuel Pégourié-Gonnardd73b3c12013-08-12 17:06:05 +0200262/**
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200263 * \brief Public key container
264 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100265typedef struct mbedtls_pk_context {
266 const mbedtls_pk_info_t *MBEDTLS_PRIVATE(pk_info); /**< Public key information */
267 void *MBEDTLS_PRIVATE(pk_ctx); /**< Underlying public key context */
Valerio Setti7ef8a8d2023-05-23 18:39:54 +0200268 /* The following field is used to store the ID of a private key in the
269 * following cases:
270 * - opaque key when MBEDTLS_PSA_CRYPTO_C is defined
271 * - normal key when MBEDTLS_PK_USE_PSA_EC_DATA is defined. In this case:
272 * - the pk_ctx above is not not used to store the private key anymore.
273 * Actually that field not populated at all in this case because also
274 * the public key will be stored in raw format as explained below
275 * - this ID is used for all private key operations (ex: sign, check
276 * key pair, key write, etc) using PSA functions
277 *
278 * Note: this private key storing solution only affects EC keys, not the
279 * other ones. The latters still use the pk_ctx to store their own
280 * context.
281 *
282 * Note: this priv_id is guarded by MBEDTLS_PSA_CRYPTO_C and not by
283 * MBEDTLS_PK_USE_PSA_EC_DATA (as the public counterpart below) because,
284 * when working with opaque keys, it can be used also in
285 * mbedtls_pk_sign_ext for RSA keys. */
Valerio Settie00954d2023-04-28 15:24:32 +0200286#if defined(MBEDTLS_PSA_CRYPTO_C)
Valerio Setti4f387ef2023-05-02 14:15:59 +0200287 mbedtls_svc_key_id_t MBEDTLS_PRIVATE(priv_id); /**< Key ID for opaque keys */
Valerio Settie00954d2023-04-28 15:24:32 +0200288#endif /* MBEDTLS_PSA_CRYPTO_C */
Valerio Setti722f8f72023-05-17 15:31:21 +0200289 /* The following fields are meant for storing the public key in raw format
290 * which is handy for:
291 * - easily importing it into the PSA context
292 * - reducing the ECP module dependencies in the PK one.
293 *
294 * When MBEDTLS_PK_USE_PSA_EC_DATA is enabled:
295 * - the pk_ctx above is not used anymore for storing the public key
Valerio Setti7ef8a8d2023-05-23 18:39:54 +0200296 * inside the ecp_keypair structure
Valerio Setti722f8f72023-05-17 15:31:21 +0200297 * - the following fields are used for all public key operations: signature
298 * verify, key pair check and key write.
299 * Of course, when MBEDTLS_PK_USE_PSA_EC_DATA is not enabled, the legacy
Valerio Setti016264b2023-05-22 18:40:35 +0200300 * ecp_keypair structure is used for storing the public key and performing
Valerio Setti722f8f72023-05-17 15:31:21 +0200301 * all the operations.
302 *
303 * Note: This new public key storing solution only works for EC keys, not
Valerio Settif57007d2023-05-19 13:54:39 +0200304 * other ones. The latters still use pk_ctx to store their own
Valerio Setti722f8f72023-05-17 15:31:21 +0200305 * context.
306 */
307#if defined(MBEDTLS_PK_USE_PSA_EC_DATA)
308 uint8_t MBEDTLS_PRIVATE(pub_raw)[MBEDTLS_PK_MAX_EC_PUBKEY_RAW_LEN]; /**< Raw public key */
309 size_t MBEDTLS_PRIVATE(pub_raw_len); /**< Valid bytes in "pub_raw" */
310 psa_ecc_family_t MBEDTLS_PRIVATE(ec_family); /**< EC family of pk */
311 size_t MBEDTLS_PRIVATE(ec_bits); /**< Curve's bits of pk */
Valerio Settic1541cb2023-05-17 15:49:55 +0200312#endif /* MBEDTLS_PK_USE_PSA_EC_DATA */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200313} mbedtls_pk_context;
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200314
Manuel Pégourié-Gonnardaaa98142017-08-18 17:30:37 +0200315#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200316/**
317 * \brief Context for resuming operations
318 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100319typedef struct {
320 const mbedtls_pk_info_t *MBEDTLS_PRIVATE(pk_info); /**< Public key information */
321 void *MBEDTLS_PRIVATE(rs_ctx); /**< Underlying restart context */
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200322} mbedtls_pk_restart_ctx;
Manuel Pégourié-Gonnardaaa98142017-08-18 17:30:37 +0200323#else /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200324/* Now we can declare functions that take a pointer to that */
325typedef void mbedtls_pk_restart_ctx;
Manuel Pégourié-Gonnardaaa98142017-08-18 17:30:37 +0200326#endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200327
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328#if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200329/**
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200330 * \brief Types for RSA-alt abstraction
331 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100332typedef int (*mbedtls_pk_rsa_alt_decrypt_func)(void *ctx, size_t *olen,
333 const unsigned char *input, unsigned char *output,
334 size_t output_max_len);
335typedef int (*mbedtls_pk_rsa_alt_sign_func)(void *ctx,
336 int (*f_rng)(void *, unsigned char *, size_t),
337 void *p_rng,
338 mbedtls_md_type_t md_alg, unsigned int hashlen,
339 const unsigned char *hash, unsigned char *sig);
340typedef size_t (*mbedtls_pk_rsa_alt_key_len_func)(void *ctx);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341#endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200342
343/**
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200344 * \brief Return information associated with the given PK type
345 *
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +0200346 * \param pk_type PK type to search for.
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200347 *
348 * \return The PK info associated with the type or NULL if not found.
349 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100350const mbedtls_pk_info_t *mbedtls_pk_info_from_type(mbedtls_pk_type_t pk_type);
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200351
352/**
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500353 * \brief Initialize a #mbedtls_pk_context (as NONE).
354 *
355 * \param ctx The context to initialize.
356 * This must not be \c NULL.
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200357 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100358void mbedtls_pk_init(mbedtls_pk_context *ctx);
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200359
360/**
Andrzej Kurekb274f272019-02-05 05:06:35 -0500361 * \brief Free the components of a #mbedtls_pk_context.
Manuel Pégourié-Gonnard01a12c42018-10-31 10:28:01 +0100362 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500363 * \param ctx The context to clear. It must have been initialized.
364 * If this is \c NULL, this function does nothing.
365 *
Manuel Pégourié-Gonnard01a12c42018-10-31 10:28:01 +0100366 * \note For contexts that have been set up with
Manuel Pégourié-Gonnard69baf702018-11-06 09:34:30 +0100367 * mbedtls_pk_setup_opaque(), this does not free the underlying
Gilles Peskine11392492019-05-27 14:53:19 +0200368 * PSA key and you still need to call psa_destroy_key()
Manuel Pégourié-Gonnard01a12c42018-10-31 10:28:01 +0100369 * independently if you want to destroy that key.
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200370 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100371void mbedtls_pk_free(mbedtls_pk_context *ctx);
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200372
Manuel Pégourié-Gonnardaaa98142017-08-18 17:30:37 +0200373#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200374/**
375 * \brief Initialize a restart context
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500376 *
377 * \param ctx The context to initialize.
378 * This must not be \c NULL.
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200379 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100380void mbedtls_pk_restart_init(mbedtls_pk_restart_ctx *ctx);
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200381
382/**
383 * \brief Free the components of a restart context
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500384 *
385 * \param ctx The context to clear. It must have been initialized.
386 * If this is \c NULL, this function does nothing.
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200387 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100388void mbedtls_pk_restart_free(mbedtls_pk_restart_ctx *ctx);
Manuel Pégourié-Gonnardaaa98142017-08-18 17:30:37 +0200389#endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200390
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200391/**
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200392 * \brief Initialize a PK context with the information given
393 * and allocates the type-specific PK subcontext.
394 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500395 * \param ctx Context to initialize. It must not have been set
396 * up yet (type #MBEDTLS_PK_NONE).
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200397 * \param info Information to use
398 *
399 * \return 0 on success,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200400 * MBEDTLS_ERR_PK_BAD_INPUT_DATA on invalid input,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200401 * MBEDTLS_ERR_PK_ALLOC_FAILED on allocation failure.
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200402 *
Paul Bakker42099c32014-01-27 11:45:49 +0100403 * \note For contexts holding an RSA-alt key, use
Manuel Pégourié-Gonnardd9e6a3a2015-05-14 19:41:36 +0200404 * \c mbedtls_pk_setup_rsa_alt() instead.
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200405 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100406int mbedtls_pk_setup(mbedtls_pk_context *ctx, const mbedtls_pk_info_t *info);
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200407
Manuel Pégourié-Gonnard20678b22018-10-22 12:11:15 +0200408#if defined(MBEDTLS_USE_PSA_CRYPTO)
409/**
Gilles Peskine11392492019-05-27 14:53:19 +0200410 * \brief Initialize a PK context to wrap a PSA key.
Manuel Pégourié-Gonnard20678b22018-10-22 12:11:15 +0200411 *
Manuel Pégourié-Gonnard392dc042018-11-13 10:48:23 +0100412 * \note This function replaces mbedtls_pk_setup() for contexts
Gilles Peskine11392492019-05-27 14:53:19 +0200413 * that wrap a (possibly opaque) PSA key instead of
Manuel Pégourié-Gonnard392dc042018-11-13 10:48:23 +0100414 * storing and manipulating the key material directly.
415 *
416 * \param ctx The context to initialize. It must be empty (type NONE).
Neil Armstrongb3547422022-03-22 10:22:28 +0100417 * \param key The PSA key to wrap, which must hold an ECC or RSA key
418 * pair (see notes below).
Manuel Pégourié-Gonnard20678b22018-10-22 12:11:15 +0200419 *
Gilles Peskine11392492019-05-27 14:53:19 +0200420 * \note The wrapped key must remain valid as long as the
Manuel Pégourié-Gonnard01a12c42018-10-31 10:28:01 +0100421 * wrapping PK context is in use, that is at least between
422 * the point this function is called and the point
423 * mbedtls_pk_free() is called on this context. The wrapped
Gilles Peskine11392492019-05-27 14:53:19 +0200424 * key might then be independently used or destroyed.
Manuel Pégourié-Gonnard01a12c42018-10-31 10:28:01 +0100425 *
Neil Armstrongb3547422022-03-22 10:22:28 +0100426 * \note This function is currently only available for ECC or RSA
427 * key pairs (that is, keys containing private key material).
Manuel Pégourié-Gonnard392dc042018-11-13 10:48:23 +0100428 * Support for other key types may be added later.
429 *
430 * \return \c 0 on success.
Manuel Pégourié-Gonnard920c0632018-10-31 10:57:29 +0100431 * \return #MBEDTLS_ERR_PK_BAD_INPUT_DATA on invalid input
Ronald Croncf56a0a2020-08-04 09:51:30 +0200432 * (context already used, invalid key identifier).
Manuel Pégourié-Gonnard920c0632018-10-31 10:57:29 +0100433 * \return #MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE if the key is not an
Manuel Pégourié-Gonnard392dc042018-11-13 10:48:23 +0100434 * ECC key pair.
Manuel Pégourié-Gonnard920c0632018-10-31 10:57:29 +0100435 * \return #MBEDTLS_ERR_PK_ALLOC_FAILED on allocation failure.
Manuel Pégourié-Gonnard20678b22018-10-22 12:11:15 +0200436 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100437int mbedtls_pk_setup_opaque(mbedtls_pk_context *ctx,
438 const mbedtls_svc_key_id_t key);
Manuel Pégourié-Gonnard20678b22018-10-22 12:11:15 +0200439#endif /* MBEDTLS_USE_PSA_CRYPTO */
440
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200441#if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200442/**
Paul Bakker4fc090a2013-09-18 15:43:25 +0200443 * \brief Initialize an RSA-alt context
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200444 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500445 * \param ctx Context to initialize. It must not have been set
446 * up yet (type #MBEDTLS_PK_NONE).
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200447 * \param key RSA key pointer
448 * \param decrypt_func Decryption function
449 * \param sign_func Signing function
Manuel Pégourié-Gonnard01488752014-04-03 22:09:18 +0200450 * \param key_len_func Function returning key length in bytes
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200451 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200452 * \return 0 on success, or MBEDTLS_ERR_PK_BAD_INPUT_DATA if the
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200453 * context wasn't already initialized as RSA_ALT.
454 *
Manuel Pégourié-Gonnardd9e6a3a2015-05-14 19:41:36 +0200455 * \note This function replaces \c mbedtls_pk_setup() for RSA-alt.
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200456 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100457int mbedtls_pk_setup_rsa_alt(mbedtls_pk_context *ctx, void *key,
458 mbedtls_pk_rsa_alt_decrypt_func decrypt_func,
459 mbedtls_pk_rsa_alt_sign_func sign_func,
460 mbedtls_pk_rsa_alt_key_len_func key_len_func);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200461#endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200462
463/**
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200464 * \brief Get the size in bits of the underlying key
465 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500466 * \param ctx The context to query. It must have been initialized.
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200467 *
468 * \return Key size in bits, or 0 on error
469 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100470size_t mbedtls_pk_get_bitlen(const mbedtls_pk_context *ctx);
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200471
472/**
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +0200473 * \brief Get the length in bytes of the underlying key
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500474 *
475 * \param ctx The context to query. It must have been initialized.
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +0200476 *
Paul Bakker4fc090a2013-09-18 15:43:25 +0200477 * \return Key length in bytes, or 0 on error
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +0200478 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100479static inline size_t mbedtls_pk_get_len(const mbedtls_pk_context *ctx)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +0200480{
Gilles Peskine449bd832023-01-11 14:50:10 +0100481 return (mbedtls_pk_get_bitlen(ctx) + 7) / 8;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +0200482}
483
484/**
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200485 * \brief Tell if a context can do the operation given by type
486 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500487 * \param ctx The context to query. It must have been initialized.
488 * \param type The desired type.
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200489 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500490 * \return 1 if the context can do operations on the given type.
491 * \return 0 if the context cannot do the operations on the given
492 * type. This is always the case for a context that has
493 * been initialized but not set up, or that has been
494 * cleared with mbedtls_pk_free().
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200495 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100496int mbedtls_pk_can_do(const mbedtls_pk_context *ctx, mbedtls_pk_type_t type);
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200497
Neil Armstrong0b529582022-05-11 10:10:20 +0200498#if defined(MBEDTLS_USE_PSA_CRYPTO)
499/**
Neil Armstrongcec133a2022-05-17 11:56:01 +0200500 * \brief Tell if context can do the operation given by PSA algorithm
Neil Armstrong0b529582022-05-11 10:10:20 +0200501 *
502 * \param ctx The context to query. It must have been initialized.
503 * \param alg PSA algorithm to check against, the following are allowed:
504 * PSA_ALG_RSA_PKCS1V15_SIGN(hash),
505 * PSA_ALG_RSA_PSS(hash),
506 * PSA_ALG_RSA_PKCS1V15_CRYPT,
507 * PSA_ALG_ECDSA(hash),
508 * PSA_ALG_ECDH, where hash is a specific hash.
Neil Armstrong408f6a62022-05-17 14:23:20 +0200509 * \param usage PSA usage flag to check against, must be composed of:
510 * PSA_KEY_USAGE_SIGN_HASH
511 * PSA_KEY_USAGE_DECRYPT
512 * PSA_KEY_USAGE_DERIVE.
513 * Context key must match all passed usage flags.
Neil Armstrong0b529582022-05-11 10:10:20 +0200514 *
Neil Armstrongb2f2b022022-05-20 12:00:56 +0200515 * \warning Since the set of allowed algorithms and usage flags may be
516 * expanded in the future, the return value \c 0 should not
517 * be taken in account for non-allowed algorithms and usage
518 * flags.
519 *
Neil Armstrong0b529582022-05-11 10:10:20 +0200520 * \return 1 if the context can do operations on the given type.
521 * \return 0 if the context cannot do the operations on the given
Neil Armstrongb2f2b022022-05-20 12:00:56 +0200522 * type, for non-allowed algorithms and usage flags, or
523 * for a context that has been initialized but not set up
524 * or that has been cleared with mbedtls_pk_free().
Neil Armstrong0b529582022-05-11 10:10:20 +0200525 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100526int mbedtls_pk_can_do_ext(const mbedtls_pk_context *ctx, psa_algorithm_t alg,
527 psa_key_usage_t usage);
Neil Armstrong0b529582022-05-11 10:10:20 +0200528#endif /* MBEDTLS_USE_PSA_CRYPTO */
529
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200530/**
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200531 * \brief Verify signature (including padding if relevant).
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200532 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500533 * \param ctx The PK context to use. It must have been set up.
Gilles Peskine9dbbc292021-06-22 18:28:13 +0200534 * \param md_alg Hash algorithm used.
535 * This can be #MBEDTLS_MD_NONE if the signature algorithm
536 * does not rely on a hash algorithm (non-deterministic
537 * ECDSA, RSA PKCS#1 v1.5).
538 * For PKCS#1 v1.5, if \p md_alg is #MBEDTLS_MD_NONE, then
539 * \p hash is the DigestInfo structure used by RFC 8017
540 * &sect;9.2 steps 3&ndash;6. If \p md_alg is a valid hash
541 * algorithm then \p hash is the digest itself, and this
542 * function calculates the DigestInfo encoding internally.
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200543 * \param hash Hash of the message to sign
Gilles Peskine9dbbc292021-06-22 18:28:13 +0200544 * \param hash_len Hash length
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200545 * \param sig Signature to verify
546 * \param sig_len Signature length
547 *
548 * \return 0 on success (signature is valid),
Gilles Peskine5114d3e2018-03-30 07:12:15 +0200549 * #MBEDTLS_ERR_PK_SIG_LEN_MISMATCH if there is a valid
550 * signature in sig but its length is less than \p siglen,
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200551 * or a specific error code.
Manuel Pégourié-Gonnardbfe32ef2013-08-22 14:55:30 +0200552 *
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200553 * \note For RSA keys, the default padding type is PKCS#1 v1.5.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200554 * Use \c mbedtls_pk_verify_ext( MBEDTLS_PK_RSASSA_PSS, ... )
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200555 * to verify RSASSA_PSS signatures.
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200556 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100557int mbedtls_pk_verify(mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg,
558 const unsigned char *hash, size_t hash_len,
559 const unsigned char *sig, size_t sig_len);
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200560
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200561/**
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200562 * \brief Restartable version of \c mbedtls_pk_verify()
563 *
564 * \note Performs the same job as \c mbedtls_pk_verify(), but can
565 * return early and restart according to the limit set with
566 * \c mbedtls_ecp_set_max_ops() to reduce blocking for ECC
567 * operations. For RSA, same as \c mbedtls_pk_verify().
568 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500569 * \param ctx The PK context to use. It must have been set up.
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200570 * \param md_alg Hash algorithm used (see notes)
571 * \param hash Hash of the message to sign
572 * \param hash_len Hash length or 0 (see notes)
573 * \param sig Signature to verify
574 * \param sig_len Signature length
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200575 * \param rs_ctx Restart context (NULL to disable restart)
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200576 *
577 * \return See \c mbedtls_pk_verify(), or
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200578 * \return #MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200579 * operations was reached: see \c mbedtls_ecp_set_max_ops().
580 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100581int mbedtls_pk_verify_restartable(mbedtls_pk_context *ctx,
582 mbedtls_md_type_t md_alg,
583 const unsigned char *hash, size_t hash_len,
584 const unsigned char *sig, size_t sig_len,
585 mbedtls_pk_restart_ctx *rs_ctx);
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200586
587/**
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200588 * \brief Verify signature, with options.
589 * (Includes verification of the padding depending on type.)
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200590 *
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200591 * \param type Signature type (inc. possible padding type) to verify
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200592 * \param options Pointer to type-specific options, or NULL
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500593 * \param ctx The PK context to use. It must have been set up.
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200594 * \param md_alg Hash algorithm used (see notes)
595 * \param hash Hash of the message to sign
596 * \param hash_len Hash length or 0 (see notes)
597 * \param sig Signature to verify
598 * \param sig_len Signature length
599 *
600 * \return 0 on success (signature is valid),
Gilles Peskine5114d3e2018-03-30 07:12:15 +0200601 * #MBEDTLS_ERR_PK_TYPE_MISMATCH if the PK context can't be
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200602 * used for this type of signatures,
Gilles Peskine5114d3e2018-03-30 07:12:15 +0200603 * #MBEDTLS_ERR_PK_SIG_LEN_MISMATCH if there is a valid
604 * signature in sig but its length is less than \p siglen,
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200605 * or a specific error code.
606 *
607 * \note If hash_len is 0, then the length associated with md_alg
608 * is used instead, or an error returned if it is invalid.
609 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200610 * \note md_alg may be MBEDTLS_MD_NONE, only if hash_len != 0
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200611 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612 * \note If type is MBEDTLS_PK_RSASSA_PSS, then options must point
613 * to a mbedtls_pk_rsassa_pss_options structure,
Manuel Pégourié-Gonnarda6e02912022-12-21 09:59:33 +0100614 * otherwise it must be NULL. Note that if
615 * #MBEDTLS_USE_PSA_CRYPTO is defined, the salt length is not
616 * verified as PSA_ALG_RSA_PSS_ANY_SALT is used.
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200617 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100618int mbedtls_pk_verify_ext(mbedtls_pk_type_t type, const void *options,
619 mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg,
620 const unsigned char *hash, size_t hash_len,
621 const unsigned char *sig, size_t sig_len);
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200622
623/**
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200624 * \brief Make signature, including padding if relevant.
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200625 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500626 * \param ctx The PK context to use. It must have been set up
627 * with a private key.
Manuel Pégourié-Gonnardbfe32ef2013-08-22 14:55:30 +0200628 * \param md_alg Hash algorithm used (see notes)
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200629 * \param hash Hash of the message to sign
Gilles Peskine9dbbc292021-06-22 18:28:13 +0200630 * \param hash_len Hash length
Gilles Peskineda252be2019-11-05 16:23:49 +0100631 * \param sig Place to write the signature.
632 * It must have enough room for the signature.
633 * #MBEDTLS_PK_SIGNATURE_MAX_SIZE is always enough.
634 * You may use a smaller buffer if it is large enough
635 * given the key type.
Gilles Peskinef00f1522021-06-22 00:09:00 +0200636 * \param sig_size The size of the \p sig buffer in bytes.
Gilles Peskineda252be2019-11-05 16:23:49 +0100637 * \param sig_len On successful return,
638 * the number of bytes written to \p sig.
Manuel Pégourié-Gonnard34d37562021-06-15 11:29:26 +0200639 * \param f_rng RNG function, must not be \c NULL.
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200640 * \param p_rng RNG parameter
641 *
642 * \return 0 on success, or a specific error code.
Manuel Pégourié-Gonnardbfe32ef2013-08-22 14:55:30 +0200643 *
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200644 * \note For RSA keys, the default padding type is PKCS#1 v1.5.
645 * There is no interface in the PK module to make RSASSA-PSS
646 * signatures yet.
647 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200648 * \note For RSA, md_alg may be MBEDTLS_MD_NONE if hash_len != 0.
649 * For ECDSA, md_alg may never be MBEDTLS_MD_NONE.
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200650 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100651int mbedtls_pk_sign(mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg,
652 const unsigned char *hash, size_t hash_len,
653 unsigned char *sig, size_t sig_size, size_t *sig_len,
654 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200655
Jerry Yubc18c232022-03-12 19:40:29 +0800656#if defined(MBEDTLS_PSA_CRYPTO_C)
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200657/**
Jerry Yu406cf272022-03-22 11:33:42 +0800658 * \brief Make signature given a signature type.
Jerry Yud69439a2022-02-24 15:52:15 +0800659 *
Jerry Yu8beb9e12022-03-12 16:23:53 +0800660 * \param pk_type Signature type.
Jerry Yud69439a2022-02-24 15:52:15 +0800661 * \param ctx The PK context to use. It must have been set up
662 * with a private key.
663 * \param md_alg Hash algorithm used (see notes)
664 * \param hash Hash of the message to sign
665 * \param hash_len Hash length
666 * \param sig Place to write the signature.
667 * It must have enough room for the signature.
668 * #MBEDTLS_PK_SIGNATURE_MAX_SIZE is always enough.
669 * You may use a smaller buffer if it is large enough
670 * given the key type.
671 * \param sig_size The size of the \p sig buffer in bytes.
672 * \param sig_len On successful return,
673 * the number of bytes written to \p sig.
674 * \param f_rng RNG function, must not be \c NULL.
675 * \param p_rng RNG parameter
676 *
677 * \return 0 on success, or a specific error code.
678 *
Jerry Yue6e73d62022-03-24 13:05:08 +0800679 * \note When \p pk_type is #MBEDTLS_PK_RSASSA_PSS,
680 * see #PSA_ALG_RSA_PSS for a description of PSS options used.
Jerry Yud69439a2022-02-24 15:52:15 +0800681 *
682 * \note For RSA, md_alg may be MBEDTLS_MD_NONE if hash_len != 0.
683 * For ECDSA, md_alg may never be MBEDTLS_MD_NONE.
684 *
Jerry Yud69439a2022-02-24 15:52:15 +0800685 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100686int mbedtls_pk_sign_ext(mbedtls_pk_type_t pk_type,
687 mbedtls_pk_context *ctx,
688 mbedtls_md_type_t md_alg,
689 const unsigned char *hash, size_t hash_len,
690 unsigned char *sig, size_t sig_size, size_t *sig_len,
691 int (*f_rng)(void *, unsigned char *, size_t),
692 void *p_rng);
Jerry Yubc18c232022-03-12 19:40:29 +0800693#endif /* MBEDTLS_PSA_CRYPTO_C */
Jerry Yud69439a2022-02-24 15:52:15 +0800694
695/**
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200696 * \brief Restartable version of \c mbedtls_pk_sign()
697 *
698 * \note Performs the same job as \c mbedtls_pk_sign(), but can
699 * return early and restart according to the limit set with
700 * \c mbedtls_ecp_set_max_ops() to reduce blocking for ECC
701 * operations. For RSA, same as \c mbedtls_pk_sign().
702 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500703 * \param ctx The PK context to use. It must have been set up
704 * with a private key.
Gilles Peskine9db14fa2019-11-08 18:37:19 +0100705 * \param md_alg Hash algorithm used (see notes for mbedtls_pk_sign())
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200706 * \param hash Hash of the message to sign
Gilles Peskine9dbbc292021-06-22 18:28:13 +0200707 * \param hash_len Hash length
Gilles Peskine9db14fa2019-11-08 18:37:19 +0100708 * \param sig Place to write the signature.
709 * It must have enough room for the signature.
710 * #MBEDTLS_PK_SIGNATURE_MAX_SIZE is always enough.
711 * You may use a smaller buffer if it is large enough
712 * given the key type.
Gilles Peskinef00f1522021-06-22 00:09:00 +0200713 * \param sig_size The size of the \p sig buffer in bytes.
Gilles Peskine9db14fa2019-11-08 18:37:19 +0100714 * \param sig_len On successful return,
715 * the number of bytes written to \p sig.
Manuel Pégourié-Gonnard34d37562021-06-15 11:29:26 +0200716 * \param f_rng RNG function, must not be \c NULL.
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200717 * \param p_rng RNG parameter
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200718 * \param rs_ctx Restart context (NULL to disable restart)
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200719 *
Gilles Peskine9db14fa2019-11-08 18:37:19 +0100720 * \return See \c mbedtls_pk_sign().
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200721 * \return #MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200722 * operations was reached: see \c mbedtls_ecp_set_max_ops().
723 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100724int mbedtls_pk_sign_restartable(mbedtls_pk_context *ctx,
725 mbedtls_md_type_t md_alg,
726 const unsigned char *hash, size_t hash_len,
727 unsigned char *sig, size_t sig_size, size_t *sig_len,
728 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
729 mbedtls_pk_restart_ctx *rs_ctx);
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200730
731/**
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200732 * \brief Decrypt message (including padding if relevant).
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200733 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500734 * \param ctx The PK context to use. It must have been set up
735 * with a private key.
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200736 * \param input Input to decrypt
737 * \param ilen Input size
738 * \param output Decrypted output
Paul Bakker4fc090a2013-09-18 15:43:25 +0200739 * \param olen Decrypted message length
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200740 * \param osize Size of the output buffer
Manuel Pégourié-Gonnard34d37562021-06-15 11:29:26 +0200741 * \param f_rng RNG function, must not be \c NULL.
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +0200742 * \param p_rng RNG parameter
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200743 *
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200744 * \note For RSA keys, the default padding type is PKCS#1 v1.5.
745 *
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200746 * \return 0 on success, or a specific error code.
747 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100748int mbedtls_pk_decrypt(mbedtls_pk_context *ctx,
749 const unsigned char *input, size_t ilen,
750 unsigned char *output, size_t *olen, size_t osize,
751 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200752
753/**
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200754 * \brief Encrypt message (including padding if relevant).
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200755 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500756 * \param ctx The PK context to use. It must have been set up.
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200757 * \param input Message to encrypt
758 * \param ilen Message size
759 * \param output Encrypted output
760 * \param olen Encrypted output length
761 * \param osize Size of the output buffer
Manuel Pégourié-Gonnard34d37562021-06-15 11:29:26 +0200762 * \param f_rng RNG function, must not be \c NULL.
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +0200763 * \param p_rng RNG parameter
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200764 *
Manuel Pégourié-Gonnard34d37562021-06-15 11:29:26 +0200765 * \note \p f_rng is used for padding generation.
766 *
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200767 * \note For RSA keys, the default padding type is PKCS#1 v1.5.
768 *
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200769 * \return 0 on success, or a specific error code.
770 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100771int mbedtls_pk_encrypt(mbedtls_pk_context *ctx,
772 const unsigned char *input, size_t ilen,
773 unsigned char *output, size_t *olen, size_t osize,
774 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200775
776/**
Manuel Pégourié-Gonnard70bdadf2014-11-06 16:51:20 +0100777 * \brief Check if a public-private pair of keys matches.
778 *
779 * \param pub Context holding a public key.
780 * \param prv Context holding a private (and public) key.
Manuel Pégourié-Gonnard39be1412021-06-15 11:29:26 +0200781 * \param f_rng RNG function, must not be \c NULL.
782 * \param p_rng RNG parameter
Manuel Pégourié-Gonnard70bdadf2014-11-06 16:51:20 +0100783 *
Manuel Pégourié-Gonnardeaeb7b22018-10-24 12:37:44 +0200784 * \return \c 0 on success (keys were checked and match each other).
785 * \return #MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE if the keys could not
786 * be checked - in that case they may or may not match.
787 * \return #MBEDTLS_ERR_PK_BAD_INPUT_DATA if a context is invalid.
788 * \return Another non-zero value if the keys do not match.
Manuel Pégourié-Gonnard70bdadf2014-11-06 16:51:20 +0100789 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100790int mbedtls_pk_check_pair(const mbedtls_pk_context *pub,
791 const mbedtls_pk_context *prv,
792 int (*f_rng)(void *, unsigned char *, size_t),
793 void *p_rng);
Manuel Pégourié-Gonnard70bdadf2014-11-06 16:51:20 +0100794
795/**
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200796 * \brief Export debug information
797 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500798 * \param ctx The PK context to use. It must have been initialized.
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200799 * \param items Place to write debug items
800 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200801 * \return 0 on success or MBEDTLS_ERR_PK_BAD_INPUT_DATA
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200802 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100803int mbedtls_pk_debug(const mbedtls_pk_context *ctx, mbedtls_pk_debug_item *items);
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200804
Manuel Pégourié-Gonnard3fb5c5e2013-08-14 18:26:41 +0200805/**
806 * \brief Access the type name
807 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500808 * \param ctx The PK context to use. It must have been initialized.
Manuel Pégourié-Gonnard3fb5c5e2013-08-14 18:26:41 +0200809 *
810 * \return Type name on success, or "invalid PK"
811 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100812const char *mbedtls_pk_get_name(const mbedtls_pk_context *ctx);
Manuel Pégourié-Gonnard3fb5c5e2013-08-14 18:26:41 +0200813
Manuel Pégourié-Gonnard8053da42013-09-11 22:28:30 +0200814/**
Paul Bakker4fc090a2013-09-18 15:43:25 +0200815 * \brief Get the key type
Manuel Pégourié-Gonnard8053da42013-09-11 22:28:30 +0200816 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500817 * \param ctx The PK context to use. It must have been initialized.
Manuel Pégourié-Gonnard8053da42013-09-11 22:28:30 +0200818 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500819 * \return Type on success.
820 * \return #MBEDTLS_PK_NONE for a context that has not been set up.
Manuel Pégourié-Gonnard8053da42013-09-11 22:28:30 +0200821 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100822mbedtls_pk_type_t mbedtls_pk_get_type(const mbedtls_pk_context *ctx);
Manuel Pégourié-Gonnard8053da42013-09-11 22:28:30 +0200823
Manuel Pégourié-Gonnard22e84de2022-06-10 09:48:38 +0200824#if defined(MBEDTLS_RSA_C)
825/**
826 * Quick access to an RSA context inside a PK context.
827 *
828 * \warning This function can only be used when the type of the context, as
829 * returned by mbedtls_pk_get_type(), is #MBEDTLS_PK_RSA.
830 * Ensuring that is the caller's responsibility.
831 * Alternatively, you can check whether this function returns NULL.
832 *
833 * \return The internal RSA context held by the PK context, or NULL.
834 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100835static inline mbedtls_rsa_context *mbedtls_pk_rsa(const mbedtls_pk_context pk)
Manuel Pégourié-Gonnard22e84de2022-06-10 09:48:38 +0200836{
Gilles Peskine449bd832023-01-11 14:50:10 +0100837 switch (mbedtls_pk_get_type(&pk)) {
Manuel Pégourié-Gonnard4cfaae52022-06-23 09:43:39 +0200838 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100839 return (mbedtls_rsa_context *) (pk).MBEDTLS_PRIVATE(pk_ctx);
Manuel Pégourié-Gonnard4cfaae52022-06-23 09:43:39 +0200840 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100841 return NULL;
Manuel Pégourié-Gonnard4cfaae52022-06-23 09:43:39 +0200842 }
Manuel Pégourié-Gonnard22e84de2022-06-10 09:48:38 +0200843}
844#endif /* MBEDTLS_RSA_C */
845
Valerio Setti229bf102023-05-15 11:13:55 +0200846#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard22e84de2022-06-10 09:48:38 +0200847/**
848 * Quick access to an EC context inside a PK context.
849 *
850 * \warning This function can only be used when the type of the context, as
851 * returned by mbedtls_pk_get_type(), is #MBEDTLS_PK_ECKEY,
852 * #MBEDTLS_PK_ECKEY_DH, or #MBEDTLS_PK_ECDSA.
853 * Ensuring that is the caller's responsibility.
854 * Alternatively, you can check whether this function returns NULL.
855 *
856 * \return The internal EC context held by the PK context, or NULL.
857 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100858static inline mbedtls_ecp_keypair *mbedtls_pk_ec(const mbedtls_pk_context pk)
Manuel Pégourié-Gonnard22e84de2022-06-10 09:48:38 +0200859{
Gilles Peskine449bd832023-01-11 14:50:10 +0100860 switch (mbedtls_pk_get_type(&pk)) {
Manuel Pégourié-Gonnard4cfaae52022-06-23 09:43:39 +0200861 case MBEDTLS_PK_ECKEY:
862 case MBEDTLS_PK_ECKEY_DH:
863 case MBEDTLS_PK_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100864 return (mbedtls_ecp_keypair *) (pk).MBEDTLS_PRIVATE(pk_ctx);
Manuel Pégourié-Gonnard4cfaae52022-06-23 09:43:39 +0200865 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100866 return NULL;
Manuel Pégourié-Gonnard4cfaae52022-06-23 09:43:39 +0200867 }
Manuel Pégourié-Gonnard22e84de2022-06-10 09:48:38 +0200868}
Valerio Setti229bf102023-05-15 11:13:55 +0200869#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard22e84de2022-06-10 09:48:38 +0200870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200871#if defined(MBEDTLS_PK_PARSE_C)
Paul Bakkerff3a5182013-09-16 22:42:19 +0200872/** \ingroup pk_module */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200873/**
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200874 * \brief Parse a private key in PEM or DER format
Paul Bakker1a7550a2013-09-15 13:01:22 +0200875 *
Gilles Peskine5b7e1642022-08-04 23:44:59 +0200876 * \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto
877 * subsystem must have been initialized by calling
878 * psa_crypto_init() before calling this function.
879 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500880 * \param ctx The PK context to fill. It must have been initialized
881 * but not set up.
882 * \param key Input buffer to parse.
883 * The buffer must contain the input exactly, with no
884 * extra trailing material. For PEM, the buffer must
885 * contain a null-terminated string.
886 * \param keylen Size of \b key in bytes.
887 * For PEM data, this includes the terminating null byte,
888 * so \p keylen must be equal to `strlen(key) + 1`.
889 * \param pwd Optional password for decryption.
890 * Pass \c NULL if expecting a non-encrypted key.
891 * Pass a string of \p pwdlen bytes if expecting an encrypted
892 * key; a non-encrypted key will also be accepted.
893 * The empty password is not supported.
894 * \param pwdlen Size of the password in bytes.
895 * Ignored if \p pwd is \c NULL.
Manuel Pégourié-Gonnard84dea012021-06-15 11:29:26 +0200896 * \param f_rng RNG function, must not be \c NULL. Used for blinding.
897 * \param p_rng RNG parameter
Paul Bakker1a7550a2013-09-15 13:01:22 +0200898 *
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100899 * \note On entry, ctx must be empty, either freshly initialised
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200900 * with mbedtls_pk_init() or reset with mbedtls_pk_free(). If you need a
901 * specific key type, check the result with mbedtls_pk_can_do().
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100902 *
903 * \note The key is also checked for correctness.
904 *
Paul Bakker1a7550a2013-09-15 13:01:22 +0200905 * \return 0 if successful, or a specific PK or PEM error code
906 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100907int mbedtls_pk_parse_key(mbedtls_pk_context *ctx,
908 const unsigned char *key, size_t keylen,
909 const unsigned char *pwd, size_t pwdlen,
910 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
Paul Bakker1a7550a2013-09-15 13:01:22 +0200911
Paul Bakkerff3a5182013-09-16 22:42:19 +0200912/** \ingroup pk_module */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200913/**
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200914 * \brief Parse a public key in PEM or DER format
Paul Bakker1a7550a2013-09-15 13:01:22 +0200915 *
Gilles Peskine5b7e1642022-08-04 23:44:59 +0200916 * \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto
917 * subsystem must have been initialized by calling
918 * psa_crypto_init() before calling this function.
919 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500920 * \param ctx The PK context to fill. It must have been initialized
921 * but not set up.
922 * \param key Input buffer to parse.
923 * The buffer must contain the input exactly, with no
924 * extra trailing material. For PEM, the buffer must
925 * contain a null-terminated string.
926 * \param keylen Size of \b key in bytes.
927 * For PEM data, this includes the terminating null byte,
928 * so \p keylen must be equal to `strlen(key) + 1`.
Paul Bakker1a7550a2013-09-15 13:01:22 +0200929 *
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100930 * \note On entry, ctx must be empty, either freshly initialised
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200931 * with mbedtls_pk_init() or reset with mbedtls_pk_free(). If you need a
932 * specific key type, check the result with mbedtls_pk_can_do().
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100933 *
Valerio Setti78f79d32023-02-07 08:33:26 +0100934 * \note For compressed points, see #MBEDTLS_ECP_PF_COMPRESSED for
935 * limitations.
936 *
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100937 * \note The key is also checked for correctness.
938 *
Paul Bakker1a7550a2013-09-15 13:01:22 +0200939 * \return 0 if successful, or a specific PK or PEM error code
940 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100941int mbedtls_pk_parse_public_key(mbedtls_pk_context *ctx,
942 const unsigned char *key, size_t keylen);
Paul Bakker1a7550a2013-09-15 13:01:22 +0200943
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200944#if defined(MBEDTLS_FS_IO)
Paul Bakkerff3a5182013-09-16 22:42:19 +0200945/** \ingroup pk_module */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200946/**
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200947 * \brief Load and parse a private key
948 *
Gilles Peskine5b7e1642022-08-04 23:44:59 +0200949 * \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto
950 * subsystem must have been initialized by calling
951 * psa_crypto_init() before calling this function.
952 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500953 * \param ctx The PK context to fill. It must have been initialized
954 * but not set up.
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200955 * \param path filename to read the private key from
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500956 * \param password Optional password to decrypt the file.
957 * Pass \c NULL if expecting a non-encrypted key.
958 * Pass a null-terminated string if expecting an encrypted
959 * key; a non-encrypted key will also be accepted.
960 * The empty password is not supported.
Manuel Pégourié-Gonnard84dea012021-06-15 11:29:26 +0200961 * \param f_rng RNG function, must not be \c NULL. Used for blinding.
962 * \param p_rng RNG parameter
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200963 *
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100964 * \note On entry, ctx must be empty, either freshly initialised
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965 * with mbedtls_pk_init() or reset with mbedtls_pk_free(). If you need a
966 * specific key type, check the result with mbedtls_pk_can_do().
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100967 *
968 * \note The key is also checked for correctness.
969 *
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200970 * \return 0 if successful, or a specific PK or PEM error code
971 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100972int mbedtls_pk_parse_keyfile(mbedtls_pk_context *ctx,
973 const char *path, const char *password,
974 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200975
Paul Bakkerff3a5182013-09-16 22:42:19 +0200976/** \ingroup pk_module */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200977/**
Paul Bakker1a7550a2013-09-15 13:01:22 +0200978 * \brief Load and parse a public key
979 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500980 * \param ctx The PK context to fill. It must have been initialized
981 * but not set up.
Simon Butcher295639b2016-05-10 19:39:36 +0100982 * \param path filename to read the public key from
Paul Bakker1a7550a2013-09-15 13:01:22 +0200983 *
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100984 * \note On entry, ctx must be empty, either freshly initialised
Simon Butcher295639b2016-05-10 19:39:36 +0100985 * with mbedtls_pk_init() or reset with mbedtls_pk_free(). If
986 * you need a specific key type, check the result with
987 * mbedtls_pk_can_do().
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100988 *
989 * \note The key is also checked for correctness.
990 *
Paul Bakker1a7550a2013-09-15 13:01:22 +0200991 * \return 0 if successful, or a specific PK or PEM error code
992 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100993int mbedtls_pk_parse_public_keyfile(mbedtls_pk_context *ctx, const char *path);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200994#endif /* MBEDTLS_FS_IO */
995#endif /* MBEDTLS_PK_PARSE_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200996
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997#if defined(MBEDTLS_PK_WRITE_C)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200998/**
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200999 * \brief Write a private key to a PKCS#1 or SEC1 DER structure
1000 * Note: data is written at the end of the buffer! Use the
1001 * return value to determine where you should start
1002 * using the buffer
1003 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001004 * \param ctx PK context which must contain a valid private key.
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001005 * \param buf buffer to write to
1006 * \param size size of the buffer
1007 *
1008 * \return length of data written if successful, or a specific
1009 * error code
1010 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001011int mbedtls_pk_write_key_der(const mbedtls_pk_context *ctx, unsigned char *buf, size_t size);
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001012
1013/**
1014 * \brief Write a public key to a SubjectPublicKeyInfo DER structure
1015 * Note: data is written at the end of the buffer! Use the
1016 * return value to determine where you should start
1017 * using the buffer
1018 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001019 * \param ctx PK context which must contain a valid public or private key.
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001020 * \param buf buffer to write to
1021 * \param size size of the buffer
1022 *
1023 * \return length of data written if successful, or a specific
1024 * error code
1025 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001026int mbedtls_pk_write_pubkey_der(const mbedtls_pk_context *ctx, unsigned char *buf, size_t size);
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001027
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028#if defined(MBEDTLS_PEM_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001029/**
1030 * \brief Write a public key to a PEM string
1031 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001032 * \param ctx PK context which must contain a valid public or private key.
1033 * \param buf Buffer to write to. The output includes a
1034 * terminating null byte.
1035 * \param size Size of the buffer in bytes.
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001036 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +02001037 * \return 0 if successful, or a specific error code
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001038 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001039int mbedtls_pk_write_pubkey_pem(const mbedtls_pk_context *ctx, unsigned char *buf, size_t size);
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001040
1041/**
1042 * \brief Write a private key to a PKCS#1 or SEC1 PEM string
1043 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001044 * \param ctx PK context which must contain a valid private key.
1045 * \param buf Buffer to write to. The output includes a
1046 * terminating null byte.
1047 * \param size Size of the buffer in bytes.
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001048 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +02001049 * \return 0 if successful, or a specific error code
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001050 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001051int mbedtls_pk_write_key_pem(const mbedtls_pk_context *ctx, unsigned char *buf, size_t size);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001052#endif /* MBEDTLS_PEM_WRITE_C */
1053#endif /* MBEDTLS_PK_WRITE_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001054
1055/*
1056 * WARNING: Low-level functions. You probably do not want to use these unless
1057 * you are certain you do ;)
1058 */
1059
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001060#if defined(MBEDTLS_PK_PARSE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001061/**
Paul Bakker1a7550a2013-09-15 13:01:22 +02001062 * \brief Parse a SubjectPublicKeyInfo DER structure
1063 *
1064 * \param p the position in the ASN.1 data
1065 * \param end end of the buffer
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001066 * \param pk The PK context to fill. It must have been initialized
1067 * but not set up.
Paul Bakker1a7550a2013-09-15 13:01:22 +02001068 *
1069 * \return 0 if successful, or a specific PK error code
1070 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001071int mbedtls_pk_parse_subpubkey(unsigned char **p, const unsigned char *end,
1072 mbedtls_pk_context *pk);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073#endif /* MBEDTLS_PK_PARSE_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +02001074
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001075#if defined(MBEDTLS_PK_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001076/**
1077 * \brief Write a subjectPublicKey to ASN.1 data
1078 * Note: function works backwards in data buffer
1079 *
1080 * \param p reference to current position pointer
1081 * \param start start of the buffer (for bounds-checking)
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001082 * \param key PK context which must contain a valid public or private key.
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001083 *
1084 * \return the length written or a negative error code
1085 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001086int mbedtls_pk_write_pubkey(unsigned char **p, unsigned char *start,
1087 const mbedtls_pk_context *key);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001088#endif /* MBEDTLS_PK_WRITE_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001089
Manuel Pégourié-Gonnard9439f932014-11-21 09:49:43 +01001090/*
1091 * Internal module functions. You probably do not want to use these unless you
1092 * know you do.
1093 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001094#if defined(MBEDTLS_FS_IO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001095int mbedtls_pk_load_file(const char *path, unsigned char **buf, size_t *n);
Manuel Pégourié-Gonnard9439f932014-11-21 09:49:43 +01001096#endif
1097
Manuel Pégourié-Gonnard347a00e2018-11-19 12:25:37 +01001098#if defined(MBEDTLS_USE_PSA_CRYPTO)
1099/**
Neil Armstrong23143dc2022-04-21 11:33:54 +02001100 * \brief Turn an EC or RSA key into an opaque one.
Manuel Pégourié-Gonnard347a00e2018-11-19 12:25:37 +01001101 *
1102 * \warning This is a temporary utility function for tests. It might
1103 * change or be removed at any time without notice.
1104 *
Neil Armstrong23143dc2022-04-21 11:33:54 +02001105 * \param pk Input: the EC or RSA key to import to a PSA key.
Gilles Peskine11392492019-05-27 14:53:19 +02001106 * Output: a PK context wrapping that PSA key.
Ronald Croncf56a0a2020-08-04 09:51:30 +02001107 * \param key Output: a PSA key identifier.
Gilles Peskine11392492019-05-27 14:53:19 +02001108 * It's the caller's responsibility to call
Ronald Croncf56a0a2020-08-04 09:51:30 +02001109 * psa_destroy_key() on that key identifier after calling
Gilles Peskine11392492019-05-27 14:53:19 +02001110 * mbedtls_pk_free() on the PK context.
Neil Armstronga1fc18f2022-04-22 13:57:14 +02001111 * \param alg The algorithm to allow for use with that key.
1112 * \param usage The usage to allow for use with that key.
1113 * \param alg2 The secondary algorithm to allow for use with that key.
Manuel Pégourié-Gonnard347a00e2018-11-19 12:25:37 +01001114 *
1115 * \return \c 0 if successful.
1116 * \return An Mbed TLS error code otherwise.
1117 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001118int mbedtls_pk_wrap_as_opaque(mbedtls_pk_context *pk,
1119 mbedtls_svc_key_id_t *key,
1120 psa_algorithm_t alg,
1121 psa_key_usage_t usage,
1122 psa_algorithm_t alg2);
Manuel Pégourié-Gonnard347a00e2018-11-19 12:25:37 +01001123#endif /* MBEDTLS_USE_PSA_CRYPTO */
1124
Paul Bakkered27a042013-04-18 22:46:23 +02001125#ifdef __cplusplus
1126}
1127#endif
1128
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129#endif /* MBEDTLS_PK_H */