The RSA public-key cryptosystem. More...
#include "config.h"
#include "bignum.h"
#include "md.h"
#include "threading.h"
Go to the source code of this file.
Data Structures | |
struct | mbedtls_rsa_context |
The RSA context structure. More... | |
Defines | |
#define | MBEDTLS_ERR_RSA_BAD_INPUT_DATA -0x4080 |
#define | MBEDTLS_ERR_RSA_INVALID_PADDING -0x4100 |
#define | MBEDTLS_ERR_RSA_KEY_GEN_FAILED -0x4180 |
#define | MBEDTLS_ERR_RSA_KEY_CHECK_FAILED -0x4200 |
#define | MBEDTLS_ERR_RSA_PUBLIC_FAILED -0x4280 |
#define | MBEDTLS_ERR_RSA_PRIVATE_FAILED -0x4300 |
#define | MBEDTLS_ERR_RSA_VERIFY_FAILED -0x4380 |
#define | MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE -0x4400 |
#define | MBEDTLS_ERR_RSA_RNG_FAILED -0x4480 |
#define | MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION -0x4500 |
#define | MBEDTLS_ERR_RSA_HW_ACCEL_FAILED -0x4580 |
#define | MBEDTLS_RSA_PUBLIC 0 |
#define | MBEDTLS_RSA_PRIVATE 1 |
#define | MBEDTLS_RSA_PKCS_V15 0 |
#define | MBEDTLS_RSA_PKCS_V21 1 |
#define | MBEDTLS_RSA_SIGN 1 |
#define | MBEDTLS_RSA_CRYPT 2 |
#define | MBEDTLS_RSA_SALT_LEN_ANY -1 |
Functions | |
void | mbedtls_rsa_init (mbedtls_rsa_context *ctx, int padding, int hash_id) |
This function initializes an RSA context. | |
int | mbedtls_rsa_import (mbedtls_rsa_context *ctx, const mbedtls_mpi *N, const mbedtls_mpi *P, const mbedtls_mpi *Q, const mbedtls_mpi *D, const mbedtls_mpi *E) |
This function imports a set of core parameters into an RSA context. | |
int | mbedtls_rsa_import_raw (mbedtls_rsa_context *ctx, unsigned char const *N, size_t N_len, unsigned char const *P, size_t P_len, unsigned char const *Q, size_t Q_len, unsigned char const *D, size_t D_len, unsigned char const *E, size_t E_len) |
This function imports core RSA parameters, in raw big-endian binary format, into an RSA context. | |
int | mbedtls_rsa_complete (mbedtls_rsa_context *ctx) |
This function completes an RSA context from a set of imported core parameters. | |
int | mbedtls_rsa_export (const mbedtls_rsa_context *ctx, mbedtls_mpi *N, mbedtls_mpi *P, mbedtls_mpi *Q, mbedtls_mpi *D, mbedtls_mpi *E) |
This function exports the core parameters of an RSA key. | |
int | mbedtls_rsa_export_raw (const mbedtls_rsa_context *ctx, unsigned char *N, size_t N_len, unsigned char *P, size_t P_len, unsigned char *Q, size_t Q_len, unsigned char *D, size_t D_len, unsigned char *E, size_t E_len) |
This function exports core parameters of an RSA key in raw big-endian binary format. | |
int | mbedtls_rsa_export_crt (const mbedtls_rsa_context *ctx, mbedtls_mpi *DP, mbedtls_mpi *DQ, mbedtls_mpi *QP) |
This function exports CRT parameters of a private RSA key. | |
void | mbedtls_rsa_set_padding (mbedtls_rsa_context *ctx, int padding, int hash_id) |
This function sets padding for an already initialized RSA context. See mbedtls_rsa_init() for details. | |
size_t | mbedtls_rsa_get_len (const mbedtls_rsa_context *ctx) |
This function retrieves the length of RSA modulus in Bytes. | |
int | mbedtls_rsa_gen_key (mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, unsigned int nbits, int exponent) |
This function generates an RSA keypair. | |
int | mbedtls_rsa_check_pubkey (const mbedtls_rsa_context *ctx) |
This function checks if a context contains at least an RSA public key. | |
int | mbedtls_rsa_check_privkey (const mbedtls_rsa_context *ctx) |
This function checks if a context contains an RSA private key and perform basic consistency checks. | |
int | mbedtls_rsa_check_pub_priv (const mbedtls_rsa_context *pub, const mbedtls_rsa_context *prv) |
This function checks a public-private RSA key pair. | |
int | mbedtls_rsa_public (mbedtls_rsa_context *ctx, const unsigned char *input, unsigned char *output) |
This function performs an RSA public key operation. | |
int | mbedtls_rsa_private (mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, const unsigned char *input, unsigned char *output) |
This function performs an RSA private key operation. | |
int | mbedtls_rsa_pkcs1_encrypt (mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, size_t ilen, const unsigned char *input, unsigned char *output) |
This function adds the message padding, then performs an RSA operation. | |
int | mbedtls_rsa_rsaes_pkcs1_v15_encrypt (mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, size_t ilen, const unsigned char *input, unsigned char *output) |
This function performs a PKCS#1 v1.5 encryption operation (RSAES-PKCS1-v1_5-ENCRYPT). | |
int | mbedtls_rsa_rsaes_oaep_encrypt (mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, const unsigned char *label, size_t label_len, size_t ilen, const unsigned char *input, unsigned char *output) |
This function performs a PKCS#1 v2.1 OAEP encryption operation (RSAES-OAEP-ENCRYPT). | |
int | mbedtls_rsa_pkcs1_decrypt (mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, size_t *olen, const unsigned char *input, unsigned char *output, size_t output_max_len) |
This function performs an RSA operation, then removes the message padding. | |
int | mbedtls_rsa_rsaes_pkcs1_v15_decrypt (mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, size_t *olen, const unsigned char *input, unsigned char *output, size_t output_max_len) |
This function performs a PKCS#1 v1.5 decryption operation (RSAES-PKCS1-v1_5-DECRYPT). | |
int | mbedtls_rsa_rsaes_oaep_decrypt (mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, const unsigned char *label, size_t label_len, size_t *olen, const unsigned char *input, unsigned char *output, size_t output_max_len) |
This function performs a PKCS#1 v2.1 OAEP decryption operation (RSAES-OAEP-DECRYPT). | |
int | mbedtls_rsa_pkcs1_sign (mbedtls_rsa_context *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) |
This function performs a private RSA operation to sign a message digest using PKCS#1. | |
int | mbedtls_rsa_rsassa_pkcs1_v15_sign (mbedtls_rsa_context *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) |
This function performs a PKCS#1 v1.5 signature operation (RSASSA-PKCS1-v1_5-SIGN). | |
int | mbedtls_rsa_rsassa_pss_sign (mbedtls_rsa_context *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) |
This function performs a PKCS#1 v2.1 PSS signature operation (RSASSA-PSS-SIGN). | |
int | mbedtls_rsa_pkcs1_verify (mbedtls_rsa_context *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, const unsigned char *sig) |
This function performs a public RSA operation and checks the message digest. | |
int | mbedtls_rsa_rsassa_pkcs1_v15_verify (mbedtls_rsa_context *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, const unsigned char *sig) |
This function performs a PKCS#1 v1.5 verification operation (RSASSA-PKCS1-v1_5-VERIFY). | |
int | mbedtls_rsa_rsassa_pss_verify (mbedtls_rsa_context *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, const unsigned char *sig) |
This function performs a PKCS#1 v2.1 PSS verification operation (RSASSA-PSS-VERIFY). | |
int | mbedtls_rsa_rsassa_pss_verify_ext (mbedtls_rsa_context *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, mbedtls_md_type_t mgf1_hash_id, int expected_salt_len, const unsigned char *sig) |
This function performs a PKCS#1 v2.1 PSS verification operation (RSASSA-PSS-VERIFY). | |
int | mbedtls_rsa_copy (mbedtls_rsa_context *dst, const mbedtls_rsa_context *src) |
This function copies the components of an RSA context. | |
void | mbedtls_rsa_free (mbedtls_rsa_context *ctx) |
This function frees the components of an RSA key. | |
int | mbedtls_rsa_self_test (int verbose) |
The RSA checkup routine. |
The RSA public-key cryptosystem.
For more information, see Public-Key Cryptography Standards (PKCS) #1 v1.5: RSA Encryption and Public-Key Cryptography Standards (PKCS) #1 v2.1: RSA Cryptography Specifications.
Definition in file rsa.h.
#define MBEDTLS_ERR_RSA_BAD_INPUT_DATA -0x4080 |
#define MBEDTLS_ERR_RSA_HW_ACCEL_FAILED -0x4580 |
#define MBEDTLS_ERR_RSA_INVALID_PADDING -0x4100 |
#define MBEDTLS_ERR_RSA_KEY_CHECK_FAILED -0x4200 |
#define MBEDTLS_ERR_RSA_KEY_GEN_FAILED -0x4180 |
#define MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE -0x4400 |
#define MBEDTLS_ERR_RSA_PRIVATE_FAILED -0x4300 |
#define MBEDTLS_ERR_RSA_PUBLIC_FAILED -0x4280 |
#define MBEDTLS_ERR_RSA_RNG_FAILED -0x4480 |
#define MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION -0x4500 |
#define MBEDTLS_ERR_RSA_VERIFY_FAILED -0x4380 |
#define MBEDTLS_RSA_CRYPT 2 |
#define MBEDTLS_RSA_SIGN 1 |
int mbedtls_rsa_check_privkey | ( | const mbedtls_rsa_context * | ctx | ) |
This function checks if a context contains an RSA private key and perform basic consistency checks.
ctx | The RSA context to check. |
0
on success, or an MBEDTLS_ERR_RSA_XXX
error code on failure.int mbedtls_rsa_check_pub_priv | ( | const mbedtls_rsa_context * | pub, | |
const mbedtls_rsa_context * | prv | |||
) |
This function checks a public-private RSA key pair.
It checks each of the contexts, and makes sure they match.
pub | The RSA context holding the public key. | |
prv | The RSA context holding the private key. |
0
on success, or an MBEDTLS_ERR_RSA_XXX
error code on failure. int mbedtls_rsa_check_pubkey | ( | const mbedtls_rsa_context * | ctx | ) |
This function checks if a context contains at least an RSA public key.
If the function runs successfully, it is guaranteed that enough information is present to perform an RSA public key operation using mbedtls_rsa_public().
ctx | The RSA context to check. |
0
on success, or an MBEDTLS_ERR_RSA_XXX
error code on failure. int mbedtls_rsa_complete | ( | mbedtls_rsa_context * | ctx | ) |
This function completes an RSA context from a set of imported core parameters.
To setup an RSA public key, precisely N
and E
must have been imported.
To setup an RSA private key, sufficient information must be present for the other parameters to be derivable.
The default implementation supports the following:
P
, Q
from N
, D
, E
. N
, D
from P
, Q
, E
.Alternative implementations need not support these.
If this function runs successfully, it guarantees that the RSA context can be used for RSA operations without the risk of failure or crash.
ctx | The initialized RSA context holding imported parameters. |
0
on success, or MBEDTLS_ERR_RSA_BAD_INPUT_DATA if the attempted derivations failed.int mbedtls_rsa_copy | ( | mbedtls_rsa_context * | dst, | |
const mbedtls_rsa_context * | src | |||
) |
This function copies the components of an RSA context.
dst | The destination context. | |
src | The source context. |
0
on success, MBEDTLS_ERR_MPI_ALLOC_FAILED on memory allocation failure. int mbedtls_rsa_export | ( | const mbedtls_rsa_context * | ctx, | |
mbedtls_mpi * | N, | |||
mbedtls_mpi * | P, | |||
mbedtls_mpi * | Q, | |||
mbedtls_mpi * | D, | |||
mbedtls_mpi * | E | |||
) |
This function exports the core parameters of an RSA key.
If this function runs successfully, the non-NULL buffers pointed to by N
, P
, Q
, D
, and E
are fully written, with additional unused space filled leading by zero Bytes.
Possible reasons for returning MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
P
, Q
from N
, D
, and E
if the former are not part of the implementation.If the function fails due to an unsupported operation, the RSA context stays intact and remains usable.
ctx | The initialized RSA context. | |
N | The MPI to hold the RSA modulus, or NULL. | |
P | The MPI to hold the first prime factor of N , or NULL. | |
Q | The MPI to hold the second prime factor of N , or NULL. | |
D | The MPI to hold the private exponent, or NULL. | |
E | The MPI to hold the public exponent, or NULL. |
0
on success, MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION if exporting the requested parameters cannot be done due to missing functionality or because of security policies, or a non-zero return code on any other failure. int mbedtls_rsa_export_crt | ( | const mbedtls_rsa_context * | ctx, | |
mbedtls_mpi * | DP, | |||
mbedtls_mpi * | DQ, | |||
mbedtls_mpi * | QP | |||
) |
This function exports CRT parameters of a private RSA key.
ctx | The initialized RSA context. | |
DP | The MPI to hold D modulo P-1, or NULL. | |
DQ | The MPI to hold D modulo Q-1, or NULL. | |
QP | The MPI to hold modular inverse of Q modulo P, or NULL. |
0
on success, non-zero error code otherwise.int mbedtls_rsa_export_raw | ( | const mbedtls_rsa_context * | ctx, | |
unsigned char * | N, | |||
size_t | N_len, | |||
unsigned char * | P, | |||
size_t | P_len, | |||
unsigned char * | Q, | |||
size_t | Q_len, | |||
unsigned char * | D, | |||
size_t | D_len, | |||
unsigned char * | E, | |||
size_t | E_len | |||
) |
This function exports core parameters of an RSA key in raw big-endian binary format.
If this function runs successfully, the non-NULL buffers pointed to by N
, P
, Q
, D
, and E
are fully written, with additional unused space filled leading by zero Bytes.
Possible reasons for returning MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
P
, Q
from N
, D
, and E
if the former are not part of the implementation.If the function fails due to an unsupported operation, the RSA context stays intact and remains usable.
ctx | The initialized RSA context. | |
N | The Byte array to store the RSA modulus, or NULL. | |
N_len | The size of the buffer for the modulus. | |
P | The Byte array to hold the first prime factor of N , or NULL. | |
P_len | The size of the buffer for the first prime factor. | |
Q | The Byte array to hold the second prime factor of N , or NULL. | |
Q_len | The size of the buffer for the second prime factor. | |
D | The Byte array to hold the private exponent, or NULL. | |
D_len | The size of the buffer for the private exponent. | |
E | The Byte array to hold the public exponent, or NULL. | |
E_len | The size of the buffer for the public exponent. |
0
on success, MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION if exporting the requested parameters cannot be done due to missing functionality or because of security policies, or a non-zero return code on any other failure. void mbedtls_rsa_free | ( | mbedtls_rsa_context * | ctx | ) |
This function frees the components of an RSA key.
ctx | The RSA Context to free. |
int mbedtls_rsa_gen_key | ( | mbedtls_rsa_context * | ctx, | |
int(*)(void *, unsigned char *, size_t) | f_rng, | |||
void * | p_rng, | |||
unsigned int | nbits, | |||
int | exponent | |||
) |
This function generates an RSA keypair.
ctx | The RSA context used to hold the key. | |
f_rng | The RNG function. | |
p_rng | The RNG parameter. | |
nbits | The size of the public key in bits. | |
exponent | The public exponent. For example, 65537. |
0
on success, or an MBEDTLS_ERR_RSA_XXX
error code on failure. size_t mbedtls_rsa_get_len | ( | const mbedtls_rsa_context * | ctx | ) |
This function retrieves the length of RSA modulus in Bytes.
ctx | The initialized RSA context. |
int mbedtls_rsa_import | ( | mbedtls_rsa_context * | ctx, | |
const mbedtls_mpi * | N, | |||
const mbedtls_mpi * | P, | |||
const mbedtls_mpi * | Q, | |||
const mbedtls_mpi * | D, | |||
const mbedtls_mpi * | E | |||
) |
This function imports a set of core parameters into an RSA context.
ctx | The initialized RSA context to store the parameters in. | |
N | The RSA modulus, or NULL. | |
P | The first prime factor of N , or NULL. | |
Q | The second prime factor of N , or NULL. | |
D | The private exponent, or NULL. | |
E | The public exponent, or NULL. |
Any sequence of calls to this function should be followed by a call to mbedtls_rsa_complete(), which checks and completes the provided information to a ready-for-use public or private RSA key.
0
on success, or a non-zero error code on failure. int mbedtls_rsa_import_raw | ( | mbedtls_rsa_context * | ctx, | |
unsigned char const * | N, | |||
size_t | N_len, | |||
unsigned char const * | P, | |||
size_t | P_len, | |||
unsigned char const * | Q, | |||
size_t | Q_len, | |||
unsigned char const * | D, | |||
size_t | D_len, | |||
unsigned char const * | E, | |||
size_t | E_len | |||
) |
This function imports core RSA parameters, in raw big-endian binary format, into an RSA context.
ctx | The initialized RSA context to store the parameters in. | |
N | The RSA modulus, or NULL. | |
N_len | The Byte length of N , ignored if N == NULL. | |
P | The first prime factor of N , or NULL. | |
P_len | The Byte length of P , ignored if P == NULL. | |
Q | The second prime factor of N , or NULL. | |
Q_len | The Byte length of Q , ignored if Q == NULL. | |
D | The private exponent, or NULL. | |
D_len | The Byte length of D , ignored if D == NULL. | |
E | The public exponent, or NULL. | |
E_len | The Byte length of E , ignored if E == NULL. |
Any sequence of calls to this function should be followed by a call to mbedtls_rsa_complete(), which checks and completes the provided information to a ready-for-use public or private RSA key.
0
on success, or a non-zero error code on failure. void mbedtls_rsa_init | ( | mbedtls_rsa_context * | ctx, | |
int | padding, | |||
int | hash_id | |||
) |
This function initializes an RSA context.
ctx | The RSA context to initialize. | |
padding | Selects padding mode: MBEDTLS_RSA_PKCS_V15 or MBEDTLS_RSA_PKCS_V21. | |
hash_id | The hash identifier of mbedtls_md_type_t type, if padding is MBEDTLS_RSA_PKCS_V21. |
hash_id
parameter is ignored when using MBEDTLS_RSA_PKCS_V15 padding.rsa_rsaes_xxx
or rsa_rsassa_xxx
functions.hash_id
is always used for OEAP encryption. For PSS signatures, it is always used for making signatures, but can be overridden for verifying them. If set to MBEDTLS_MD_NONE, it is always overridden. int mbedtls_rsa_pkcs1_decrypt | ( | mbedtls_rsa_context * | ctx, | |
int(*)(void *, unsigned char *, size_t) | f_rng, | |||
void * | p_rng, | |||
int | mode, | |||
size_t * | olen, | |||
const unsigned char * | input, | |||
unsigned char * | output, | |||
size_t | output_max_len | |||
) |
This function performs an RSA operation, then removes the message padding.
It is the generic wrapper for performing a PKCS#1 decryption operation using the mode
from the context.
ctx | The RSA context. | |
f_rng | The RNG function. Only needed for MBEDTLS_RSA_PRIVATE. | |
p_rng | The RNG parameter. | |
mode | MBEDTLS_RSA_PUBLIC or MBEDTLS_RSA_PRIVATE. | |
olen | The length of the plaintext. | |
input | The buffer holding the encrypted data. | |
output | The buffer used to hold the plaintext. | |
output_max_len | The maximum length of the output buffer. |
mode
argument and have it implicitly set to MBEDTLS_RSA_PRIVATE.0
on success, or an MBEDTLS_ERR_RSA_XXX
error code on failure.output_max_len
should be as large as the size ctx->len
of ctx->N
(for example, 128 Bytes if RSA-1024 is used) to be able to hold an arbitrary decrypted message. If it is not large enough to hold the decryption of the particular ciphertext provided, the function returns MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE
.ctx->N
. For example, 128 Bytes if RSA-1024 is used. int mbedtls_rsa_pkcs1_encrypt | ( | mbedtls_rsa_context * | ctx, | |
int(*)(void *, unsigned char *, size_t) | f_rng, | |||
void * | p_rng, | |||
int | mode, | |||
size_t | ilen, | |||
const unsigned char * | input, | |||
unsigned char * | output | |||
) |
This function adds the message padding, then performs an RSA operation.
It is the generic wrapper for performing a PKCS#1 encryption operation using the mode
from the context.
ctx | The RSA context. | |
f_rng | The RNG function. Needed for padding, PKCS#1 v2.1 encoding, and MBEDTLS_RSA_PRIVATE. | |
p_rng | The RNG parameter. | |
mode | MBEDTLS_RSA_PUBLIC or MBEDTLS_RSA_PRIVATE. | |
ilen | The length of the plaintext. | |
input | The buffer holding the data to encrypt. | |
output | The buffer used to hold the ciphertext. |
mode
argument and have it implicitly set to MBEDTLS_RSA_PUBLIC.0
on success, or an MBEDTLS_ERR_RSA_XXX
error code on failure.ctx->N
. For example, 128 Bytes if RSA-1024 is used. int mbedtls_rsa_pkcs1_sign | ( | mbedtls_rsa_context * | ctx, | |
int(*)(void *, unsigned char *, size_t) | f_rng, | |||
void * | p_rng, | |||
int | mode, | |||
mbedtls_md_type_t | md_alg, | |||
unsigned int | hashlen, | |||
const unsigned char * | hash, | |||
unsigned char * | sig | |||
) |
This function performs a private RSA operation to sign a message digest using PKCS#1.
It is the generic wrapper for performing a PKCS#1 signature using the mode
from the context.
ctx | The RSA context. | |
f_rng | The RNG function. Needed for PKCS#1 v2.1 encoding and for MBEDTLS_RSA_PRIVATE. | |
p_rng | The RNG parameter. | |
mode | MBEDTLS_RSA_PUBLIC or MBEDTLS_RSA_PRIVATE. | |
md_alg | The message-digest algorithm used to hash the original data. Use MBEDTLS_MD_NONE for signing raw data. | |
hashlen | The length of the message digest. Only used if md_alg is MBEDTLS_MD_NONE. | |
hash | The buffer holding the message digest. | |
sig | The buffer to hold the ciphertext. |
mode
argument and have it implicitly set to MBEDTLS_RSA_PRIVATE.0
if the signing operation was successful, or an MBEDTLS_ERR_RSA_XXX
error code on failure.sig
buffer must be as large as the size of ctx->N
. For example, 128 Bytes if RSA-1024 is used. A buffer length of MBEDTLS_MPI_MAX_SIZE is always safe.md_alg
and hash_id
. int mbedtls_rsa_pkcs1_verify | ( | mbedtls_rsa_context * | ctx, | |
int(*)(void *, unsigned char *, size_t) | f_rng, | |||
void * | p_rng, | |||
int | mode, | |||
mbedtls_md_type_t | md_alg, | |||
unsigned int | hashlen, | |||
const unsigned char * | hash, | |||
const unsigned char * | sig | |||
) |
This function performs a public RSA operation and checks the message digest.
This is the generic wrapper for performing a PKCS#1 verification using the mode from the context.
ctx | The RSA public key context. | |
f_rng | The RNG function. Only needed for MBEDTLS_RSA_PRIVATE. | |
p_rng | The RNG parameter. | |
mode | MBEDTLS_RSA_PUBLIC or MBEDTLS_RSA_PRIVATE. | |
md_alg | The message-digest algorithm used to hash the original data. Use MBEDTLS_MD_NONE for signing raw data. | |
hashlen | The length of the message digest. Only used if md_alg is MBEDTLS_MD_NONE. | |
hash | The buffer holding the message digest. | |
sig | The buffer holding the ciphertext. |
mode
argument and have it set to MBEDTLS_RSA_PUBLIC.0
if the verify operation was successful, or an MBEDTLS_ERR_RSA_XXX
error code on failure.sig
buffer must be as large as the size of ctx->N
. For example, 128 Bytes if RSA-1024 is used.md_alg
and hash_id
. int mbedtls_rsa_private | ( | mbedtls_rsa_context * | ctx, | |
int(*)(void *, unsigned char *, size_t) | f_rng, | |||
void * | p_rng, | |||
const unsigned char * | input, | |||
unsigned char * | output | |||
) |
This function performs an RSA private key operation.
ctx | The RSA context. | |
f_rng | The RNG function. Needed for blinding. | |
p_rng | The RNG parameter. | |
input | The input buffer. | |
output | The output buffer. |
0
on success, or an MBEDTLS_ERR_RSA_XXX
error code on failure.int mbedtls_rsa_public | ( | mbedtls_rsa_context * | ctx, | |
const unsigned char * | input, | |||
unsigned char * | output | |||
) |
This function performs an RSA public key operation.
ctx | The RSA context. | |
input | The input buffer. | |
output | The output buffer. |
0
on success, or an MBEDTLS_ERR_RSA_XXX
error code on failure.input
[0] = 0 or ensure that input is smaller than N
.int mbedtls_rsa_rsaes_oaep_decrypt | ( | mbedtls_rsa_context * | ctx, | |
int(*)(void *, unsigned char *, size_t) | f_rng, | |||
void * | p_rng, | |||
int | mode, | |||
const unsigned char * | label, | |||
size_t | label_len, | |||
size_t * | olen, | |||
const unsigned char * | input, | |||
unsigned char * | output, | |||
size_t | output_max_len | |||
) |
This function performs a PKCS#1 v2.1 OAEP decryption operation (RSAES-OAEP-DECRYPT).
ctx | The RSA context. | |
f_rng | The RNG function. Only needed for MBEDTLS_RSA_PRIVATE. | |
p_rng | The RNG parameter. | |
mode | MBEDTLS_RSA_PUBLIC or MBEDTLS_RSA_PRIVATE. | |
label | The buffer holding the custom label to use. | |
label_len | The length of the label. | |
olen | The length of the plaintext. | |
input | The buffer holding the encrypted data. | |
output | The buffer to hold the plaintext. | |
output_max_len | The maximum length of the output buffer. |
mode
argument and have it implicitly set to MBEDTLS_RSA_PRIVATE.0
on success, or an MBEDTLS_ERR_RSA_XXX
error code on failure.output_max_len
should be as large as the size ctx->len
of ctx->N
, for example, 128 Bytes if RSA-1024 is used, to be able to hold an arbitrary decrypted message. If it is not large enough to hold the decryption of the particular ciphertext provided, the function returns MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE.ctx->N
. For example, 128 Bytes if RSA-1024 is used. int mbedtls_rsa_rsaes_oaep_encrypt | ( | mbedtls_rsa_context * | ctx, | |
int(*)(void *, unsigned char *, size_t) | f_rng, | |||
void * | p_rng, | |||
int | mode, | |||
const unsigned char * | label, | |||
size_t | label_len, | |||
size_t | ilen, | |||
const unsigned char * | input, | |||
unsigned char * | output | |||
) |
This function performs a PKCS#1 v2.1 OAEP encryption operation (RSAES-OAEP-ENCRYPT).
ctx | The RSA context. | |
f_rng | The RNG function. Needed for padding and PKCS#1 v2.1 encoding and MBEDTLS_RSA_PRIVATE. | |
p_rng | The RNG parameter. | |
mode | MBEDTLS_RSA_PUBLIC or MBEDTLS_RSA_PRIVATE. | |
label | The buffer holding the custom label to use. | |
label_len | The length of the label. | |
ilen | The length of the plaintext. | |
input | The buffer holding the data to encrypt. | |
output | The buffer used to hold the ciphertext. |
mode
argument and have it implicitly set to MBEDTLS_RSA_PUBLIC.0
on success, or an MBEDTLS_ERR_RSA_XXX
error code on failure.int mbedtls_rsa_rsaes_pkcs1_v15_decrypt | ( | mbedtls_rsa_context * | ctx, | |
int(*)(void *, unsigned char *, size_t) | f_rng, | |||
void * | p_rng, | |||
int | mode, | |||
size_t * | olen, | |||
const unsigned char * | input, | |||
unsigned char * | output, | |||
size_t | output_max_len | |||
) |
This function performs a PKCS#1 v1.5 decryption operation (RSAES-PKCS1-v1_5-DECRYPT).
ctx | The RSA context. | |
f_rng | The RNG function. Only needed for MBEDTLS_RSA_PRIVATE. | |
p_rng | The RNG parameter. | |
mode | MBEDTLS_RSA_PUBLIC or MBEDTLS_RSA_PRIVATE. | |
olen | The length of the plaintext. | |
input | The buffer holding the encrypted data. | |
output | The buffer to hold the plaintext. | |
output_max_len | The maximum length of the output buffer. |
mode
argument and have it implicitly set to MBEDTLS_RSA_PRIVATE.0
on success, or an MBEDTLS_ERR_RSA_XXX
error code on failure.output_max_len
should be as large as the size ctx->len
of ctx->N
, for example, 128 Bytes if RSA-1024 is used, to be able to hold an arbitrary decrypted message. If it is not large enough to hold the decryption of the particular ciphertext provided, the function returns MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE.ctx->N
. For example, 128 Bytes if RSA-1024 is used. int mbedtls_rsa_rsaes_pkcs1_v15_encrypt | ( | mbedtls_rsa_context * | ctx, | |
int(*)(void *, unsigned char *, size_t) | f_rng, | |||
void * | p_rng, | |||
int | mode, | |||
size_t | ilen, | |||
const unsigned char * | input, | |||
unsigned char * | output | |||
) |
This function performs a PKCS#1 v1.5 encryption operation (RSAES-PKCS1-v1_5-ENCRYPT).
ctx | The RSA context. | |
f_rng | The RNG function. Needed for padding and MBEDTLS_RSA_PRIVATE. | |
p_rng | The RNG parameter. | |
mode | MBEDTLS_RSA_PUBLIC or MBEDTLS_RSA_PRIVATE. | |
ilen | The length of the plaintext. | |
input | The buffer holding the data to encrypt. | |
output | The buffer used to hold the ciphertext. |
mode
argument and have it implicitly set to MBEDTLS_RSA_PUBLIC.0
on success, or an MBEDTLS_ERR_RSA_XXX
error code on failure.ctx->N
. For example, 128 Bytes if RSA-1024 is used. int mbedtls_rsa_rsassa_pkcs1_v15_sign | ( | mbedtls_rsa_context * | ctx, | |
int(*)(void *, unsigned char *, size_t) | f_rng, | |||
void * | p_rng, | |||
int | mode, | |||
mbedtls_md_type_t | md_alg, | |||
unsigned int | hashlen, | |||
const unsigned char * | hash, | |||
unsigned char * | sig | |||
) |
This function performs a PKCS#1 v1.5 signature operation (RSASSA-PKCS1-v1_5-SIGN).
ctx | The RSA context. | |
f_rng | The RNG function. Only needed for MBEDTLS_RSA_PRIVATE. | |
p_rng | The RNG parameter. | |
mode | MBEDTLS_RSA_PUBLIC or MBEDTLS_RSA_PRIVATE. | |
md_alg | The message-digest algorithm used to hash the original data. Use MBEDTLS_MD_NONE for signing raw data. | |
hashlen | The length of the message digest. Only used if md_alg is MBEDTLS_MD_NONE. | |
hash | The buffer holding the message digest. | |
sig | The buffer to hold the ciphertext. |
mode
argument and have it implicitly set to MBEDTLS_RSA_PRIVATE.0
if the signing operation was successful, or an MBEDTLS_ERR_RSA_XXX
error code on failure.sig
buffer must be as large as the size of ctx->N
. For example, 128 Bytes if RSA-1024 is used. A buffer length of MBEDTLS_MPI_MAX_SIZE is always safe. int mbedtls_rsa_rsassa_pkcs1_v15_verify | ( | mbedtls_rsa_context * | ctx, | |
int(*)(void *, unsigned char *, size_t) | f_rng, | |||
void * | p_rng, | |||
int | mode, | |||
mbedtls_md_type_t | md_alg, | |||
unsigned int | hashlen, | |||
const unsigned char * | hash, | |||
const unsigned char * | sig | |||
) |
This function performs a PKCS#1 v1.5 verification operation (RSASSA-PKCS1-v1_5-VERIFY).
ctx | The RSA public key context. | |
f_rng | The RNG function. Only needed for MBEDTLS_RSA_PRIVATE. | |
p_rng | The RNG parameter. | |
mode | MBEDTLS_RSA_PUBLIC or MBEDTLS_RSA_PRIVATE. | |
md_alg | The message-digest algorithm used to hash the original data. Use MBEDTLS_MD_NONE for signing raw data. | |
hashlen | The length of the message digest. Only used if md_alg is MBEDTLS_MD_NONE. | |
hash | The buffer holding the message digest. | |
sig | The buffer holding the ciphertext. |
mode
argument and have it set to MBEDTLS_RSA_PUBLIC.0
if the verify operation was successful, or an MBEDTLS_ERR_RSA_XXX
error code on failure.sig
buffer must be as large as the size of ctx->N
. For example, 128 Bytes if RSA-1024 is used. int mbedtls_rsa_rsassa_pss_sign | ( | mbedtls_rsa_context * | ctx, | |
int(*)(void *, unsigned char *, size_t) | f_rng, | |||
void * | p_rng, | |||
int | mode, | |||
mbedtls_md_type_t | md_alg, | |||
unsigned int | hashlen, | |||
const unsigned char * | hash, | |||
unsigned char * | sig | |||
) |
This function performs a PKCS#1 v2.1 PSS signature operation (RSASSA-PSS-SIGN).
ctx | The RSA context. | |
f_rng | The RNG function. Needed for PKCS#1 v2.1 encoding and for MBEDTLS_RSA_PRIVATE. | |
p_rng | The RNG parameter. | |
mode | MBEDTLS_RSA_PUBLIC or MBEDTLS_RSA_PRIVATE. | |
md_alg | The message-digest algorithm used to hash the original data. Use MBEDTLS_MD_NONE for signing raw data. | |
hashlen | The length of the message digest. Only used if md_alg is MBEDTLS_MD_NONE. | |
hash | The buffer holding the message digest. | |
sig | The buffer to hold the ciphertext. |
mode
argument and have it implicitly set to MBEDTLS_RSA_PRIVATE.0
if the signing operation was successful, or an MBEDTLS_ERR_RSA_XXX
error code on failure.sig
buffer must be as large as the size of ctx->N
. For example, 128 Bytes if RSA-1024 is used. A buffer length of MBEDTLS_MPI_MAX_SIZE is always safe.hash_id
in the RSA context is the one used for the encoding. md_alg
in the function call is the type of hash that is encoded. According to RFC-3447: Public-Key Cryptography Standards (PKCS) #1 v2.1: RSA Cryptography Specifications it is advised to keep both hashes the same. int mbedtls_rsa_rsassa_pss_verify | ( | mbedtls_rsa_context * | ctx, | |
int(*)(void *, unsigned char *, size_t) | f_rng, | |||
void * | p_rng, | |||
int | mode, | |||
mbedtls_md_type_t | md_alg, | |||
unsigned int | hashlen, | |||
const unsigned char * | hash, | |||
const unsigned char * | sig | |||
) |
This function performs a PKCS#1 v2.1 PSS verification operation (RSASSA-PSS-VERIFY).
The hash function for the MGF mask generating function is that specified in the RSA context.
ctx | The RSA public key context. | |
f_rng | The RNG function. Only needed for MBEDTLS_RSA_PRIVATE. | |
p_rng | The RNG parameter. | |
mode | MBEDTLS_RSA_PUBLIC or MBEDTLS_RSA_PRIVATE. | |
md_alg | The message-digest algorithm used to hash the original data. Use MBEDTLS_MD_NONE for signing raw data. | |
hashlen | The length of the message digest. Only used if md_alg is MBEDTLS_MD_NONE. | |
hash | The buffer holding the message digest. | |
sig | The buffer holding the ciphertext. |
mode
argument and have it implicitly set to MBEDTLS_RSA_PUBLIC.0
if the verify operation was successful, or an MBEDTLS_ERR_RSA_XXX
error code on failure.sig
buffer must be as large as the size of ctx->N
. For example, 128 Bytes if RSA-1024 is used.hash_id
in the RSA context is the one used for the verification. md_alg
in the function call is the type of hash that is verified. According to RFC-3447: Public-Key Cryptography Standards (PKCS) #1 v2.1: RSA Cryptography Specifications it is advised to keep both hashes the same. If hash_id
in the RSA context is unset, the md_alg
from the function call is used. int mbedtls_rsa_rsassa_pss_verify_ext | ( | mbedtls_rsa_context * | ctx, | |
int(*)(void *, unsigned char *, size_t) | f_rng, | |||
void * | p_rng, | |||
int | mode, | |||
mbedtls_md_type_t | md_alg, | |||
unsigned int | hashlen, | |||
const unsigned char * | hash, | |||
mbedtls_md_type_t | mgf1_hash_id, | |||
int | expected_salt_len, | |||
const unsigned char * | sig | |||
) |
This function performs a PKCS#1 v2.1 PSS verification operation (RSASSA-PSS-VERIFY).
The hash function for the MGF mask generating function is that specified in mgf1_hash_id
.
ctx | The RSA public key context. | |
f_rng | The RNG function. Only needed for MBEDTLS_RSA_PRIVATE. | |
p_rng | The RNG parameter. | |
mode | MBEDTLS_RSA_PUBLIC or MBEDTLS_RSA_PRIVATE. | |
md_alg | The message-digest algorithm used to hash the original data. Use MBEDTLS_MD_NONE for signing raw data. | |
hashlen | The length of the message digest. Only used if md_alg is MBEDTLS_MD_NONE. | |
hash | The buffer holding the message digest. | |
mgf1_hash_id | The message digest used for mask generation. | |
expected_salt_len | The length of the salt used in padding. Use MBEDTLS_RSA_SALT_LEN_ANY to accept any salt length. | |
sig | The buffer holding the ciphertext. |
0
if the verify operation was successful, or an MBEDTLS_ERR_RSA_XXX
error code on failure.sig
buffer must be as large as the size of ctx->N
. For example, 128 Bytes if RSA-1024 is used.hash_id
in the RSA context is ignored. int mbedtls_rsa_self_test | ( | int | verbose | ) |
The RSA checkup routine.
0
on success, or 1
on failure. void mbedtls_rsa_set_padding | ( | mbedtls_rsa_context * | ctx, | |
int | padding, | |||
int | hash_id | |||
) |
This function sets padding for an already initialized RSA context. See mbedtls_rsa_init() for details.
ctx | The RSA context to be set. | |
padding | Selects padding mode: MBEDTLS_RSA_PKCS_V15 or MBEDTLS_RSA_PKCS_V21. | |
hash_id | The MBEDTLS_RSA_PKCS_V21 hash identifier. |