blob: fc0ce70466d8f512f3d12509c4bb8d057cb61481 [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
Valerio Settia9aab1a2023-06-19 13:39:54 +0200174/* Internal helper to define which fields in the pk_context structure below
175 * should be used for EC keys: legacy ecp_keypair or the raw (PSA friendly)
176 * format. It should be noticed that this only affect how data is stored, not
177 * which functions are used for various operations. The overall picture looks
178 * like this:
179 * - if USE_PSA is not defined and ECP_C is then use ecp_keypair data structure
180 * and legacy functions
181 * - if USE_PSA is defined and
182 * - if ECP_C then use ecp_keypair structure, convert data to a PSA friendly
183 * format and use PSA functions
184 * - if !ECP_C then use new raw data and PSA functions directly.
185 *
186 * The main reason for the "intermediate" (USE_PSA + ECP_C) above is that as long
187 * as ECP_C is defined mbedtls_pk_ec() gives the user a read/write access to the
188 * ecp_keypair structure inside the pk_context so he/she can modify it using
189 * ECP functions which are not under PK module's control.
190 */
191#if defined(MBEDTLS_USE_PSA_CRYPTO) && defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY) && \
192 !defined(MBEDTLS_ECP_C)
193#define MBEDTLS_PK_USE_PSA_EC_DATA
194#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_ECP_C */
195
196/* Helper symbol to state that the PK module has support for EC keys. This
197 * can either be provided through the legacy ECP solution or through the
198 * PSA friendly MBEDTLS_PK_USE_PSA_EC_DATA. */
199#if defined(MBEDTLS_PK_USE_PSA_EC_DATA) || defined(MBEDTLS_ECP_C)
200#define MBEDTLS_PK_HAVE_ECC_KEYS
201#endif /* MBEDTLS_PK_USE_PSA_EC_DATA || MBEDTLS_ECP_C */
202
Valerio Setti0f6d5652023-07-28 16:42:58 +0200203/* Internal helper to define which fields in the pk_context structure below
204 * should be used for EC keys: legacy ecp_keypair or the raw (PSA friendly)
205 * format. It should be noticed that this only affect how data is stored, not
206 * which functions are used for various operations. The overall picture looks
207 * like this:
208 * - if USE_PSA is not defined and ECP_C is then use ecp_keypair data structure
209 * and legacy functions
210 * - if USE_PSA is defined and
211 * - if ECP_C then use ecp_keypair structure, convert data to a PSA friendly
212 * format and use PSA functions
213 * - if !ECP_C then use new raw data and PSA functions directly.
214 *
215 * The main reason for the "intermediate" (USE_PSA + ECP_C) above is that as long
216 * as ECP_C is defined mbedtls_pk_ec() gives the user a read/write access to the
217 * ecp_keypair structure inside the pk_context so he/she can modify it using
218 * ECP functions which are not under PK module's control.
219 */
220#if defined(MBEDTLS_USE_PSA_CRYPTO) && defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY) && \
221 !defined(MBEDTLS_ECP_C)
222#define MBEDTLS_PK_USE_PSA_EC_DATA
223#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_ECP_C */
224
Valerio Setticf084ae2023-01-26 14:30:12 +0100225/**
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200226 * \brief Types for interfacing with the debug module
227 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100228typedef enum {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200229 MBEDTLS_PK_DEBUG_NONE = 0,
230 MBEDTLS_PK_DEBUG_MPI,
231 MBEDTLS_PK_DEBUG_ECP,
Valerio Setti92c3f362023-05-17 15:36:44 +0200232 MBEDTLS_PK_DEBUG_PSA_EC,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200233} mbedtls_pk_debug_type;
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200234
235/**
236 * \brief Item to send to the debug module
237 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100238typedef struct mbedtls_pk_debug_item {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200239 mbedtls_pk_debug_type MBEDTLS_PRIVATE(type);
240 const char *MBEDTLS_PRIVATE(name);
241 void *MBEDTLS_PRIVATE(value);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242} mbedtls_pk_debug_item;
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200243
244/** Maximum number of item send for debugging, plus 1 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200245#define MBEDTLS_PK_DEBUG_MAX_ITEMS 3
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200246
247/**
Manuel Pégourié-Gonnard3fb5c5e2013-08-14 18:26:41 +0200248 * \brief Public key information and operations
Gilles Peskine2e9d65f2021-08-31 23:05:19 +0200249 *
250 * \note The library does not support custom pk info structures,
251 * only built-in structures returned by
252 * mbedtls_cipher_info_from_type().
Manuel Pégourié-Gonnardd73b3c12013-08-12 17:06:05 +0200253 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200254typedef struct mbedtls_pk_info_t mbedtls_pk_info_t;
Manuel Pégourié-Gonnardd73b3c12013-08-12 17:06:05 +0200255
Valerio Setti722f8f72023-05-17 15:31:21 +0200256#define MBEDTLS_PK_MAX_EC_PUBKEY_RAW_LEN \
257 PSA_KEY_EXPORT_ECC_PUBLIC_KEY_MAX_SIZE(PSA_VENDOR_ECC_MAX_CURVE_BITS)
Manuel Pégourié-Gonnardd73b3c12013-08-12 17:06:05 +0200258/**
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200259 * \brief Public key container
260 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100261typedef struct mbedtls_pk_context {
262 const mbedtls_pk_info_t *MBEDTLS_PRIVATE(pk_info); /**< Public key information */
263 void *MBEDTLS_PRIVATE(pk_ctx); /**< Underlying public key context */
Valerio Setti7ef8a8d2023-05-23 18:39:54 +0200264 /* The following field is used to store the ID of a private key in the
265 * following cases:
266 * - opaque key when MBEDTLS_PSA_CRYPTO_C is defined
267 * - normal key when MBEDTLS_PK_USE_PSA_EC_DATA is defined. In this case:
268 * - the pk_ctx above is not not used to store the private key anymore.
269 * Actually that field not populated at all in this case because also
270 * the public key will be stored in raw format as explained below
271 * - this ID is used for all private key operations (ex: sign, check
272 * key pair, key write, etc) using PSA functions
273 *
274 * Note: this private key storing solution only affects EC keys, not the
275 * other ones. The latters still use the pk_ctx to store their own
276 * context.
277 *
278 * Note: this priv_id is guarded by MBEDTLS_PSA_CRYPTO_C and not by
279 * MBEDTLS_PK_USE_PSA_EC_DATA (as the public counterpart below) because,
280 * when working with opaque keys, it can be used also in
281 * mbedtls_pk_sign_ext for RSA keys. */
Valerio Settie00954d2023-04-28 15:24:32 +0200282#if defined(MBEDTLS_PSA_CRYPTO_C)
Valerio Setti4f387ef2023-05-02 14:15:59 +0200283 mbedtls_svc_key_id_t MBEDTLS_PRIVATE(priv_id); /**< Key ID for opaque keys */
Valerio Settie00954d2023-04-28 15:24:32 +0200284#endif /* MBEDTLS_PSA_CRYPTO_C */
Valerio Setti722f8f72023-05-17 15:31:21 +0200285 /* The following fields are meant for storing the public key in raw format
286 * which is handy for:
287 * - easily importing it into the PSA context
288 * - reducing the ECP module dependencies in the PK one.
289 *
290 * When MBEDTLS_PK_USE_PSA_EC_DATA is enabled:
291 * - the pk_ctx above is not used anymore for storing the public key
Valerio Setti7ef8a8d2023-05-23 18:39:54 +0200292 * inside the ecp_keypair structure
Valerio Setti722f8f72023-05-17 15:31:21 +0200293 * - the following fields are used for all public key operations: signature
294 * verify, key pair check and key write.
295 * Of course, when MBEDTLS_PK_USE_PSA_EC_DATA is not enabled, the legacy
Valerio Setti016264b2023-05-22 18:40:35 +0200296 * ecp_keypair structure is used for storing the public key and performing
Valerio Setti722f8f72023-05-17 15:31:21 +0200297 * all the operations.
298 *
299 * Note: This new public key storing solution only works for EC keys, not
Valerio Settif57007d2023-05-19 13:54:39 +0200300 * other ones. The latters still use pk_ctx to store their own
Valerio Setti722f8f72023-05-17 15:31:21 +0200301 * context.
302 */
303#if defined(MBEDTLS_PK_USE_PSA_EC_DATA)
304 uint8_t MBEDTLS_PRIVATE(pub_raw)[MBEDTLS_PK_MAX_EC_PUBKEY_RAW_LEN]; /**< Raw public key */
305 size_t MBEDTLS_PRIVATE(pub_raw_len); /**< Valid bytes in "pub_raw" */
306 psa_ecc_family_t MBEDTLS_PRIVATE(ec_family); /**< EC family of pk */
307 size_t MBEDTLS_PRIVATE(ec_bits); /**< Curve's bits of pk */
Valerio Settic1541cb2023-05-17 15:49:55 +0200308#endif /* MBEDTLS_PK_USE_PSA_EC_DATA */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200309} mbedtls_pk_context;
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200310
Manuel Pégourié-Gonnardaaa98142017-08-18 17:30:37 +0200311#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200312/**
313 * \brief Context for resuming operations
314 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100315typedef struct {
316 const mbedtls_pk_info_t *MBEDTLS_PRIVATE(pk_info); /**< Public key information */
317 void *MBEDTLS_PRIVATE(rs_ctx); /**< Underlying restart context */
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200318} mbedtls_pk_restart_ctx;
Manuel Pégourié-Gonnardaaa98142017-08-18 17:30:37 +0200319#else /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200320/* Now we can declare functions that take a pointer to that */
321typedef void mbedtls_pk_restart_ctx;
Manuel Pégourié-Gonnardaaa98142017-08-18 17:30:37 +0200322#endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200323
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200324#if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200325/**
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200326 * \brief Types for RSA-alt abstraction
327 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100328typedef int (*mbedtls_pk_rsa_alt_decrypt_func)(void *ctx, size_t *olen,
329 const unsigned char *input, unsigned char *output,
330 size_t output_max_len);
331typedef int (*mbedtls_pk_rsa_alt_sign_func)(void *ctx,
332 int (*f_rng)(void *, unsigned char *, size_t),
333 void *p_rng,
334 mbedtls_md_type_t md_alg, unsigned int hashlen,
335 const unsigned char *hash, unsigned char *sig);
336typedef size_t (*mbedtls_pk_rsa_alt_key_len_func)(void *ctx);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200337#endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200338
339/**
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200340 * \brief Return information associated with the given PK type
341 *
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +0200342 * \param pk_type PK type to search for.
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200343 *
344 * \return The PK info associated with the type or NULL if not found.
345 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100346const mbedtls_pk_info_t *mbedtls_pk_info_from_type(mbedtls_pk_type_t pk_type);
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200347
348/**
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500349 * \brief Initialize a #mbedtls_pk_context (as NONE).
350 *
351 * \param ctx The context to initialize.
352 * This must not be \c NULL.
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200353 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100354void mbedtls_pk_init(mbedtls_pk_context *ctx);
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200355
356/**
Andrzej Kurekb274f272019-02-05 05:06:35 -0500357 * \brief Free the components of a #mbedtls_pk_context.
Manuel Pégourié-Gonnard01a12c42018-10-31 10:28:01 +0100358 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500359 * \param ctx The context to clear. It must have been initialized.
360 * If this is \c NULL, this function does nothing.
361 *
Manuel Pégourié-Gonnard01a12c42018-10-31 10:28:01 +0100362 * \note For contexts that have been set up with
Manuel Pégourié-Gonnard69baf702018-11-06 09:34:30 +0100363 * mbedtls_pk_setup_opaque(), this does not free the underlying
Gilles Peskine11392492019-05-27 14:53:19 +0200364 * PSA key and you still need to call psa_destroy_key()
Manuel Pégourié-Gonnard01a12c42018-10-31 10:28:01 +0100365 * independently if you want to destroy that key.
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200366 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100367void mbedtls_pk_free(mbedtls_pk_context *ctx);
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200368
Manuel Pégourié-Gonnardaaa98142017-08-18 17:30:37 +0200369#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200370/**
371 * \brief Initialize a restart context
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500372 *
373 * \param ctx The context to initialize.
374 * This must not be \c NULL.
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200375 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100376void mbedtls_pk_restart_init(mbedtls_pk_restart_ctx *ctx);
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200377
378/**
379 * \brief Free the components of a restart context
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500380 *
381 * \param ctx The context to clear. It must have been initialized.
382 * If this is \c NULL, this function does nothing.
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200383 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100384void mbedtls_pk_restart_free(mbedtls_pk_restart_ctx *ctx);
Manuel Pégourié-Gonnardaaa98142017-08-18 17:30:37 +0200385#endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200386
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200387/**
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200388 * \brief Initialize a PK context with the information given
389 * and allocates the type-specific PK subcontext.
390 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500391 * \param ctx Context to initialize. It must not have been set
392 * up yet (type #MBEDTLS_PK_NONE).
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200393 * \param info Information to use
394 *
395 * \return 0 on success,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200396 * MBEDTLS_ERR_PK_BAD_INPUT_DATA on invalid input,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200397 * MBEDTLS_ERR_PK_ALLOC_FAILED on allocation failure.
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200398 *
Paul Bakker42099c32014-01-27 11:45:49 +0100399 * \note For contexts holding an RSA-alt key, use
Manuel Pégourié-Gonnardd9e6a3a2015-05-14 19:41:36 +0200400 * \c mbedtls_pk_setup_rsa_alt() instead.
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200401 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100402int mbedtls_pk_setup(mbedtls_pk_context *ctx, const mbedtls_pk_info_t *info);
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200403
Manuel Pégourié-Gonnard20678b22018-10-22 12:11:15 +0200404#if defined(MBEDTLS_USE_PSA_CRYPTO)
405/**
Gilles Peskine11392492019-05-27 14:53:19 +0200406 * \brief Initialize a PK context to wrap a PSA key.
Manuel Pégourié-Gonnard20678b22018-10-22 12:11:15 +0200407 *
Manuel Pégourié-Gonnard392dc042018-11-13 10:48:23 +0100408 * \note This function replaces mbedtls_pk_setup() for contexts
Gilles Peskine11392492019-05-27 14:53:19 +0200409 * that wrap a (possibly opaque) PSA key instead of
Manuel Pégourié-Gonnard392dc042018-11-13 10:48:23 +0100410 * storing and manipulating the key material directly.
411 *
412 * \param ctx The context to initialize. It must be empty (type NONE).
Neil Armstrongb3547422022-03-22 10:22:28 +0100413 * \param key The PSA key to wrap, which must hold an ECC or RSA key
414 * pair (see notes below).
Manuel Pégourié-Gonnard20678b22018-10-22 12:11:15 +0200415 *
Gilles Peskine11392492019-05-27 14:53:19 +0200416 * \note The wrapped key must remain valid as long as the
Manuel Pégourié-Gonnard01a12c42018-10-31 10:28:01 +0100417 * wrapping PK context is in use, that is at least between
418 * the point this function is called and the point
419 * mbedtls_pk_free() is called on this context. The wrapped
Gilles Peskine11392492019-05-27 14:53:19 +0200420 * key might then be independently used or destroyed.
Manuel Pégourié-Gonnard01a12c42018-10-31 10:28:01 +0100421 *
Neil Armstrongb3547422022-03-22 10:22:28 +0100422 * \note This function is currently only available for ECC or RSA
423 * key pairs (that is, keys containing private key material).
Manuel Pégourié-Gonnard392dc042018-11-13 10:48:23 +0100424 * Support for other key types may be added later.
425 *
426 * \return \c 0 on success.
Manuel Pégourié-Gonnard920c0632018-10-31 10:57:29 +0100427 * \return #MBEDTLS_ERR_PK_BAD_INPUT_DATA on invalid input
Ronald Croncf56a0a2020-08-04 09:51:30 +0200428 * (context already used, invalid key identifier).
Manuel Pégourié-Gonnard920c0632018-10-31 10:57:29 +0100429 * \return #MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE if the key is not an
Manuel Pégourié-Gonnard392dc042018-11-13 10:48:23 +0100430 * ECC key pair.
Manuel Pégourié-Gonnard920c0632018-10-31 10:57:29 +0100431 * \return #MBEDTLS_ERR_PK_ALLOC_FAILED on allocation failure.
Manuel Pégourié-Gonnard20678b22018-10-22 12:11:15 +0200432 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100433int mbedtls_pk_setup_opaque(mbedtls_pk_context *ctx,
434 const mbedtls_svc_key_id_t key);
Manuel Pégourié-Gonnard20678b22018-10-22 12:11:15 +0200435#endif /* MBEDTLS_USE_PSA_CRYPTO */
436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200437#if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200438/**
Paul Bakker4fc090a2013-09-18 15:43:25 +0200439 * \brief Initialize an RSA-alt context
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200440 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500441 * \param ctx Context to initialize. It must not have been set
442 * up yet (type #MBEDTLS_PK_NONE).
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200443 * \param key RSA key pointer
444 * \param decrypt_func Decryption function
445 * \param sign_func Signing function
Manuel Pégourié-Gonnard01488752014-04-03 22:09:18 +0200446 * \param key_len_func Function returning key length in bytes
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200447 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200448 * \return 0 on success, or MBEDTLS_ERR_PK_BAD_INPUT_DATA if the
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200449 * context wasn't already initialized as RSA_ALT.
450 *
Manuel Pégourié-Gonnardd9e6a3a2015-05-14 19:41:36 +0200451 * \note This function replaces \c mbedtls_pk_setup() for RSA-alt.
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200452 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100453int mbedtls_pk_setup_rsa_alt(mbedtls_pk_context *ctx, void *key,
454 mbedtls_pk_rsa_alt_decrypt_func decrypt_func,
455 mbedtls_pk_rsa_alt_sign_func sign_func,
456 mbedtls_pk_rsa_alt_key_len_func key_len_func);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200457#endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200458
459/**
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200460 * \brief Get the size in bits of the underlying key
461 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500462 * \param ctx The context to query. It must have been initialized.
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200463 *
464 * \return Key size in bits, or 0 on error
465 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100466size_t mbedtls_pk_get_bitlen(const mbedtls_pk_context *ctx);
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200467
468/**
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +0200469 * \brief Get the length in bytes of the underlying key
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500470 *
471 * \param ctx The context to query. It must have been initialized.
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +0200472 *
Paul Bakker4fc090a2013-09-18 15:43:25 +0200473 * \return Key length in bytes, or 0 on error
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +0200474 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100475static inline size_t mbedtls_pk_get_len(const mbedtls_pk_context *ctx)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +0200476{
Gilles Peskine449bd832023-01-11 14:50:10 +0100477 return (mbedtls_pk_get_bitlen(ctx) + 7) / 8;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +0200478}
479
480/**
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200481 * \brief Tell if a context can do the operation given by type
482 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500483 * \param ctx The context to query. It must have been initialized.
484 * \param type The desired type.
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200485 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500486 * \return 1 if the context can do operations on the given type.
487 * \return 0 if the context cannot do the operations on the given
488 * type. This is always the case for a context that has
489 * been initialized but not set up, or that has been
490 * cleared with mbedtls_pk_free().
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200491 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100492int mbedtls_pk_can_do(const mbedtls_pk_context *ctx, mbedtls_pk_type_t type);
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200493
Neil Armstrong0b529582022-05-11 10:10:20 +0200494#if defined(MBEDTLS_USE_PSA_CRYPTO)
495/**
Neil Armstrongcec133a2022-05-17 11:56:01 +0200496 * \brief Tell if context can do the operation given by PSA algorithm
Neil Armstrong0b529582022-05-11 10:10:20 +0200497 *
498 * \param ctx The context to query. It must have been initialized.
499 * \param alg PSA algorithm to check against, the following are allowed:
500 * PSA_ALG_RSA_PKCS1V15_SIGN(hash),
501 * PSA_ALG_RSA_PSS(hash),
502 * PSA_ALG_RSA_PKCS1V15_CRYPT,
503 * PSA_ALG_ECDSA(hash),
504 * PSA_ALG_ECDH, where hash is a specific hash.
Neil Armstrong408f6a62022-05-17 14:23:20 +0200505 * \param usage PSA usage flag to check against, must be composed of:
506 * PSA_KEY_USAGE_SIGN_HASH
507 * PSA_KEY_USAGE_DECRYPT
508 * PSA_KEY_USAGE_DERIVE.
509 * Context key must match all passed usage flags.
Neil Armstrong0b529582022-05-11 10:10:20 +0200510 *
Neil Armstrongb2f2b022022-05-20 12:00:56 +0200511 * \warning Since the set of allowed algorithms and usage flags may be
512 * expanded in the future, the return value \c 0 should not
513 * be taken in account for non-allowed algorithms and usage
514 * flags.
515 *
Neil Armstrong0b529582022-05-11 10:10:20 +0200516 * \return 1 if the context can do operations on the given type.
517 * \return 0 if the context cannot do the operations on the given
Neil Armstrongb2f2b022022-05-20 12:00:56 +0200518 * type, for non-allowed algorithms and usage flags, or
519 * for a context that has been initialized but not set up
520 * or that has been cleared with mbedtls_pk_free().
Neil Armstrong0b529582022-05-11 10:10:20 +0200521 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100522int mbedtls_pk_can_do_ext(const mbedtls_pk_context *ctx, psa_algorithm_t alg,
523 psa_key_usage_t usage);
Neil Armstrong0b529582022-05-11 10:10:20 +0200524#endif /* MBEDTLS_USE_PSA_CRYPTO */
525
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200526/**
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200527 * \brief Verify signature (including padding if relevant).
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200528 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500529 * \param ctx The PK context to use. It must have been set up.
Gilles Peskine9dbbc292021-06-22 18:28:13 +0200530 * \param md_alg Hash algorithm used.
531 * This can be #MBEDTLS_MD_NONE if the signature algorithm
532 * does not rely on a hash algorithm (non-deterministic
533 * ECDSA, RSA PKCS#1 v1.5).
534 * For PKCS#1 v1.5, if \p md_alg is #MBEDTLS_MD_NONE, then
535 * \p hash is the DigestInfo structure used by RFC 8017
536 * &sect;9.2 steps 3&ndash;6. If \p md_alg is a valid hash
537 * algorithm then \p hash is the digest itself, and this
538 * function calculates the DigestInfo encoding internally.
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200539 * \param hash Hash of the message to sign
Gilles Peskine9dbbc292021-06-22 18:28:13 +0200540 * \param hash_len Hash length
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200541 * \param sig Signature to verify
542 * \param sig_len Signature length
543 *
544 * \return 0 on success (signature is valid),
Gilles Peskine5114d3e2018-03-30 07:12:15 +0200545 * #MBEDTLS_ERR_PK_SIG_LEN_MISMATCH if there is a valid
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -0500546 * signature in \p sig but its length is less than \p sig_len,
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200547 * or a specific error code.
Manuel Pégourié-Gonnardbfe32ef2013-08-22 14:55:30 +0200548 *
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200549 * \note For RSA keys, the default padding type is PKCS#1 v1.5.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200550 * Use \c mbedtls_pk_verify_ext( MBEDTLS_PK_RSASSA_PSS, ... )
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200551 * to verify RSASSA_PSS signatures.
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200552 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100553int mbedtls_pk_verify(mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg,
554 const unsigned char *hash, size_t hash_len,
555 const unsigned char *sig, size_t sig_len);
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200556
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200557/**
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200558 * \brief Restartable version of \c mbedtls_pk_verify()
559 *
560 * \note Performs the same job as \c mbedtls_pk_verify(), but can
561 * return early and restart according to the limit set with
562 * \c mbedtls_ecp_set_max_ops() to reduce blocking for ECC
563 * operations. For RSA, same as \c mbedtls_pk_verify().
564 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500565 * \param ctx The PK context to use. It must have been set up.
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200566 * \param md_alg Hash algorithm used (see notes)
567 * \param hash Hash of the message to sign
568 * \param hash_len Hash length or 0 (see notes)
569 * \param sig Signature to verify
570 * \param sig_len Signature length
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200571 * \param rs_ctx Restart context (NULL to disable restart)
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200572 *
573 * \return See \c mbedtls_pk_verify(), or
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200574 * \return #MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200575 * operations was reached: see \c mbedtls_ecp_set_max_ops().
576 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100577int mbedtls_pk_verify_restartable(mbedtls_pk_context *ctx,
578 mbedtls_md_type_t md_alg,
579 const unsigned char *hash, size_t hash_len,
580 const unsigned char *sig, size_t sig_len,
581 mbedtls_pk_restart_ctx *rs_ctx);
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200582
583/**
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200584 * \brief Verify signature, with options.
585 * (Includes verification of the padding depending on type.)
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200586 *
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200587 * \param type Signature type (inc. possible padding type) to verify
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200588 * \param options Pointer to type-specific options, or NULL
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500589 * \param ctx The PK context to use. It must have been set up.
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200590 * \param md_alg Hash algorithm used (see notes)
591 * \param hash Hash of the message to sign
592 * \param hash_len Hash length or 0 (see notes)
593 * \param sig Signature to verify
594 * \param sig_len Signature length
595 *
596 * \return 0 on success (signature is valid),
Gilles Peskine5114d3e2018-03-30 07:12:15 +0200597 * #MBEDTLS_ERR_PK_TYPE_MISMATCH if the PK context can't be
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200598 * used for this type of signatures,
Gilles Peskine5114d3e2018-03-30 07:12:15 +0200599 * #MBEDTLS_ERR_PK_SIG_LEN_MISMATCH if there is a valid
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -0500600 * signature in \p sig but its length is less than \p sig_len,
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200601 * or a specific error code.
602 *
603 * \note If hash_len is 0, then the length associated with md_alg
604 * is used instead, or an error returned if it is invalid.
605 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200606 * \note md_alg may be MBEDTLS_MD_NONE, only if hash_len != 0
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200607 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200608 * \note If type is MBEDTLS_PK_RSASSA_PSS, then options must point
609 * to a mbedtls_pk_rsassa_pss_options structure,
Manuel Pégourié-Gonnarda6e02912022-12-21 09:59:33 +0100610 * otherwise it must be NULL. Note that if
611 * #MBEDTLS_USE_PSA_CRYPTO is defined, the salt length is not
612 * verified as PSA_ALG_RSA_PSS_ANY_SALT is used.
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200613 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100614int mbedtls_pk_verify_ext(mbedtls_pk_type_t type, const void *options,
615 mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg,
616 const unsigned char *hash, size_t hash_len,
617 const unsigned char *sig, size_t sig_len);
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200618
619/**
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200620 * \brief Make signature, including padding if relevant.
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200621 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500622 * \param ctx The PK context to use. It must have been set up
623 * with a private key.
Manuel Pégourié-Gonnardbfe32ef2013-08-22 14:55:30 +0200624 * \param md_alg Hash algorithm used (see notes)
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200625 * \param hash Hash of the message to sign
Gilles Peskine9dbbc292021-06-22 18:28:13 +0200626 * \param hash_len Hash length
Gilles Peskineda252be2019-11-05 16:23:49 +0100627 * \param sig Place to write the signature.
628 * It must have enough room for the signature.
629 * #MBEDTLS_PK_SIGNATURE_MAX_SIZE is always enough.
630 * You may use a smaller buffer if it is large enough
631 * given the key type.
Gilles Peskinef00f1522021-06-22 00:09:00 +0200632 * \param sig_size The size of the \p sig buffer in bytes.
Gilles Peskineda252be2019-11-05 16:23:49 +0100633 * \param sig_len On successful return,
634 * the number of bytes written to \p sig.
Manuel Pégourié-Gonnard34d37562021-06-15 11:29:26 +0200635 * \param f_rng RNG function, must not be \c NULL.
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200636 * \param p_rng RNG parameter
637 *
638 * \return 0 on success, or a specific error code.
Manuel Pégourié-Gonnardbfe32ef2013-08-22 14:55:30 +0200639 *
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200640 * \note For RSA keys, the default padding type is PKCS#1 v1.5.
641 * There is no interface in the PK module to make RSASSA-PSS
642 * signatures yet.
643 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200644 * \note For RSA, md_alg may be MBEDTLS_MD_NONE if hash_len != 0.
645 * For ECDSA, md_alg may never be MBEDTLS_MD_NONE.
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200646 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100647int mbedtls_pk_sign(mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg,
648 const unsigned char *hash, size_t hash_len,
649 unsigned char *sig, size_t sig_size, size_t *sig_len,
650 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200651
Jerry Yubc18c232022-03-12 19:40:29 +0800652#if defined(MBEDTLS_PSA_CRYPTO_C)
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200653/**
Jerry Yu406cf272022-03-22 11:33:42 +0800654 * \brief Make signature given a signature type.
Jerry Yud69439a2022-02-24 15:52:15 +0800655 *
Jerry Yu8beb9e12022-03-12 16:23:53 +0800656 * \param pk_type Signature type.
Jerry Yud69439a2022-02-24 15:52:15 +0800657 * \param ctx The PK context to use. It must have been set up
658 * with a private key.
659 * \param md_alg Hash algorithm used (see notes)
660 * \param hash Hash of the message to sign
661 * \param hash_len Hash length
662 * \param sig Place to write the signature.
663 * It must have enough room for the signature.
664 * #MBEDTLS_PK_SIGNATURE_MAX_SIZE is always enough.
665 * You may use a smaller buffer if it is large enough
666 * given the key type.
667 * \param sig_size The size of the \p sig buffer in bytes.
668 * \param sig_len On successful return,
669 * the number of bytes written to \p sig.
670 * \param f_rng RNG function, must not be \c NULL.
671 * \param p_rng RNG parameter
672 *
673 * \return 0 on success, or a specific error code.
674 *
Jerry Yue6e73d62022-03-24 13:05:08 +0800675 * \note When \p pk_type is #MBEDTLS_PK_RSASSA_PSS,
676 * see #PSA_ALG_RSA_PSS for a description of PSS options used.
Jerry Yud69439a2022-02-24 15:52:15 +0800677 *
678 * \note For RSA, md_alg may be MBEDTLS_MD_NONE if hash_len != 0.
679 * For ECDSA, md_alg may never be MBEDTLS_MD_NONE.
680 *
Jerry Yud69439a2022-02-24 15:52:15 +0800681 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100682int mbedtls_pk_sign_ext(mbedtls_pk_type_t pk_type,
683 mbedtls_pk_context *ctx,
684 mbedtls_md_type_t md_alg,
685 const unsigned char *hash, size_t hash_len,
686 unsigned char *sig, size_t sig_size, size_t *sig_len,
687 int (*f_rng)(void *, unsigned char *, size_t),
688 void *p_rng);
Jerry Yubc18c232022-03-12 19:40:29 +0800689#endif /* MBEDTLS_PSA_CRYPTO_C */
Jerry Yud69439a2022-02-24 15:52:15 +0800690
691/**
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200692 * \brief Restartable version of \c mbedtls_pk_sign()
693 *
694 * \note Performs the same job as \c mbedtls_pk_sign(), but can
695 * return early and restart according to the limit set with
696 * \c mbedtls_ecp_set_max_ops() to reduce blocking for ECC
697 * operations. For RSA, same as \c mbedtls_pk_sign().
698 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500699 * \param ctx The PK context to use. It must have been set up
700 * with a private key.
Gilles Peskine9db14fa2019-11-08 18:37:19 +0100701 * \param md_alg Hash algorithm used (see notes for mbedtls_pk_sign())
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200702 * \param hash Hash of the message to sign
Gilles Peskine9dbbc292021-06-22 18:28:13 +0200703 * \param hash_len Hash length
Gilles Peskine9db14fa2019-11-08 18:37:19 +0100704 * \param sig Place to write the signature.
705 * It must have enough room for the signature.
706 * #MBEDTLS_PK_SIGNATURE_MAX_SIZE is always enough.
707 * You may use a smaller buffer if it is large enough
708 * given the key type.
Gilles Peskinef00f1522021-06-22 00:09:00 +0200709 * \param sig_size The size of the \p sig buffer in bytes.
Gilles Peskine9db14fa2019-11-08 18:37:19 +0100710 * \param sig_len On successful return,
711 * the number of bytes written to \p sig.
Manuel Pégourié-Gonnard34d37562021-06-15 11:29:26 +0200712 * \param f_rng RNG function, must not be \c NULL.
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200713 * \param p_rng RNG parameter
Manuel Pégourié-Gonnard15d7df22017-08-17 14:33:31 +0200714 * \param rs_ctx Restart context (NULL to disable restart)
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200715 *
Gilles Peskine9db14fa2019-11-08 18:37:19 +0100716 * \return See \c mbedtls_pk_sign().
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200717 * \return #MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200718 * operations was reached: see \c mbedtls_ecp_set_max_ops().
719 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100720int mbedtls_pk_sign_restartable(mbedtls_pk_context *ctx,
721 mbedtls_md_type_t md_alg,
722 const unsigned char *hash, size_t hash_len,
723 unsigned char *sig, size_t sig_size, size_t *sig_len,
724 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
725 mbedtls_pk_restart_ctx *rs_ctx);
Manuel Pégourié-Gonnard82cb27b2017-05-03 10:59:45 +0200726
727/**
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200728 * \brief Decrypt message (including padding if relevant).
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200729 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500730 * \param ctx The PK context to use. It must have been set up
731 * with a private key.
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200732 * \param input Input to decrypt
733 * \param ilen Input size
734 * \param output Decrypted output
Paul Bakker4fc090a2013-09-18 15:43:25 +0200735 * \param olen Decrypted message length
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200736 * \param osize Size of the output buffer
Manuel Pégourié-Gonnard34d37562021-06-15 11:29:26 +0200737 * \param f_rng RNG function, must not be \c NULL.
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +0200738 * \param p_rng RNG parameter
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200739 *
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200740 * \note For RSA keys, the default padding type is PKCS#1 v1.5.
741 *
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200742 * \return 0 on success, or a specific error code.
743 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100744int mbedtls_pk_decrypt(mbedtls_pk_context *ctx,
745 const unsigned char *input, size_t ilen,
746 unsigned char *output, size_t *olen, size_t osize,
747 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200748
749/**
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200750 * \brief Encrypt message (including padding if relevant).
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200751 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500752 * \param ctx The PK context to use. It must have been set up.
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200753 * \param input Message to encrypt
754 * \param ilen Message size
755 * \param output Encrypted output
756 * \param olen Encrypted output length
757 * \param osize Size of the output buffer
Manuel Pégourié-Gonnard34d37562021-06-15 11:29:26 +0200758 * \param f_rng RNG function, must not be \c NULL.
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +0200759 * \param p_rng RNG parameter
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200760 *
Manuel Pégourié-Gonnard34d37562021-06-15 11:29:26 +0200761 * \note \p f_rng is used for padding generation.
762 *
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200763 * \note For RSA keys, the default padding type is PKCS#1 v1.5.
764 *
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200765 * \return 0 on success, or a specific error code.
766 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100767int mbedtls_pk_encrypt(mbedtls_pk_context *ctx,
768 const unsigned char *input, size_t ilen,
769 unsigned char *output, size_t *olen, size_t osize,
770 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200771
772/**
Manuel Pégourié-Gonnard70bdadf2014-11-06 16:51:20 +0100773 * \brief Check if a public-private pair of keys matches.
774 *
775 * \param pub Context holding a public key.
776 * \param prv Context holding a private (and public) key.
Manuel Pégourié-Gonnard39be1412021-06-15 11:29:26 +0200777 * \param f_rng RNG function, must not be \c NULL.
778 * \param p_rng RNG parameter
Manuel Pégourié-Gonnard70bdadf2014-11-06 16:51:20 +0100779 *
Manuel Pégourié-Gonnardeaeb7b22018-10-24 12:37:44 +0200780 * \return \c 0 on success (keys were checked and match each other).
781 * \return #MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE if the keys could not
782 * be checked - in that case they may or may not match.
783 * \return #MBEDTLS_ERR_PK_BAD_INPUT_DATA if a context is invalid.
784 * \return Another non-zero value if the keys do not match.
Manuel Pégourié-Gonnard70bdadf2014-11-06 16:51:20 +0100785 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100786int mbedtls_pk_check_pair(const mbedtls_pk_context *pub,
787 const mbedtls_pk_context *prv,
788 int (*f_rng)(void *, unsigned char *, size_t),
789 void *p_rng);
Manuel Pégourié-Gonnard70bdadf2014-11-06 16:51:20 +0100790
791/**
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200792 * \brief Export debug information
793 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500794 * \param ctx The PK context to use. It must have been initialized.
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200795 * \param items Place to write debug items
796 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200797 * \return 0 on success or MBEDTLS_ERR_PK_BAD_INPUT_DATA
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200798 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100799int mbedtls_pk_debug(const mbedtls_pk_context *ctx, mbedtls_pk_debug_item *items);
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200800
Manuel Pégourié-Gonnard3fb5c5e2013-08-14 18:26:41 +0200801/**
802 * \brief Access the type name
803 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500804 * \param ctx The PK context to use. It must have been initialized.
Manuel Pégourié-Gonnard3fb5c5e2013-08-14 18:26:41 +0200805 *
806 * \return Type name on success, or "invalid PK"
807 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100808const char *mbedtls_pk_get_name(const mbedtls_pk_context *ctx);
Manuel Pégourié-Gonnard3fb5c5e2013-08-14 18:26:41 +0200809
Manuel Pégourié-Gonnard8053da42013-09-11 22:28:30 +0200810/**
Paul Bakker4fc090a2013-09-18 15:43:25 +0200811 * \brief Get the key type
Manuel Pégourié-Gonnard8053da42013-09-11 22:28:30 +0200812 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500813 * \param ctx The PK context to use. It must have been initialized.
Manuel Pégourié-Gonnard8053da42013-09-11 22:28:30 +0200814 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500815 * \return Type on success.
816 * \return #MBEDTLS_PK_NONE for a context that has not been set up.
Manuel Pégourié-Gonnard8053da42013-09-11 22:28:30 +0200817 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100818mbedtls_pk_type_t mbedtls_pk_get_type(const mbedtls_pk_context *ctx);
Manuel Pégourié-Gonnard8053da42013-09-11 22:28:30 +0200819
Manuel Pégourié-Gonnard22e84de2022-06-10 09:48:38 +0200820#if defined(MBEDTLS_RSA_C)
821/**
822 * Quick access to an RSA context inside a PK context.
823 *
824 * \warning This function can only be used when the type of the context, as
825 * returned by mbedtls_pk_get_type(), is #MBEDTLS_PK_RSA.
826 * Ensuring that is the caller's responsibility.
827 * Alternatively, you can check whether this function returns NULL.
828 *
829 * \return The internal RSA context held by the PK context, or NULL.
830 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100831static inline mbedtls_rsa_context *mbedtls_pk_rsa(const mbedtls_pk_context pk)
Manuel Pégourié-Gonnard22e84de2022-06-10 09:48:38 +0200832{
Gilles Peskine449bd832023-01-11 14:50:10 +0100833 switch (mbedtls_pk_get_type(&pk)) {
Manuel Pégourié-Gonnard4cfaae52022-06-23 09:43:39 +0200834 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100835 return (mbedtls_rsa_context *) (pk).MBEDTLS_PRIVATE(pk_ctx);
Manuel Pégourié-Gonnard4cfaae52022-06-23 09:43:39 +0200836 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100837 return NULL;
Manuel Pégourié-Gonnard4cfaae52022-06-23 09:43:39 +0200838 }
Manuel Pégourié-Gonnard22e84de2022-06-10 09:48:38 +0200839}
840#endif /* MBEDTLS_RSA_C */
841
Valerio Setti229bf102023-05-15 11:13:55 +0200842#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard22e84de2022-06-10 09:48:38 +0200843/**
844 * Quick access to an EC context inside a PK context.
845 *
846 * \warning This function can only be used when the type of the context, as
847 * returned by mbedtls_pk_get_type(), is #MBEDTLS_PK_ECKEY,
848 * #MBEDTLS_PK_ECKEY_DH, or #MBEDTLS_PK_ECDSA.
849 * Ensuring that is the caller's responsibility.
850 * Alternatively, you can check whether this function returns NULL.
851 *
852 * \return The internal EC context held by the PK context, or NULL.
853 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100854static inline mbedtls_ecp_keypair *mbedtls_pk_ec(const mbedtls_pk_context pk)
Manuel Pégourié-Gonnard22e84de2022-06-10 09:48:38 +0200855{
Gilles Peskine449bd832023-01-11 14:50:10 +0100856 switch (mbedtls_pk_get_type(&pk)) {
Manuel Pégourié-Gonnard4cfaae52022-06-23 09:43:39 +0200857 case MBEDTLS_PK_ECKEY:
858 case MBEDTLS_PK_ECKEY_DH:
859 case MBEDTLS_PK_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100860 return (mbedtls_ecp_keypair *) (pk).MBEDTLS_PRIVATE(pk_ctx);
Manuel Pégourié-Gonnard4cfaae52022-06-23 09:43:39 +0200861 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100862 return NULL;
Manuel Pégourié-Gonnard4cfaae52022-06-23 09:43:39 +0200863 }
Manuel Pégourié-Gonnard22e84de2022-06-10 09:48:38 +0200864}
Valerio Setti229bf102023-05-15 11:13:55 +0200865#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard22e84de2022-06-10 09:48:38 +0200866
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200867#if defined(MBEDTLS_PK_PARSE_C)
Paul Bakkerff3a5182013-09-16 22:42:19 +0200868/** \ingroup pk_module */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200869/**
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200870 * \brief Parse a private key in PEM or DER format
Paul Bakker1a7550a2013-09-15 13:01:22 +0200871 *
Gilles Peskine5b7e1642022-08-04 23:44:59 +0200872 * \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto
873 * subsystem must have been initialized by calling
874 * psa_crypto_init() before calling this function.
875 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500876 * \param ctx The PK context to fill. It must have been initialized
877 * but not set up.
878 * \param key Input buffer to parse.
879 * The buffer must contain the input exactly, with no
880 * extra trailing material. For PEM, the buffer must
881 * contain a null-terminated string.
882 * \param keylen Size of \b key in bytes.
883 * For PEM data, this includes the terminating null byte,
884 * so \p keylen must be equal to `strlen(key) + 1`.
885 * \param pwd Optional password for decryption.
886 * Pass \c NULL if expecting a non-encrypted key.
887 * Pass a string of \p pwdlen bytes if expecting an encrypted
888 * key; a non-encrypted key will also be accepted.
889 * The empty password is not supported.
890 * \param pwdlen Size of the password in bytes.
891 * Ignored if \p pwd is \c NULL.
Manuel Pégourié-Gonnard84dea012021-06-15 11:29:26 +0200892 * \param f_rng RNG function, must not be \c NULL. Used for blinding.
893 * \param p_rng RNG parameter
Paul Bakker1a7550a2013-09-15 13:01:22 +0200894 *
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100895 * \note On entry, ctx must be empty, either freshly initialised
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896 * with mbedtls_pk_init() or reset with mbedtls_pk_free(). If you need a
897 * specific key type, check the result with mbedtls_pk_can_do().
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100898 *
899 * \note The key is also checked for correctness.
900 *
Paul Bakker1a7550a2013-09-15 13:01:22 +0200901 * \return 0 if successful, or a specific PK or PEM error code
902 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100903int mbedtls_pk_parse_key(mbedtls_pk_context *ctx,
904 const unsigned char *key, size_t keylen,
905 const unsigned char *pwd, size_t pwdlen,
906 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
Paul Bakker1a7550a2013-09-15 13:01:22 +0200907
Paul Bakkerff3a5182013-09-16 22:42:19 +0200908/** \ingroup pk_module */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200909/**
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200910 * \brief Parse a public key in PEM or DER format
Paul Bakker1a7550a2013-09-15 13:01:22 +0200911 *
Gilles Peskine5b7e1642022-08-04 23:44:59 +0200912 * \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto
913 * subsystem must have been initialized by calling
914 * psa_crypto_init() before calling this function.
915 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500916 * \param ctx The PK context to fill. It must have been initialized
917 * but not set up.
918 * \param key Input buffer to parse.
919 * The buffer must contain the input exactly, with no
920 * extra trailing material. For PEM, the buffer must
921 * contain a null-terminated string.
922 * \param keylen Size of \b key in bytes.
923 * For PEM data, this includes the terminating null byte,
924 * so \p keylen must be equal to `strlen(key) + 1`.
Paul Bakker1a7550a2013-09-15 13:01:22 +0200925 *
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100926 * \note On entry, ctx must be empty, either freshly initialised
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200927 * with mbedtls_pk_init() or reset with mbedtls_pk_free(). If you need a
928 * specific key type, check the result with mbedtls_pk_can_do().
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100929 *
Valerio Setti78f79d32023-02-07 08:33:26 +0100930 * \note For compressed points, see #MBEDTLS_ECP_PF_COMPRESSED for
931 * limitations.
932 *
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100933 * \note The key is also checked for correctness.
934 *
Paul Bakker1a7550a2013-09-15 13:01:22 +0200935 * \return 0 if successful, or a specific PK or PEM error code
936 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100937int mbedtls_pk_parse_public_key(mbedtls_pk_context *ctx,
938 const unsigned char *key, size_t keylen);
Paul Bakker1a7550a2013-09-15 13:01:22 +0200939
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200940#if defined(MBEDTLS_FS_IO)
Paul Bakkerff3a5182013-09-16 22:42:19 +0200941/** \ingroup pk_module */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200942/**
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200943 * \brief Load and parse a private key
944 *
Gilles Peskine5b7e1642022-08-04 23:44:59 +0200945 * \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto
946 * subsystem must have been initialized by calling
947 * psa_crypto_init() before calling this function.
948 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500949 * \param ctx The PK context to fill. It must have been initialized
950 * but not set up.
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200951 * \param path filename to read the private key from
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500952 * \param password Optional password to decrypt the file.
953 * Pass \c NULL if expecting a non-encrypted key.
954 * Pass a null-terminated string if expecting an encrypted
955 * key; a non-encrypted key will also be accepted.
956 * The empty password is not supported.
Manuel Pégourié-Gonnard84dea012021-06-15 11:29:26 +0200957 * \param f_rng RNG function, must not be \c NULL. Used for blinding.
958 * \param p_rng RNG parameter
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200959 *
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100960 * \note On entry, ctx must be empty, either freshly initialised
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961 * with mbedtls_pk_init() or reset with mbedtls_pk_free(). If you need a
962 * specific key type, check the result with mbedtls_pk_can_do().
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100963 *
964 * \note The key is also checked for correctness.
965 *
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200966 * \return 0 if successful, or a specific PK or PEM error code
967 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100968int mbedtls_pk_parse_keyfile(mbedtls_pk_context *ctx,
969 const char *path, const char *password,
970 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200971
Paul Bakkerff3a5182013-09-16 22:42:19 +0200972/** \ingroup pk_module */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200973/**
Paul Bakker1a7550a2013-09-15 13:01:22 +0200974 * \brief Load and parse a public key
975 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500976 * \param ctx The PK context to fill. It must have been initialized
977 * but not set up.
Simon Butcher295639b2016-05-10 19:39:36 +0100978 * \param path filename to read the public key from
Paul Bakker1a7550a2013-09-15 13:01:22 +0200979 *
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100980 * \note On entry, ctx must be empty, either freshly initialised
Simon Butcher295639b2016-05-10 19:39:36 +0100981 * with mbedtls_pk_init() or reset with mbedtls_pk_free(). If
982 * you need a specific key type, check the result with
983 * mbedtls_pk_can_do().
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100984 *
985 * \note The key is also checked for correctness.
986 *
Paul Bakker1a7550a2013-09-15 13:01:22 +0200987 * \return 0 if successful, or a specific PK or PEM error code
988 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100989int mbedtls_pk_parse_public_keyfile(mbedtls_pk_context *ctx, const char *path);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200990#endif /* MBEDTLS_FS_IO */
991#endif /* MBEDTLS_PK_PARSE_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200992
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200993#if defined(MBEDTLS_PK_WRITE_C)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200994/**
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200995 * \brief Write a private key to a PKCS#1 or SEC1 DER structure
996 * Note: data is written at the end of the buffer! Use the
997 * return value to determine where you should start
998 * using the buffer
999 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001000 * \param ctx PK context which must contain a valid private key.
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001001 * \param buf buffer to write to
1002 * \param size size of the buffer
1003 *
1004 * \return length of data written if successful, or a specific
1005 * error code
1006 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001007int mbedtls_pk_write_key_der(const mbedtls_pk_context *ctx, unsigned char *buf, size_t size);
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001008
1009/**
1010 * \brief Write a public key to a SubjectPublicKeyInfo DER structure
1011 * Note: data is written at the end of the buffer! Use the
1012 * return value to determine where you should start
1013 * using the buffer
1014 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001015 * \param ctx PK context which must contain a valid public or private key.
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001016 * \param buf buffer to write to
1017 * \param size size of the buffer
1018 *
1019 * \return length of data written if successful, or a specific
1020 * error code
1021 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001022int mbedtls_pk_write_pubkey_der(const mbedtls_pk_context *ctx, unsigned char *buf, size_t size);
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001023
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001024#if defined(MBEDTLS_PEM_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001025/**
1026 * \brief Write a public key to a PEM string
1027 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001028 * \param ctx PK context which must contain a valid public or private key.
1029 * \param buf Buffer to write to. The output includes a
1030 * terminating null byte.
1031 * \param size Size of the buffer in bytes.
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001032 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +02001033 * \return 0 if successful, or a specific error code
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001034 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001035int mbedtls_pk_write_pubkey_pem(const mbedtls_pk_context *ctx, unsigned char *buf, size_t size);
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001036
1037/**
1038 * \brief Write a private key to a PKCS#1 or SEC1 PEM string
1039 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001040 * \param ctx PK context which must contain a valid private key.
1041 * \param buf Buffer to write to. The output includes a
1042 * terminating null byte.
1043 * \param size Size of the buffer in bytes.
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001044 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +02001045 * \return 0 if successful, or a specific error code
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001046 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001047int 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 +02001048#endif /* MBEDTLS_PEM_WRITE_C */
1049#endif /* MBEDTLS_PK_WRITE_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001050
1051/*
1052 * WARNING: Low-level functions. You probably do not want to use these unless
1053 * you are certain you do ;)
1054 */
1055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056#if defined(MBEDTLS_PK_PARSE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001057/**
Paul Bakker1a7550a2013-09-15 13:01:22 +02001058 * \brief Parse a SubjectPublicKeyInfo DER structure
1059 *
1060 * \param p the position in the ASN.1 data
1061 * \param end end of the buffer
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001062 * \param pk The PK context to fill. It must have been initialized
1063 * but not set up.
Paul Bakker1a7550a2013-09-15 13:01:22 +02001064 *
1065 * \return 0 if successful, or a specific PK error code
1066 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001067int mbedtls_pk_parse_subpubkey(unsigned char **p, const unsigned char *end,
1068 mbedtls_pk_context *pk);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001069#endif /* MBEDTLS_PK_PARSE_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +02001070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001071#if defined(MBEDTLS_PK_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001072/**
1073 * \brief Write a subjectPublicKey to ASN.1 data
1074 * Note: function works backwards in data buffer
1075 *
1076 * \param p reference to current position pointer
1077 * \param start start of the buffer (for bounds-checking)
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001078 * \param key PK context which must contain a valid public or private key.
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001079 *
1080 * \return the length written or a negative error code
1081 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001082int mbedtls_pk_write_pubkey(unsigned char **p, unsigned char *start,
1083 const mbedtls_pk_context *key);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001084#endif /* MBEDTLS_PK_WRITE_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001085
Manuel Pégourié-Gonnard9439f932014-11-21 09:49:43 +01001086/*
1087 * Internal module functions. You probably do not want to use these unless you
1088 * know you do.
1089 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090#if defined(MBEDTLS_FS_IO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001091int mbedtls_pk_load_file(const char *path, unsigned char **buf, size_t *n);
Manuel Pégourié-Gonnard9439f932014-11-21 09:49:43 +01001092#endif
1093
Manuel Pégourié-Gonnard347a00e2018-11-19 12:25:37 +01001094#if defined(MBEDTLS_USE_PSA_CRYPTO)
1095/**
Neil Armstrong23143dc2022-04-21 11:33:54 +02001096 * \brief Turn an EC or RSA key into an opaque one.
Manuel Pégourié-Gonnard347a00e2018-11-19 12:25:37 +01001097 *
1098 * \warning This is a temporary utility function for tests. It might
1099 * change or be removed at any time without notice.
1100 *
Neil Armstrong23143dc2022-04-21 11:33:54 +02001101 * \param pk Input: the EC or RSA key to import to a PSA key.
Gilles Peskine11392492019-05-27 14:53:19 +02001102 * Output: a PK context wrapping that PSA key.
Ronald Croncf56a0a2020-08-04 09:51:30 +02001103 * \param key Output: a PSA key identifier.
Gilles Peskine11392492019-05-27 14:53:19 +02001104 * It's the caller's responsibility to call
Ronald Croncf56a0a2020-08-04 09:51:30 +02001105 * psa_destroy_key() on that key identifier after calling
Gilles Peskine11392492019-05-27 14:53:19 +02001106 * mbedtls_pk_free() on the PK context.
Neil Armstronga1fc18f2022-04-22 13:57:14 +02001107 * \param alg The algorithm to allow for use with that key.
1108 * \param usage The usage to allow for use with that key.
1109 * \param alg2 The secondary algorithm to allow for use with that key.
Manuel Pégourié-Gonnard347a00e2018-11-19 12:25:37 +01001110 *
1111 * \return \c 0 if successful.
1112 * \return An Mbed TLS error code otherwise.
1113 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001114int mbedtls_pk_wrap_as_opaque(mbedtls_pk_context *pk,
1115 mbedtls_svc_key_id_t *key,
1116 psa_algorithm_t alg,
1117 psa_key_usage_t usage,
1118 psa_algorithm_t alg2);
Manuel Pégourié-Gonnard347a00e2018-11-19 12:25:37 +01001119#endif /* MBEDTLS_USE_PSA_CRYPTO */
1120
Paul Bakkered27a042013-04-18 22:46:23 +02001121#ifdef __cplusplus
1122}
1123#endif
1124
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001125#endif /* MBEDTLS_PK_H */