blob: e208da232173c928832887c74ae4a0aa7065aaac [file] [log] [blame]
Paul Bakkered27a042013-04-18 22:46:23 +02001/**
2 * \file pk.h
3 *
Gilles Peskinebadc5292017-09-21 14:56:36 +02004 * \brief Public Key cryptography abstraction layer
Paul Bakkered27a042013-04-18 22:46:23 +02005 *
Manuel Pégourié-Gonnard6fb81872015-07-27 11:11:48 +02006 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02007 * SPDX-License-Identifier: Apache-2.0
8 *
9 * Licensed under the Apache License, Version 2.0 (the "License"); you may
10 * not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
12 *
13 * http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
17 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
Paul Bakkered27a042013-04-18 22:46:23 +020020 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000021 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakkered27a042013-04-18 22:46:23 +020022 */
Manuel Pégourié-Gonnardd73b3c12013-08-12 17:06:05 +020023
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020024#ifndef MBEDTLS_PK_H
25#define MBEDTLS_PK_H
Paul Bakkered27a042013-04-18 22:46:23 +020026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if !defined(MBEDTLS_CONFIG_FILE)
Manuel Pégourié-Gonnard244569f2013-07-10 09:46:30 +020028#include "config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020029#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020030#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020031#endif
Manuel Pégourié-Gonnard244569f2013-07-10 09:46:30 +020032
Manuel Pégourié-Gonnardf73da022013-08-17 14:36:32 +020033#include "md.h"
34
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020035#if defined(MBEDTLS_RSA_C)
Manuel Pégourié-Gonnard244569f2013-07-10 09:46:30 +020036#include "rsa.h"
37#endif
38
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020039#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnardd73b3c12013-08-12 17:06:05 +020040#include "ecp.h"
41#endif
42
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020043#if defined(MBEDTLS_ECDSA_C)
Manuel Pégourié-Gonnard211a64c2013-08-09 15:04:26 +020044#include "ecdsa.h"
45#endif
46
Manuel Pégourié-Gonnard2ac9c602015-10-05 16:18:23 +010047#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
48 !defined(inline) && !defined(__cplusplus)
49#define inline __inline
50#endif
51
Gilles Peskinebadc5292017-09-21 14:56:36 +020052/** \name Error codes */
53/**@{*/
54
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +020055#define MBEDTLS_ERR_PK_ALLOC_FAILED -0x3F80 /**< Memory allocation failed. */
Manuel Pégourié-Gonnardeed55a42015-04-09 17:31:59 +020056#define MBEDTLS_ERR_PK_TYPE_MISMATCH -0x3F00 /**< Type mismatch, eg attempt to encrypt with an ECDSA key */
57#define MBEDTLS_ERR_PK_BAD_INPUT_DATA -0x3E80 /**< Bad input parameters to function. */
58#define MBEDTLS_ERR_PK_FILE_IO_ERROR -0x3E00 /**< Read/write of file failed. */
59#define MBEDTLS_ERR_PK_KEY_INVALID_VERSION -0x3D80 /**< Unsupported key version */
60#define MBEDTLS_ERR_PK_KEY_INVALID_FORMAT -0x3D00 /**< Invalid key tag or value. */
61#define MBEDTLS_ERR_PK_UNKNOWN_PK_ALG -0x3C80 /**< Key algorithm is unsupported (only RSA and EC are supported). */
62#define MBEDTLS_ERR_PK_PASSWORD_REQUIRED -0x3C00 /**< Private key password can't be empty. */
63#define MBEDTLS_ERR_PK_PASSWORD_MISMATCH -0x3B80 /**< Given private key password does not allow for correct decryption. */
64#define MBEDTLS_ERR_PK_INVALID_PUBKEY -0x3B00 /**< The pubkey tag or value is invalid (only RSA and EC are supported). */
65#define MBEDTLS_ERR_PK_INVALID_ALG -0x3A80 /**< The algorithm tag or value is invalid. */
66#define MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE -0x3A00 /**< Elliptic curve is unsupported (only NIST curves are supported). */
67#define MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE -0x3980 /**< Unavailable feature, e.g. RSA disabled for RSA key. */
68#define MBEDTLS_ERR_PK_SIG_LEN_MISMATCH -0x3900 /**< The signature is valid but its length is less than expected. */
Paul Bakker1a7550a2013-09-15 13:01:22 +020069
Gilles Peskinebadc5292017-09-21 14:56:36 +020070/**@}*/
71
Paul Bakkered27a042013-04-18 22:46:23 +020072#ifdef __cplusplus
73extern "C" {
74#endif
75
Gilles Peskinebadc5292017-09-21 14:56:36 +020076/** \name Asymmetric cryptography operation contexts */
77/**@{*/
78
Paul Bakkered27a042013-04-18 22:46:23 +020079/**
Gilles Peskinebadc5292017-09-21 14:56:36 +020080 * \brief Asymmetric operation context types
Paul Bakkered27a042013-04-18 22:46:23 +020081 */
82typedef enum {
Gilles Peskinebadc5292017-09-21 14:56:36 +020083 MBEDTLS_PK_NONE=0, /**< Unused context object */
84 MBEDTLS_PK_RSA, /**< RSA key pair (normal software implementation) with PKCS#1 v1.5 or PSS context */
85 MBEDTLS_PK_ECKEY, /**< ECC key pair with ECDSA context */
86 MBEDTLS_PK_ECKEY_DH, /**< ECC key pair with ECDH context */
87 MBEDTLS_PK_ECDSA, /**< ECC key pair with ECDSA context */
88 MBEDTLS_PK_RSA_ALT, /**< RSA (alternative implementation) */
89 MBEDTLS_PK_RSASSA_PSS, /**< RSA key pair; same context as MBEDTLS_PK_RSA, but used to represent keys with the algorithm identifier id-RSASSA-PSS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020090} mbedtls_pk_type_t;
Paul Bakkered27a042013-04-18 22:46:23 +020091
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +020092/**
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +020093 * \brief Options for RSASSA-PSS signature verification.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020094 * See \c mbedtls_rsa_rsassa_pss_verify_ext()
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +020095 */
96typedef struct
97{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020098 mbedtls_md_type_t mgf1_hash_id;
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +020099 int expected_salt_len;
100
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200101} mbedtls_pk_rsassa_pss_options;
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200102
103/**
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200104 * \brief Types for interfacing with the debug module
105 */
106typedef enum
107{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200108 MBEDTLS_PK_DEBUG_NONE = 0,
109 MBEDTLS_PK_DEBUG_MPI,
110 MBEDTLS_PK_DEBUG_ECP,
111} mbedtls_pk_debug_type;
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200112
113/**
114 * \brief Item to send to the debug module
115 */
116typedef struct
117{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200118 mbedtls_pk_debug_type type;
Paul Bakkerfcc17212013-10-11 09:36:52 +0200119 const char *name;
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200120 void *value;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200121} mbedtls_pk_debug_item;
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200122
123/** Maximum number of item send for debugging, plus 1 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200124#define MBEDTLS_PK_DEBUG_MAX_ITEMS 3
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200125
126/**
Gilles Peskinebadc5292017-09-21 14:56:36 +0200127 * \brief Key pair information and operations
Manuel Pégourié-Gonnardd73b3c12013-08-12 17:06:05 +0200128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129typedef struct mbedtls_pk_info_t mbedtls_pk_info_t;
Manuel Pégourié-Gonnardd73b3c12013-08-12 17:06:05 +0200130
131/**
Gilles Peskinebadc5292017-09-21 14:56:36 +0200132 * \brief Key pair container
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200133 */
134typedef struct
135{
Gilles Peskinebadc5292017-09-21 14:56:36 +0200136 const mbedtls_pk_info_t * pk_info; /**< Algorithm information */
137 void * pk_ctx; /**< Underlying key pair context */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200138} mbedtls_pk_context;
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200139
Manuel Pégourié-Gonnarda79efde2015-04-09 10:58:56 +0200140#if defined(MBEDTLS_RSA_C)
141/**
142 * Quick access to an RSA context inside a PK context.
143 *
144 * \warning You must make sure the PK context actually holds an RSA context
Gilles Peskinebadc5292017-09-21 14:56:36 +0200145 * before using this function! This function is only valid if
146 * `pk_can_do(&pk, MBEDTLS_PK_RSA)` is true.
Manuel Pégourié-Gonnarda79efde2015-04-09 10:58:56 +0200147 */
148static inline mbedtls_rsa_context *mbedtls_pk_rsa( const mbedtls_pk_context pk )
149{
150 return( (mbedtls_rsa_context *) (pk).pk_ctx );
151}
152#endif /* MBEDTLS_RSA_C */
153
154#if defined(MBEDTLS_ECP_C)
155/**
156 * Quick access to an EC context inside a PK context.
157 *
158 * \warning You must make sure the PK context actually holds an EC context
Gilles Peskinebadc5292017-09-21 14:56:36 +0200159 * before using this function! This function is only valid if
160 * `pk_can_do(&pk, MBEDTLS_PK_ECKEY)` is true.
Manuel Pégourié-Gonnarda79efde2015-04-09 10:58:56 +0200161 */
162static inline mbedtls_ecp_keypair *mbedtls_pk_ec( const mbedtls_pk_context pk )
163{
164 return( (mbedtls_ecp_keypair *) (pk).pk_ctx );
165}
166#endif /* MBEDTLS_ECP_C */
167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200168#if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200169/**
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200170 * \brief Types for RSA-alt abstraction
171 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200172typedef int (*mbedtls_pk_rsa_alt_decrypt_func)( void *ctx, int mode, size_t *olen,
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200173 const unsigned char *input, unsigned char *output,
174 size_t output_max_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200175typedef int (*mbedtls_pk_rsa_alt_sign_func)( void *ctx,
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200176 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200177 int mode, mbedtls_md_type_t md_alg, unsigned int hashlen,
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200178 const unsigned char *hash, unsigned char *sig );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200179typedef size_t (*mbedtls_pk_rsa_alt_key_len_func)( void *ctx );
180#endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200181
182/**
Gilles Peskinebadc5292017-09-21 14:56:36 +0200183 * \brief Return default information associated with the given PK type
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200184 *
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +0200185 * \param pk_type PK type to search for.
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200186 *
Gilles Peskinebadc5292017-09-21 14:56:36 +0200187 * \note Different PK objects with the same type may have different
188 * information. This function returns the information needed
189 * to create a object with the default implementation
190 * for the given PK operation type (rsa module for an RSA
191 * context, ecdh module for an ECDH context, ecdsa module for
192 * an ECDSA context).
193 *
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200194 * \return The PK info associated with the type or NULL if not found.
195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200196const mbedtls_pk_info_t *mbedtls_pk_info_from_type( mbedtls_pk_type_t pk_type );
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200197
198/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199 * \brief Initialize a mbedtls_pk_context (as NONE)
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200200 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200201void mbedtls_pk_init( mbedtls_pk_context *ctx );
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200202
203/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200204 * \brief Free a mbedtls_pk_context
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206void mbedtls_pk_free( mbedtls_pk_context *ctx );
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200207
208/**
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200209 * \brief Initialize a PK context with the information given
210 * and allocates the type-specific PK subcontext.
211 *
212 * \param ctx Context to initialize. Must be empty (type NONE).
213 * \param info Information to use
214 *
215 * \return 0 on success,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200216 * MBEDTLS_ERR_PK_BAD_INPUT_DATA on invalid input,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200217 * MBEDTLS_ERR_PK_ALLOC_FAILED on allocation failure.
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200218 *
Gilles Peskinebadc5292017-09-21 14:56:36 +0200219 * \note For contexts holding an RSA-alt key pair, use
Manuel Pégourié-Gonnardd9e6a3a2015-05-14 19:41:36 +0200220 * \c mbedtls_pk_setup_rsa_alt() instead.
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200221 */
Manuel Pégourié-Gonnardd9e6a3a2015-05-14 19:41:36 +0200222int mbedtls_pk_setup( mbedtls_pk_context *ctx, const mbedtls_pk_info_t *info );
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200223
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200224#if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
Manuel Pégourié-Gonnardab466942013-08-15 11:30:27 +0200225/**
Paul Bakker4fc090a2013-09-18 15:43:25 +0200226 * \brief Initialize an RSA-alt context
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200227 *
228 * \param ctx Context to initialize. Must be empty (type NONE).
Gilles Peskinebadc5292017-09-21 14:56:36 +0200229 * \param key RSA key pair pointer
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200230 * \param decrypt_func Decryption function
231 * \param sign_func Signing function
Manuel Pégourié-Gonnard01488752014-04-03 22:09:18 +0200232 * \param key_len_func Function returning key length in bytes
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200233 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * \return 0 on success, or MBEDTLS_ERR_PK_BAD_INPUT_DATA if the
Manuel Pégourié-Gonnard12c1ff02013-08-21 12:28:31 +0200235 * context wasn't already initialized as RSA_ALT.
236 *
Manuel Pégourié-Gonnardd9e6a3a2015-05-14 19:41:36 +0200237 * \note This function replaces \c mbedtls_pk_setup() for RSA-alt.
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200238 */
Manuel Pégourié-Gonnardd9e6a3a2015-05-14 19:41:36 +0200239int mbedtls_pk_setup_rsa_alt( mbedtls_pk_context *ctx, void * key,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240 mbedtls_pk_rsa_alt_decrypt_func decrypt_func,
241 mbedtls_pk_rsa_alt_sign_func sign_func,
242 mbedtls_pk_rsa_alt_key_len_func key_len_func );
243#endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
Manuel Pégourié-Gonnard12e0ed92013-07-04 13:31:32 +0200244
245/**
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200246 * \brief Get the size in bits of the underlying key
247 *
248 * \param ctx Context to use
249 *
250 * \return Key size in bits, or 0 on error
251 */
Manuel Pégourié-Gonnard097c7bb2015-06-18 16:43:38 +0200252size_t mbedtls_pk_get_bitlen( const mbedtls_pk_context *ctx );
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200253
254/**
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +0200255 * \brief Get the length in bytes of the underlying key
256 * \param ctx Context to use
257 *
Gilles Peskinebadc5292017-09-21 14:56:36 +0200258 * \note This returns the minimum number of bytes required to
259 * store the part of the key that defines its size (modulus
260 * for RSA, coordinate for ECC). The way the key is stored
261 * in the context may have a different size.
262 *
Paul Bakker4fc090a2013-09-18 15:43:25 +0200263 * \return Key length in bytes, or 0 on error
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +0200264 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200265static inline size_t mbedtls_pk_get_len( const mbedtls_pk_context *ctx )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +0200266{
Manuel Pégourié-Gonnard097c7bb2015-06-18 16:43:38 +0200267 return( ( mbedtls_pk_get_bitlen( ctx ) + 7 ) / 8 );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +0200268}
269
270/**
Gilles Peskinebadc5292017-09-21 14:56:36 +0200271 * \brief Tell if a context can do the operations given by type
272 *
273 * \note This function can be used to identify the type of key
274 * (e.g. RSA vs ECC), and a superset of permitted
275 * operations. It is possible that this function returns
276 * true but some operations are not allowed. For example
277 * this function always returns true if ctx is an RSA
278 * context and type is MBEDTLS_PK_RSA, but the key may
279 * be restricted to any subset of operations among signature,
280 * verification, encryption and decryption. To determine
281 * which operations a key allow, attempt the operation and
282 * check the return status.
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200283 *
284 * \param ctx Context to test
285 * \param type Target type
286 *
Gilles Peskinebadc5292017-09-21 14:56:36 +0200287 * \return 1 if context can do the operations,
288 * 0 otherwise.
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200289 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200290int mbedtls_pk_can_do( const mbedtls_pk_context *ctx, mbedtls_pk_type_t type );
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200291
292/**
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200293 * \brief Verify signature (including padding if relevant).
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200294 *
295 * \param ctx PK context to use
Manuel Pégourié-Gonnardbfe32ef2013-08-22 14:55:30 +0200296 * \param md_alg Hash algorithm used (see notes)
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200297 * \param hash Hash of the message to sign
Manuel Pégourié-Gonnardbfe32ef2013-08-22 14:55:30 +0200298 * \param hash_len Hash length or 0 (see notes)
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200299 * \param sig Signature to verify
300 * \param sig_len Signature length
301 *
302 * \return 0 on success (signature is valid),
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200303 * MBEDTLS_ERR_PK_SIG_LEN_MISMATCH if the signature is
Manuel Pégourié-Gonnard2abed842014-04-08 12:40:15 +0200304 * valid but its actual length is less than sig_len,
Gilles Peskinebadc5292017-09-21 14:56:36 +0200305 * or a type-specific error code.
Manuel Pégourié-Gonnardbfe32ef2013-08-22 14:55:30 +0200306 *
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200307 * \note For RSA keys, the default padding type is PKCS#1 v1.5.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200308 * Use \c mbedtls_pk_verify_ext( MBEDTLS_PK_RSASSA_PSS, ... )
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200309 * to verify RSASSA_PSS signatures.
310 *
Manuel Pégourié-Gonnardbfe32ef2013-08-22 14:55:30 +0200311 * \note If hash_len is 0, then the length associated with md_alg
312 * is used instead, or an error returned if it is invalid.
313 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200314 * \note md_alg may be MBEDTLS_MD_NONE, only if hash_len != 0
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316int mbedtls_pk_verify( mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg,
Manuel Pégourié-Gonnardf73da022013-08-17 14:36:32 +0200317 const unsigned char *hash, size_t hash_len,
Manuel Pégourié-Gonnardb3d91872013-08-14 15:56:19 +0200318 const unsigned char *sig, size_t sig_len );
319
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200320/**
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200321 * \brief Verify signature, with options.
322 * (Includes verification of the padding depending on type.)
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200323 *
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200324 * \param type Signature type (inc. possible padding type) to verify
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200325 * \param options Pointer to type-specific options, or NULL
326 * \param ctx PK context to use
327 * \param md_alg Hash algorithm used (see notes)
328 * \param hash Hash of the message to sign
329 * \param hash_len Hash length or 0 (see notes)
330 * \param sig Signature to verify
331 * \param sig_len Signature length
332 *
333 * \return 0 on success (signature is valid),
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200334 * MBEDTLS_ERR_PK_TYPE_MISMATCH if the PK context can't be
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200335 * used for this type of signatures,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200336 * MBEDTLS_ERR_PK_SIG_LEN_MISMATCH if the signature is
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200337 * valid but its actual length is less than sig_len,
Gilles Peskinebadc5292017-09-21 14:56:36 +0200338 * or a type-specific error code.
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200339 *
340 * \note If hash_len is 0, then the length associated with md_alg
341 * is used instead, or an error returned if it is invalid.
342 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200343 * \note md_alg may be MBEDTLS_MD_NONE, only if hash_len != 0
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200344 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200345 * \note If type is MBEDTLS_PK_RSASSA_PSS, then options must point
346 * to a mbedtls_pk_rsassa_pss_options structure,
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200347 * otherwise it must be NULL.
348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200349int mbedtls_pk_verify_ext( mbedtls_pk_type_t type, const void *options,
350 mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg,
Manuel Pégourié-Gonnard20422e92014-06-05 13:41:44 +0200351 const unsigned char *hash, size_t hash_len,
352 const unsigned char *sig, size_t sig_len );
353
354/**
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200355 * \brief Make signature, including padding if relevant.
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200356 *
Manuel Pégourié-Gonnardfb84d382015-10-30 10:56:25 +0100357 * \param ctx PK context to use - must hold a private key
Manuel Pégourié-Gonnardbfe32ef2013-08-22 14:55:30 +0200358 * \param md_alg Hash algorithm used (see notes)
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200359 * \param hash Hash of the message to sign
Manuel Pégourié-Gonnardbfe32ef2013-08-22 14:55:30 +0200360 * \param hash_len Hash length or 0 (see notes)
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200361 * \param sig Place to write the signature
362 * \param sig_len Number of bytes written
363 * \param f_rng RNG function
364 * \param p_rng RNG parameter
365 *
Gilles Peskinebadc5292017-09-21 14:56:36 +0200366 * \return 0 on success, or a type-specific error code.
Manuel Pégourié-Gonnardbfe32ef2013-08-22 14:55:30 +0200367 *
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200368 * \note For RSA keys, the default padding type is PKCS#1 v1.5.
369 * There is no interface in the PK module to make RSASSA-PSS
370 * signatures yet.
371 *
Manuel Pégourié-Gonnardbfe32ef2013-08-22 14:55:30 +0200372 * \note If hash_len is 0, then the length associated with md_alg
373 * is used instead, or an error returned if it is invalid.
374 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375 * \note For RSA, md_alg may be MBEDTLS_MD_NONE if hash_len != 0.
376 * For ECDSA, md_alg may never be MBEDTLS_MD_NONE.
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200378int mbedtls_pk_sign( mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg,
Manuel Pégourié-Gonnard8df27692013-08-21 10:34:38 +0200379 const unsigned char *hash, size_t hash_len,
380 unsigned char *sig, size_t *sig_len,
381 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
382
383/**
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200384 * \brief Decrypt message (including padding if relevant).
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200385 *
Manuel Pégourié-Gonnardfb84d382015-10-30 10:56:25 +0100386 * \param ctx PK context to use - must hold a private key
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200387 * \param input Input to decrypt
388 * \param ilen Input size
389 * \param output Decrypted output
Paul Bakker4fc090a2013-09-18 15:43:25 +0200390 * \param olen Decrypted message length
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200391 * \param osize Size of the output buffer
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +0200392 * \param f_rng RNG function
393 * \param p_rng RNG parameter
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200394 *
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200395 * \note For RSA keys, the default padding type is PKCS#1 v1.5.
396 *
Gilles Peskinebadc5292017-09-21 14:56:36 +0200397 * \return 0 on success, or a type-specific error code.
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200398 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200399int mbedtls_pk_decrypt( mbedtls_pk_context *ctx,
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200400 const unsigned char *input, size_t ilen,
401 unsigned char *output, size_t *olen, size_t osize,
402 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
403
404/**
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200405 * \brief Encrypt message (including padding if relevant).
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200406 *
407 * \param ctx PK context to use
408 * \param input Message to encrypt
409 * \param ilen Message size
410 * \param output Encrypted output
411 * \param olen Encrypted output length
412 * \param osize Size of the output buffer
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +0200413 * \param f_rng RNG function
414 * \param p_rng RNG parameter
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200415 *
Manuel Pégourié-Gonnardd543a582014-06-25 14:04:36 +0200416 * \note For RSA keys, the default padding type is PKCS#1 v1.5.
417 *
Gilles Peskinebadc5292017-09-21 14:56:36 +0200418 * \return 0 on success, or a type-specific error code.
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200419 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200420int mbedtls_pk_encrypt( mbedtls_pk_context *ctx,
Manuel Pégourié-Gonnarda2d3f222013-08-21 11:51:08 +0200421 const unsigned char *input, size_t ilen,
422 unsigned char *output, size_t *olen, size_t osize,
423 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
424
425/**
Manuel Pégourié-Gonnard70bdadf2014-11-06 16:51:20 +0100426 * \brief Check if a public-private pair of keys matches.
427 *
428 * \param pub Context holding a public key.
429 * \param prv Context holding a private (and public) key.
430 *
Gilles Peskinebadc5292017-09-21 14:56:36 +0200431 * \return * 0 on success.
432 * * MBEDTLS_ERR_PK_BAD_INPUT_DATA if one of the contexts
433 * is ill-formed.
434 * * MBEDTLS_ERR_PK_TYPE_MISMATCH if the contexts cannot
435 * represent keys of the same type.
436 * * Or a type-specific error code.
Manuel Pégourié-Gonnard70bdadf2014-11-06 16:51:20 +0100437 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200438int mbedtls_pk_check_pair( const mbedtls_pk_context *pub, const mbedtls_pk_context *prv );
Manuel Pégourié-Gonnard70bdadf2014-11-06 16:51:20 +0100439
440/**
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200441 * \brief Export debug information
442 *
443 * \param ctx Context to use
444 * \param items Place to write debug items
445 *
Gilles Peskinebadc5292017-09-21 14:56:36 +0200446 * \return * 0 on success.
447 * * MBEDTLS_ERR_PK_BAD_INPUT_DATA if the context is ill-formed.
448 * * MBEDTLS_ERR_PK_TYPE_MISMATCH if the context does not
449 * support exporting debug information.
450 * * Or a type-specific error code.
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200451 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200452int mbedtls_pk_debug( const mbedtls_pk_context *ctx, mbedtls_pk_debug_item *items );
Manuel Pégourié-Gonnardc6ac8872013-08-14 18:04:18 +0200453
Manuel Pégourié-Gonnard3fb5c5e2013-08-14 18:26:41 +0200454/**
455 * \brief Access the type name
456 *
457 * \param ctx Context to use
458 *
459 * \return Type name on success, or "invalid PK"
460 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200461const char * mbedtls_pk_get_name( const mbedtls_pk_context *ctx );
Manuel Pégourié-Gonnard3fb5c5e2013-08-14 18:26:41 +0200462
Manuel Pégourié-Gonnard8053da42013-09-11 22:28:30 +0200463/**
Paul Bakker4fc090a2013-09-18 15:43:25 +0200464 * \brief Get the key type
Manuel Pégourié-Gonnard8053da42013-09-11 22:28:30 +0200465 *
466 * \param ctx Context to use
467 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200468 * \return Type on success, or MBEDTLS_PK_NONE
Manuel Pégourié-Gonnard8053da42013-09-11 22:28:30 +0200469 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200470mbedtls_pk_type_t mbedtls_pk_get_type( const mbedtls_pk_context *ctx );
Manuel Pégourié-Gonnard8053da42013-09-11 22:28:30 +0200471
Gilles Peskinebadc5292017-09-21 14:56:36 +0200472/**@}*/
473
474
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200475#if defined(MBEDTLS_PK_PARSE_C)
Paul Bakkerff3a5182013-09-16 22:42:19 +0200476/** \ingroup pk_module */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200477/**
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200478 * \brief Parse a private key in PEM or DER format
Paul Bakker1a7550a2013-09-15 13:01:22 +0200479 *
480 * \param ctx key to be initialized
481 * \param key input buffer
482 * \param keylen size of the buffer
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200483 * (including the terminating null byte for PEM data)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200484 * \param pwd password for decryption (optional)
485 * \param pwdlen size of the password
486 *
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100487 * \note On entry, ctx must be empty, either freshly initialised
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200488 * with mbedtls_pk_init() or reset with mbedtls_pk_free(). If you need a
489 * specific key type, check the result with mbedtls_pk_can_do().
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100490 *
491 * \note The key is also checked for correctness.
492 *
Paul Bakker1a7550a2013-09-15 13:01:22 +0200493 * \return 0 if successful, or a specific PK or PEM error code
494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200495int mbedtls_pk_parse_key( mbedtls_pk_context *ctx,
Paul Bakker1a7550a2013-09-15 13:01:22 +0200496 const unsigned char *key, size_t keylen,
497 const unsigned char *pwd, size_t pwdlen );
498
Paul Bakkerff3a5182013-09-16 22:42:19 +0200499/** \ingroup pk_module */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200500/**
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200501 * \brief Parse a public key in PEM or DER format
Paul Bakker1a7550a2013-09-15 13:01:22 +0200502 *
503 * \param ctx key to be initialized
504 * \param key input buffer
505 * \param keylen size of the buffer
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200506 * (including the terminating null byte for PEM data)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200507 *
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100508 * \note On entry, ctx must be empty, either freshly initialised
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200509 * with mbedtls_pk_init() or reset with mbedtls_pk_free(). If you need a
510 * specific key type, check the result with mbedtls_pk_can_do().
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100511 *
512 * \note The key is also checked for correctness.
513 *
Paul Bakker1a7550a2013-09-15 13:01:22 +0200514 * \return 0 if successful, or a specific PK or PEM error code
515 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200516int mbedtls_pk_parse_public_key( mbedtls_pk_context *ctx,
Paul Bakker1a7550a2013-09-15 13:01:22 +0200517 const unsigned char *key, size_t keylen );
518
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200519#if defined(MBEDTLS_FS_IO)
Paul Bakkerff3a5182013-09-16 22:42:19 +0200520/** \ingroup pk_module */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200521/**
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200522 * \brief Load and parse a private key
523 *
524 * \param ctx key to be initialized
525 * \param path filename to read the private key from
526 * \param password password to decrypt the file (can be NULL)
527 *
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100528 * \note On entry, ctx must be empty, either freshly initialised
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200529 * with mbedtls_pk_init() or reset with mbedtls_pk_free(). If you need a
530 * specific key type, check the result with mbedtls_pk_can_do().
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100531 *
532 * \note The key is also checked for correctness.
533 *
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200534 * \return 0 if successful, or a specific PK or PEM error code
535 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200536int mbedtls_pk_parse_keyfile( mbedtls_pk_context *ctx,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200537 const char *path, const char *password );
538
Paul Bakkerff3a5182013-09-16 22:42:19 +0200539/** \ingroup pk_module */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200540/**
Paul Bakker1a7550a2013-09-15 13:01:22 +0200541 * \brief Load and parse a public key
542 *
543 * \param ctx key to be initialized
Simon Butcher295639b2016-05-10 19:39:36 +0100544 * \param path filename to read the public key from
Paul Bakker1a7550a2013-09-15 13:01:22 +0200545 *
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100546 * \note On entry, ctx must be empty, either freshly initialised
Simon Butcher295639b2016-05-10 19:39:36 +0100547 * with mbedtls_pk_init() or reset with mbedtls_pk_free(). If
548 * you need a specific key type, check the result with
549 * mbedtls_pk_can_do().
Manuel Pégourié-Gonnarde3b3d192014-03-13 19:21:49 +0100550 *
551 * \note The key is also checked for correctness.
552 *
Paul Bakker1a7550a2013-09-15 13:01:22 +0200553 * \return 0 if successful, or a specific PK or PEM error code
554 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200555int mbedtls_pk_parse_public_keyfile( mbedtls_pk_context *ctx, const char *path );
556#endif /* MBEDTLS_FS_IO */
557#endif /* MBEDTLS_PK_PARSE_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200558
Gilles Peskinebadc5292017-09-21 14:56:36 +0200559
560
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200561#if defined(MBEDTLS_PK_WRITE_C)
Gilles Peskinebadc5292017-09-21 14:56:36 +0200562/** \name Key pair serialization */
563/**@{*/
564
Paul Bakker1a7550a2013-09-15 13:01:22 +0200565/**
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200566 * \brief Write a private key to a PKCS#1 or SEC1 DER structure
567 * Note: data is written at the end of the buffer! Use the
568 * return value to determine where you should start
569 * using the buffer
570 *
Paul Bakkera36d23e2013-12-30 17:57:27 +0100571 * \param ctx private to write away
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200572 * \param buf buffer to write to
573 * \param size size of the buffer
574 *
575 * \return length of data written if successful, or a specific
576 * error code
577 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200578int mbedtls_pk_write_key_der( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200579
580/**
581 * \brief Write a public key to a SubjectPublicKeyInfo DER structure
582 * Note: data is written at the end of the buffer! Use the
583 * return value to determine where you should start
584 * using the buffer
585 *
Paul Bakkera36d23e2013-12-30 17:57:27 +0100586 * \param ctx public key to write away
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200587 * \param buf buffer to write to
588 * \param size size of the buffer
589 *
590 * \return length of data written if successful, or a specific
591 * error code
592 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200593int mbedtls_pk_write_pubkey_der( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200594
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200595#if defined(MBEDTLS_PEM_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200596/**
597 * \brief Write a public key to a PEM string
598 *
Paul Bakkera36d23e2013-12-30 17:57:27 +0100599 * \param ctx public key to write away
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200600 * \param buf buffer to write to
601 * \param size size of the buffer
602 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +0200603 * \return 0 if successful, or a specific error code
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200604 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200605int mbedtls_pk_write_pubkey_pem( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200606
607/**
608 * \brief Write a private key to a PKCS#1 or SEC1 PEM string
609 *
Paul Bakkera36d23e2013-12-30 17:57:27 +0100610 * \param ctx private to write away
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200611 * \param buf buffer to write to
612 * \param size size of the buffer
613 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +0200614 * \return 0 if successful, or a specific error code
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200616int mbedtls_pk_write_key_pem( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
617#endif /* MBEDTLS_PEM_WRITE_C */
Gilles Peskinebadc5292017-09-21 14:56:36 +0200618/**@}*/
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200619#endif /* MBEDTLS_PK_WRITE_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200620
Gilles Peskinebadc5292017-09-21 14:56:36 +0200621/** \name Low-level functions */
622/**@{*/
623/**
624 * \warning You probably do not want to use these unless you are certain you do ;)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200625 */
626
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200627#if defined(MBEDTLS_PK_PARSE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200628/**
Paul Bakker1a7550a2013-09-15 13:01:22 +0200629 * \brief Parse a SubjectPublicKeyInfo DER structure
630 *
631 * \param p the position in the ASN.1 data
632 * \param end end of the buffer
633 * \param pk the key to fill
634 *
635 * \return 0 if successful, or a specific PK error code
636 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200637int mbedtls_pk_parse_subpubkey( unsigned char **p, const unsigned char *end,
638 mbedtls_pk_context *pk );
639#endif /* MBEDTLS_PK_PARSE_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200640
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200641#if defined(MBEDTLS_PK_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200642/**
643 * \brief Write a subjectPublicKey to ASN.1 data
644 * Note: function works backwards in data buffer
645 *
646 * \param p reference to current position pointer
647 * \param start start of the buffer (for bounds-checking)
648 * \param key public key to write away
649 *
650 * \return the length written or a negative error code
651 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200652int mbedtls_pk_write_pubkey( unsigned char **p, unsigned char *start,
653 const mbedtls_pk_context *key );
654#endif /* MBEDTLS_PK_WRITE_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200655
Manuel Pégourié-Gonnard9439f932014-11-21 09:49:43 +0100656/*
657 * Internal module functions. You probably do not want to use these unless you
658 * know you do.
659 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200660#if defined(MBEDTLS_FS_IO)
661int mbedtls_pk_load_file( const char *path, unsigned char **buf, size_t *n );
Manuel Pégourié-Gonnard9439f932014-11-21 09:49:43 +0100662#endif
663
Gilles Peskinebadc5292017-09-21 14:56:36 +0200664/**@}*/
665
Paul Bakkered27a042013-04-18 22:46:23 +0200666#ifdef __cplusplus
667}
668#endif
669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200670#endif /* MBEDTLS_PK_H */