Go to the documentation of this file.
28 #if !defined(MBEDTLS_CONFIG_FILE)
31 #include MBEDTLS_CONFIG_FILE
36 #if defined(MBEDTLS_RSA_C)
40 #if defined(MBEDTLS_ECP_C)
44 #if defined(MBEDTLS_ECDSA_C)
48 #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
49 !defined(inline) && !defined(__cplusplus)
50 #define inline __inline
53 #define MBEDTLS_ERR_PK_ALLOC_FAILED -0x3F80
54 #define MBEDTLS_ERR_PK_TYPE_MISMATCH -0x3F00
55 #define MBEDTLS_ERR_PK_BAD_INPUT_DATA -0x3E80
56 #define MBEDTLS_ERR_PK_FILE_IO_ERROR -0x3E00
57 #define MBEDTLS_ERR_PK_KEY_INVALID_VERSION -0x3D80
58 #define MBEDTLS_ERR_PK_KEY_INVALID_FORMAT -0x3D00
59 #define MBEDTLS_ERR_PK_UNKNOWN_PK_ALG -0x3C80
60 #define MBEDTLS_ERR_PK_PASSWORD_REQUIRED -0x3C00
61 #define MBEDTLS_ERR_PK_PASSWORD_MISMATCH -0x3B80
62 #define MBEDTLS_ERR_PK_INVALID_PUBKEY -0x3B00
63 #define MBEDTLS_ERR_PK_INVALID_ALG -0x3A80
64 #define MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE -0x3A00
65 #define MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE -0x3980
66 #define MBEDTLS_ERR_PK_SIG_LEN_MISMATCH -0x3900
69 #define MBEDTLS_ERR_PK_HW_ACCEL_FAILED -0x3880
120 #define MBEDTLS_PK_DEBUG_MAX_ITEMS 3
136 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
150 #if defined(MBEDTLS_RSA_C)
163 #if defined(MBEDTLS_ECP_C)
176 #if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
181 const unsigned char *input,
unsigned char *output,
182 size_t output_max_len );
184 int (*f_rng)(
void *,
unsigned char *, size_t),
void *p_rng,
186 const unsigned char *hash,
unsigned char *sig );
215 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
250 #if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
332 const unsigned char *hash,
size_t hash_len,
333 const unsigned char *sig,
size_t sig_len );
357 const unsigned char *hash,
size_t hash_len,
358 const unsigned char *sig,
size_t sig_len,
392 const unsigned char *hash,
size_t hash_len,
393 const unsigned char *sig,
size_t sig_len );
425 const unsigned char *hash,
size_t hash_len,
426 unsigned char *sig,
size_t *sig_len,
427 int (*f_rng)(
void *,
unsigned char *,
size_t),
void *p_rng );
458 const unsigned char *hash,
size_t hash_len,
459 unsigned char *sig,
size_t *sig_len,
460 int (*f_rng)(
void *,
unsigned char *,
size_t),
void *p_rng,
481 const unsigned char *input,
size_t ilen,
482 unsigned char *output,
size_t *olen,
size_t osize,
483 int (*f_rng)(
void *,
unsigned char *,
size_t),
void *p_rng );
502 const unsigned char *input,
size_t ilen,
503 unsigned char *output,
size_t *olen,
size_t osize,
504 int (*f_rng)(
void *,
unsigned char *,
size_t),
void *p_rng );
545 #if defined(MBEDTLS_PK_PARSE_C)
576 const unsigned char *key,
size_t keylen,
577 const unsigned char *pwd,
size_t pwdlen );
602 const unsigned char *key,
size_t keylen );
604 #if defined(MBEDTLS_FS_IO)
627 const char *path,
const char *password );
650 #if defined(MBEDTLS_PK_WRITE_C)
681 #if defined(MBEDTLS_PEM_WRITE_C)
713 #if defined(MBEDTLS_PK_PARSE_C)
728 #if defined(MBEDTLS_PK_WRITE_C)
747 #if defined(MBEDTLS_FS_IO)
int mbedtls_pk_parse_public_keyfile(mbedtls_pk_context *ctx, const char *path)
Load and parse a public key.
struct mbedtls_pk_rsassa_pss_options mbedtls_pk_rsassa_pss_options
Options for RSASSA-PSS signature verification. See mbedtls_rsa_rsassa_pss_verify_ext()
int mbedtls_pk_sign_restartable(mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg, const unsigned char *hash, size_t hash_len, unsigned char *sig, size_t *sig_len, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, mbedtls_pk_restart_ctx *rs_ctx)
Restartable version of mbedtls_pk_sign()
mbedtls_md_type_t
Supported message digests.
int mbedtls_pk_verify_restartable(mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg, const unsigned char *hash, size_t hash_len, const unsigned char *sig, size_t sig_len, mbedtls_pk_restart_ctx *rs_ctx)
Restartable version of mbedtls_pk_verify()
This file provides an API for Elliptic Curves over GF(P) (ECP).
int mbedtls_pk_parse_subpubkey(unsigned char **p, const unsigned char *end, mbedtls_pk_context *pk)
Parse a SubjectPublicKeyInfo DER structure.
This file contains ECDSA definitions and functions.
int mbedtls_pk_can_do(const mbedtls_pk_context *ctx, mbedtls_pk_type_t type)
Tell if a context can do the operation given by type.
Options for RSASSA-PSS signature verification. See mbedtls_rsa_rsassa_pss_verify_ext()
int mbedtls_pk_verify(mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg, const unsigned char *hash, size_t hash_len, const unsigned char *sig, size_t sig_len)
Verify signature (including padding if relevant).
This file contains the generic message-digest wrapper.
int mbedtls_pk_write_pubkey(unsigned char **p, unsigned char *start, const mbedtls_pk_context *key)
Write a subjectPublicKey to ASN.1 data Note: function works backwards in data buffer.
int mbedtls_pk_parse_keyfile(mbedtls_pk_context *ctx, const char *path, const char *password)
Load and parse a private key.
mbedtls_pk_type_t mbedtls_pk_get_type(const mbedtls_pk_context *ctx)
Get the key type.
const mbedtls_pk_info_t * pk_info
int mbedtls_pk_setup(mbedtls_pk_context *ctx, const mbedtls_pk_info_t *info)
Initialize a PK context with the information given and allocates the type-specific PK subcontext.
static mbedtls_ecp_keypair * mbedtls_pk_ec(const mbedtls_pk_context pk)
int mbedtls_pk_parse_public_key(mbedtls_pk_context *ctx, const unsigned char *key, size_t keylen)
Parse a public key in PEM or DER format.
void mbedtls_pk_restart_ctx
size_t(* mbedtls_pk_rsa_alt_key_len_func)(void *ctx)
int mbedtls_pk_debug(const mbedtls_pk_context *ctx, mbedtls_pk_debug_item *items)
Export debug information.
mbedtls_pk_debug_type type
The ECP key-pair structure.
This file provides an API for the RSA public-key cryptosystem.
size_t mbedtls_pk_get_bitlen(const mbedtls_pk_context *ctx)
Get the size in bits of the underlying key.
static size_t mbedtls_pk_get_len(const mbedtls_pk_context *ctx)
Get the length in bytes of the underlying key.
Item to send to the debug module.
int mbedtls_pk_parse_key(mbedtls_pk_context *ctx, const unsigned char *key, size_t keylen, const unsigned char *pwd, size_t pwdlen)
Parse a private key in PEM or DER format.
int mbedtls_pk_decrypt(mbedtls_pk_context *ctx, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen, size_t osize, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Decrypt message (including padding if relevant).
int mbedtls_pk_verify_ext(mbedtls_pk_type_t type, const void *options, mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg, const unsigned char *hash, size_t hash_len, const unsigned char *sig, size_t sig_len)
Verify signature, with options. (Includes verification of the padding depending on type....
mbedtls_pk_type_t
Public key types.
int mbedtls_pk_setup_rsa_alt(mbedtls_pk_context *ctx, void *key, mbedtls_pk_rsa_alt_decrypt_func decrypt_func, mbedtls_pk_rsa_alt_sign_func sign_func, mbedtls_pk_rsa_alt_key_len_func key_len_func)
Initialize an RSA-alt context.
The RSA context structure.
int(* mbedtls_pk_rsa_alt_decrypt_func)(void *ctx, int mode, size_t *olen, const unsigned char *input, unsigned char *output, size_t output_max_len)
Types for RSA-alt abstraction.
mbedtls_md_type_t mgf1_hash_id
int mbedtls_pk_write_pubkey_der(mbedtls_pk_context *ctx, unsigned char *buf, size_t size)
Write a public key to a SubjectPublicKeyInfo DER structure Note: data is written at the end of the bu...
int mbedtls_pk_write_key_der(mbedtls_pk_context *ctx, unsigned char *buf, size_t size)
Write a private key to a PKCS#1 or SEC1 DER structure Note: data is written at the end of the buffer!...
const char * mbedtls_pk_get_name(const mbedtls_pk_context *ctx)
Access the type name.
mbedtls_pk_debug_type
Types for interfacing with the debug module.
const mbedtls_pk_info_t * mbedtls_pk_info_from_type(mbedtls_pk_type_t pk_type)
Return information associated with the given PK type.
struct mbedtls_pk_info_t mbedtls_pk_info_t
Public key information and operations.
Configuration options (set of defines)
struct mbedtls_pk_debug_item mbedtls_pk_debug_item
Item to send to the debug module.
int mbedtls_pk_write_pubkey_pem(mbedtls_pk_context *ctx, unsigned char *buf, size_t size)
Write a public key to a PEM string.
int mbedtls_pk_sign(mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg, const unsigned char *hash, size_t hash_len, unsigned char *sig, size_t *sig_len, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Make signature, including padding if relevant.
int mbedtls_pk_write_key_pem(mbedtls_pk_context *ctx, unsigned char *buf, size_t size)
Write a private key to a PKCS#1 or SEC1 PEM string.
int mbedtls_pk_encrypt(mbedtls_pk_context *ctx, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen, size_t osize, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Encrypt message (including padding if relevant).
void mbedtls_pk_init(mbedtls_pk_context *ctx)
Initialize a mbedtls_pk_context (as NONE).
int mbedtls_pk_check_pair(const mbedtls_pk_context *pub, const mbedtls_pk_context *prv)
Check if a public-private pair of keys matches.
static mbedtls_rsa_context * mbedtls_pk_rsa(const mbedtls_pk_context pk)
void mbedtls_pk_free(mbedtls_pk_context *ctx)
Free the components of a mbedtls_pk_context.
int(* mbedtls_pk_rsa_alt_sign_func)(void *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, mbedtls_md_type_t md_alg, unsigned int hashlen, const unsigned char *hash, unsigned char *sig)
int mbedtls_pk_load_file(const char *path, unsigned char **buf, size_t *n)
struct mbedtls_pk_context mbedtls_pk_context
Public key container.