The RSA public-key cryptosystem. More...

Data Structures
struct	rsa_context
	RSA context structure. More...
Functions
void	rsa_init (rsa_context *ctx, int padding, int hash_id)
	Initialize an RSA context.
void	rsa_set_padding (rsa_context *ctx, int padding, int hash_id)
	Set padding for an already initialized RSA context.
int	rsa_gen_key (rsa_context ctx, int(f_rng)(void , unsigned char , size_t), void *p_rng, unsigned int nbits, int exponent)
	Generate an RSA keypair.
int	rsa_check_pubkey (const rsa_context *ctx)
	Check a public RSA key.
int	rsa_check_privkey (const rsa_context *ctx)
	Check a private RSA key.
int	rsa_public (rsa_context ctx, const unsigned char input, unsigned char *output)
	Do an RSA public key operation.
int	rsa_private (rsa_context ctx, int(f_rng)(void , unsigned char , size_t), void p_rng, const unsigned char input, unsigned char *output)
	Do an RSA private key operation.
int	rsa_pkcs1_encrypt (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)
	Generic wrapper to perform a PKCS#1 encryption using the mode from the context.
int	rsa_rsaes_pkcs1_v15_encrypt (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)
	Perform a PKCS#1 v1.5 encryption (RSAES-PKCS1-v1_5-ENCRYPT)
int	rsa_rsaes_oaep_encrypt (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)
	Perform a PKCS#1 v2.1 OAEP encryption (RSAES-OAEP-ENCRYPT)
int	rsa_pkcs1_decrypt (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)
	Generic wrapper to perform a PKCS#1 decryption using the mode from the context.
int	rsa_rsaes_pkcs1_v15_decrypt (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)
	Perform a PKCS#1 v1.5 decryption (RSAES-PKCS1-v1_5-DECRYPT)
int	rsa_rsaes_oaep_decrypt (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)
	Perform a PKCS#1 v2.1 OAEP decryption (RSAES-OAEP-DECRYPT)
int	rsa_pkcs1_sign (rsa_context ctx, int(f_rng)(void , unsigned char , size_t), void p_rng, int mode, md_type_t md_alg, unsigned int hashlen, const unsigned char hash, unsigned char *sig)
	Generic wrapper to perform a PKCS#1 signature using the mode from the context.
int	rsa_rsassa_pkcs1_v15_sign (rsa_context ctx, int(f_rng)(void , unsigned char , size_t), void p_rng, int mode, md_type_t md_alg, unsigned int hashlen, const unsigned char hash, unsigned char *sig)
	Perform a PKCS#1 v1.5 signature (RSASSA-PKCS1-v1_5-SIGN)
int	rsa_rsassa_pss_sign (rsa_context ctx, int(f_rng)(void , unsigned char , size_t), void p_rng, int mode, md_type_t md_alg, unsigned int hashlen, const unsigned char hash, unsigned char *sig)
	Perform a PKCS#1 v2.1 PSS signature (RSASSA-PSS-SIGN)
int	rsa_pkcs1_verify (rsa_context ctx, int(f_rng)(void , unsigned char , size_t), void p_rng, int mode, md_type_t md_alg, unsigned int hashlen, const unsigned char hash, const unsigned char *sig)
	Generic wrapper to perform a PKCS#1 verification using the mode from the context.
int	rsa_rsassa_pkcs1_v15_verify (rsa_context ctx, int(f_rng)(void , unsigned char , size_t), void p_rng, int mode, md_type_t md_alg, unsigned int hashlen, const unsigned char hash, const unsigned char *sig)
	Perform a PKCS#1 v1.5 verification (RSASSA-PKCS1-v1_5-VERIFY)
int	rsa_rsassa_pss_verify (rsa_context ctx, int(f_rng)(void , unsigned char , size_t), void p_rng, int mode, md_type_t md_alg, unsigned int hashlen, const unsigned char hash, const unsigned char *sig)
	Perform a PKCS#1 v2.1 PSS verification (RSASSA-PSS-VERIFY)
int	rsa_copy (rsa_context dst, const rsa_context src)
	Copy the components of an RSA context.
void	rsa_free (rsa_context *ctx)
	Free the components of an RSA key.
int	rsa_self_test (int verbose)
	Checkup routine.

Detailed Description

The RSA public-key cryptosystem.

This file is part of PolarSSL (http://www.polarssl.org) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Definition in file rsa.h.

Function Documentation

int rsa_check_privkey ( const rsa_context * ctx )

Check a private RSA key.

Parameters:

ctx	RSA context to be checked

Returns:: 0 if successful, or an POLARSSL_ERR_RSA_XXX error code

Definition at line 184 of file rsa.c.

int rsa_check_pubkey ( const rsa_context * ctx )

Check a public RSA key.

Parameters:

ctx	RSA context to be checked

Returns:: 0 if successful, or an POLARSSL_ERR_RSA_XXX error code

Definition at line 161 of file rsa.c.

int rsa_copy	(	rsa_context *	dst,
		const rsa_context *	src
	)

Copy the components of an RSA context.

Parameters:

dst	Destination context
src	Source context

Returns:: O on success, POLARSSL_ERR_MPI_MALLOC_FAILED on memory allocation failure

Definition at line 1361 of file rsa.c.

void rsa_free ( rsa_context * ctx )

Free the components of an RSA key.

Parameters:

ctx	RSA Context to free

Definition at line 1400 of file rsa.c.

int rsa_gen_key	(	rsa_context *	ctx,
		int()(void , unsigned char *, size_t)	f_rng,
		void *	p_rng,
		unsigned int	nbits,
		int	exponent
	)

Generate an RSA keypair.

Parameters:

ctx	RSA context that will hold the key
f_rng	RNG function
p_rng	RNG parameter
nbits	size of the public key in bits
exponent	public exponent (e.g., 65537)

Note:: rsa_init() must be called beforehand to setup the RSA context.

Returns:: 0 if successful, or an POLARSSL_ERR_RSA_XXX error code

Definition at line 86 of file rsa.c.

void rsa_init	(	rsa_context *	ctx,
		int	padding,
		int	hash_id
	)

Initialize an RSA context.

Note: Set padding to RSA_PKCS_V21 for the RSAES-OAEP encryption scheme and the RSASSA-PSS signature scheme.

Parameters:

ctx	RSA context to be initialized
padding	RSA_PKCS_V15 or RSA_PKCS_V21
hash_id	RSA_PKCS_V21 hash identifier

Note:: The hash_id parameter is actually ignored when using RSA_PKCS_V15 padding.

Definition at line 59 of file rsa.c.

int rsa_pkcs1_decrypt	(	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
	)

Generic wrapper to perform a PKCS#1 decryption using the mode from the context.

Do an RSA operation, then remove the message padding

Parameters:

ctx	RSA context
f_rng	RNG function (Only needed for RSA_PRIVATE)
p_rng	RNG parameter
mode	RSA_PUBLIC or RSA_PRIVATE
olen	will contain the plaintext length
input	buffer holding the encrypted data
output	buffer that will hold the plaintext
output_max_len	maximum length of the output buffer

Returns:: 0 if successful, or an POLARSSL_ERR_RSA_XXX error code

Note:: The output buffer must be as large as the size of ctx->N (eg. 128 bytes if RSA-1024 is used) otherwise an error is thrown.

Definition at line 854 of file rsa.c.

int rsa_pkcs1_encrypt	(	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
	)

Generic wrapper to perform a PKCS#1 encryption using the mode from the context.

Add the message padding, then do an RSA operation.

Parameters:

ctx	RSA context
f_rng	RNG function (Needed for padding and PKCS#1 v2.1 encoding and RSA_PRIVATE)
p_rng	RNG parameter
mode	RSA_PUBLIC or RSA_PRIVATE
ilen	contains the plaintext length
input	buffer holding the data to be encrypted
output	buffer that will hold the ciphertext

Returns:: 0 if successful, or an POLARSSL_ERR_RSA_XXX error code

Note:: The output buffer must be as large as the size of ctx->N (eg. 128 bytes if RSA-1024 is used).

Definition at line 626 of file rsa.c.

int rsa_pkcs1_sign	(	rsa_context *	ctx,
		int()(void , unsigned char *, size_t)	f_rng,
		void *	p_rng,
		int	mode,
		md_type_t	md_alg,
		unsigned int	hashlen,
		const unsigned char *	hash,
		unsigned char *	sig
	)

Generic wrapper to perform a PKCS#1 signature using the mode from the context.

Do a private RSA operation to sign a message digest

Parameters:

ctx	RSA context
f_rng	RNG function (Needed for PKCS#1 v2.1 encoding and for RSA_PRIVATE)
p_rng	RNG parameter
mode	RSA_PUBLIC or RSA_PRIVATE
md_alg	a POLARSSL_MD_* (use POLARSSL_MD_NONE for signing raw data)
hashlen	message digest length (for POLARSSL_MD_NONE only)
hash	buffer holding the message digest
sig	buffer that will hold the ciphertext

Returns:: 0 if the signing operation was successful, or an POLARSSL_ERR_RSA_XXX error code

Note:: The "sig" buffer must be as large as the size of ctx->N (eg. 128 bytes if RSA-1024 is used).; In case of PKCS#1 v2.1 encoding keep in mind that the hash_id in the RSA context is the one used for the encoding. hash_id in the function call is the type of hash that is encoded. According to RFC 3447 it is advised to keep both hashes the same.

Definition at line 1068 of file rsa.c.

int rsa_pkcs1_verify	(	rsa_context *	ctx,
		int()(void , unsigned char *, size_t)	f_rng,
		void *	p_rng,
		int	mode,
		md_type_t	md_alg,
		unsigned int	hashlen,
		const unsigned char *	hash,
		const unsigned char *	sig
	)

Generic wrapper to perform a PKCS#1 verification using the mode from the context.

Do a public RSA operation and check the message digest

Parameters:

ctx	points to an RSA public key
f_rng	RNG function (Only needed for RSA_PRIVATE)
p_rng	RNG parameter
mode	RSA_PUBLIC or RSA_PRIVATE
md_alg	a POLARSSL_MD_* (use POLARSSL_MD_NONE for signing raw data)
hashlen	message digest length (for POLARSSL_MD_NONE only)
hash	buffer holding the message digest
sig	buffer holding the ciphertext

Returns:: 0 if the verify operation was successful, or an POLARSSL_ERR_RSA_XXX error code

Note:: The "sig" buffer must be as large as the size of ctx->N (eg. 128 bytes if RSA-1024 is used).; In case of PKCS#1 v2.1 encoding keep in mind that the hash_id in the RSA context is the one used for the verification. hash_id in the function call is the type of hash that is verified. According to RFC 3447 it is advised to keep both hashes the same.

Definition at line 1330 of file rsa.c.

int rsa_private	(	rsa_context *	ctx,
		int()(void , unsigned char *, size_t)	f_rng,
		void *	p_rng,
		const unsigned char *	input,
		unsigned char *	output
	)

Do an RSA private key operation.

Parameters:

ctx	RSA context
f_rng	RNG function (Needed for blinding)
p_rng	RNG parameter
input	input buffer
output	output buffer

Returns:: 0 if successful, or an POLARSSL_ERR_RSA_XXX error code

Note:: The input and output buffers must be large enough (eg. 128 bytes if RSA-1024 is used).

Definition at line 337 of file rsa.c.

int rsa_public	(	rsa_context *	ctx,
		const unsigned char *	input,
		unsigned char *	output
	)

Do an RSA public key operation.

Parameters:

ctx	RSA context
input	input buffer
output	output buffer

Returns:: 0 if successful, or an POLARSSL_ERR_RSA_XXX error code

Note:: This function does NOT take care of message padding. Also, be sure to set input[0] = 0 or assure that input is smaller than N.; The input and output buffers must be large enough (eg. 128 bytes if RSA-1024 is used).

Definition at line 246 of file rsa.c.

int rsa_rsaes_oaep_decrypt	(	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
	)

Perform a PKCS#1 v2.1 OAEP decryption (RSAES-OAEP-DECRYPT)

Parameters:

ctx	RSA context
f_rng	RNG function (Only needed for RSA_PRIVATE)
p_rng	RNG parameter
mode	RSA_PUBLIC or RSA_PRIVATE
label	buffer holding the custom label to use
label_len	contains the label length
olen	will contain the plaintext length
input	buffer holding the encrypted data
output	buffer that will hold the plaintext
output_max_len	maximum length of the output buffer

Returns:: 0 if successful, or an POLARSSL_ERR_RSA_XXX error code

Note:: The output buffer must be as large as the size of ctx->N (eg. 128 bytes if RSA-1024 is used) otherwise an error is thrown.

Definition at line 656 of file rsa.c.

int rsa_rsaes_oaep_encrypt	(	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
	)

Perform a PKCS#1 v2.1 OAEP encryption (RSAES-OAEP-ENCRYPT)

Parameters:

ctx	RSA context
f_rng	RNG function (Needed for padding and PKCS#1 v2.1 encoding and RSA_PRIVATE)
p_rng	RNG parameter
mode	RSA_PUBLIC or RSA_PRIVATE
label	buffer holding the custom label to use
label_len	contains the label length
ilen	contains the plaintext length
input	buffer holding the data to be encrypted
output	buffer that will hold the ciphertext

Returns:: 0 if successful, or an POLARSSL_ERR_RSA_XXX error code

Note:: The output buffer must be as large as the size of ctx->N (eg. 128 bytes if RSA-1024 is used).

Definition at line 492 of file rsa.c.

int rsa_rsaes_pkcs1_v15_decrypt	(	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
	)

Perform a PKCS#1 v1.5 decryption (RSAES-PKCS1-v1_5-DECRYPT)

Parameters:

ctx	RSA context
f_rng	RNG function (Only needed for RSA_PRIVATE)
p_rng	RNG parameter
mode	RSA_PUBLIC or RSA_PRIVATE
olen	will contain the plaintext length
input	buffer holding the encrypted data
output	buffer that will hold the plaintext
output_max_len	maximum length of the output buffer

Returns:: 0 if successful, or an POLARSSL_ERR_RSA_XXX error code

Note:: The output buffer must be as large as the size of ctx->N (eg. 128 bytes if RSA-1024 is used) otherwise an error is thrown.

Definition at line 770 of file rsa.c.

int rsa_rsaes_pkcs1_v15_encrypt	(	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
	)

Perform a PKCS#1 v1.5 encryption (RSAES-PKCS1-v1_5-ENCRYPT)

Parameters:

ctx	RSA context
f_rng	RNG function (Needed for padding and RSA_PRIVATE)
p_rng	RNG parameter
mode	RSA_PUBLIC or RSA_PRIVATE
ilen	contains the plaintext length
input	buffer holding the data to be encrypted
output	buffer that will hold the ciphertext

Returns:: 0 if successful, or an POLARSSL_ERR_RSA_XXX error code

Note:: The output buffer must be as large as the size of ctx->N (eg. 128 bytes if RSA-1024 is used).

Definition at line 564 of file rsa.c.

int rsa_rsassa_pkcs1_v15_sign	(	rsa_context *	ctx,
		int()(void , unsigned char *, size_t)	f_rng,
		void *	p_rng,
		int	mode,
		md_type_t	md_alg,
		unsigned int	hashlen,
		const unsigned char *	hash,
		unsigned char *	sig
	)

Perform a PKCS#1 v1.5 signature (RSASSA-PKCS1-v1_5-SIGN)

Parameters:

ctx	RSA context
f_rng	RNG function (Only needed for RSA_PRIVATE)
p_rng	RNG parameter
mode	RSA_PUBLIC or RSA_PRIVATE
md_alg	a POLARSSL_MD_* (use POLARSSL_MD_NONE for signing raw data)
hashlen	message digest length (for POLARSSL_MD_NONE only)
hash	buffer holding the message digest
sig	buffer that will hold the ciphertext

Returns:: 0 if the signing operation was successful, or an POLARSSL_ERR_RSA_XXX error code

Note:: The "sig" buffer must be as large as the size of ctx->N (eg. 128 bytes if RSA-1024 is used).

Definition at line 985 of file rsa.c.

int rsa_rsassa_pkcs1_v15_verify	(	rsa_context *	ctx,
		int()(void , unsigned char *, size_t)	f_rng,
		void *	p_rng,
		int	mode,
		md_type_t	md_alg,
		unsigned int	hashlen,
		const unsigned char *	hash,
		const unsigned char *	sig
	)

Perform a PKCS#1 v1.5 verification (RSASSA-PKCS1-v1_5-VERIFY)

Parameters:

ctx	points to an RSA public key
f_rng	RNG function (Only needed for RSA_PRIVATE)
p_rng	RNG parameter
mode	RSA_PUBLIC or RSA_PRIVATE
md_alg	a POLARSSL_MD_* (use POLARSSL_MD_NONE for signing raw data)
hashlen	message digest length (for POLARSSL_MD_NONE only)
hash	buffer holding the message digest
sig	buffer holding the ciphertext

Returns:: 0 if the verify operation was successful, or an POLARSSL_ERR_RSA_XXX error code

Note:: The "sig" buffer must be as large as the size of ctx->N (eg. 128 bytes if RSA-1024 is used).

Definition at line 1213 of file rsa.c.

int rsa_rsassa_pss_sign	(	rsa_context *	ctx,
		int()(void , unsigned char *, size_t)	f_rng,
		void *	p_rng,
		int	mode,
		md_type_t	md_alg,
		unsigned int	hashlen,
		const unsigned char *	hash,
		unsigned char *	sig
	)

Perform a PKCS#1 v2.1 PSS signature (RSASSA-PSS-SIGN)

Parameters:

ctx	RSA context
f_rng	RNG function (Needed for PKCS#1 v2.1 encoding and for RSA_PRIVATE)
p_rng	RNG parameter
mode	RSA_PUBLIC or RSA_PRIVATE
md_alg	a POLARSSL_MD_* (use POLARSSL_MD_NONE for signing raw data)
hashlen	message digest length (for POLARSSL_MD_NONE only)
hash	buffer holding the message digest
sig	buffer that will hold the ciphertext

Returns:: 0 if the signing operation was successful, or an POLARSSL_ERR_RSA_XXX error code

Note:: The "sig" buffer must be as large as the size of ctx->N (eg. 128 bytes if RSA-1024 is used).; In case of PKCS#1 v2.1 encoding keep in mind that the hash_id in the RSA context is the one used for the encoding. hash_id in the function call is the type of hash that is encoded. According to RFC 3447 it is advised to keep both hashes the same.

Definition at line 886 of file rsa.c.

int rsa_rsassa_pss_verify	(	rsa_context *	ctx,
		int()(void , unsigned char *, size_t)	f_rng,
		void *	p_rng,
		int	mode,
		md_type_t	md_alg,
		unsigned int	hashlen,
		const unsigned char *	hash,
		const unsigned char *	sig
	)

Perform a PKCS#1 v2.1 PSS verification (RSASSA-PSS-VERIFY)

Parameters:

ctx	points to an RSA public key
f_rng	RNG function (Only needed for RSA_PRIVATE)
p_rng	RNG parameter
mode	RSA_PUBLIC or RSA_PRIVATE
md_alg	a POLARSSL_MD_* (use POLARSSL_MD_NONE for signing raw data)
hashlen	message digest length (for POLARSSL_MD_NONE only)
hash	buffer holding the message digest
sig	buffer holding the ciphertext

Returns:: 0 if the verify operation was successful, or an POLARSSL_ERR_RSA_XXX error code

Note:: The "sig" buffer must be as large as the size of ctx->N (eg. 128 bytes if RSA-1024 is used).; In case of PKCS#1 v2.1 encoding keep in mind that the hash_id in the RSA context is the one used for the verification. hash_id in the function call is the type of hash that is verified. According to RFC 3447 it is advised to keep both hashes the same.

Definition at line 1100 of file rsa.c.

int rsa_self_test ( int verbose )

Checkup routine.

Returns:: 0 if successful, or 1 if the test failed

Definition at line 1498 of file rsa.c.

void rsa_set_padding	(	rsa_context *	ctx,
		int	padding,
		int	hash_id
	)

Set padding for an already initialized RSA context.

Note: Set padding to RSA_PKCS_V21 for the RSAES-OAEP encryption scheme and the RSASSA-PSS signature scheme.

Parameters:

ctx	RSA context to be set
padding	RSA_PKCS_V15 or RSA_PKCS_V21
hash_id	RSA_PKCS_V21 hash identifier

Note:: The hash_id parameter is actually ignored when using RSA_PKCS_V15 padding.

Definition at line 75 of file rsa.c.

Type:	Program
Mbed OS support:	Mbed 2 deprecated
Created:	27 Sep 2018
Imports:	11
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	1
Followers:	1

Important changes to repositories hosted on mbed.com

rsa.h File Reference

Data Structures

Functions

Detailed Description

Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Important changes to repositories hosted on mbed.com

rsa.h File Reference

Data Structures

Functions

Detailed Description

Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning