rsa.h File Reference

Go to the source code of this file.

Functions
int	wc_InitRsaKey (RsaKey *key, void *heap)
	This function initializes a provided RsaKey struct. It also takes in a heap identifier, for use with user defined memory overrides (see XMALLOC, XFREE, XREALLOC). More...
int	wc_InitRsaKey_Id (RsaKey *key, unsigned char *id, int len, void *heap, int devId)
	This function initializes a provided RsaKey struct. The id and len are used to identify the key on the device while the devId identifies the device. It also takes in a heap identifier, for use with user defined memory overrides (see XMALLOC, XFREE, XREALLOC). More...
int	wc_RsaSetRNG (RsaKey *key, WC_RNG *rng)
	This function associates RNG with Key. It is needed when WC_RSA_BLINDING is enabled. More...
int	wc_FreeRsaKey (RsaKey *key)
	This function frees a provided RsaKey struct using mp_clear. More...
int	wc_RsaDirect (byte *in, word32 inLen, byte *out, word32 *outSz, RsaKey *key, int type, WC_RNG *rng)
	Function that does the RSA operation directly with no padding. The input size must match key size. Typically this is used when padding is already done on the RSA input. More...
int	wc_RsaPublicEncrypt (const byte *in, word32 inLen, byte *out, word32 outLen, RsaKey *key, WC_RNG *rng)
	This function encrypts a message from in and stores the result in out. It requires an initialized public key and a random number generator. As a side effect, this function will return the bytes written to out in outLen. More...
int	wc_RsaPrivateDecryptInline (byte *in, word32 inLen, byte **out, RsaKey *key)
	This functions is utilized by the wc_RsaPrivateDecrypt function for decrypting. More...
int	wc_RsaPrivateDecrypt (const byte *in, word32 inLen, byte *out, word32 outLen, RsaKey *key)
	This functions provides private RSA decryption. More...
int	wc_RsaSSL_Sign (const byte *in, word32 inLen, byte *out, word32 outLen, RsaKey *key, WC_RNG *rng)
	Signs the provided array with the private key. More...
int	wc_RsaSSL_VerifyInline (byte *in, word32 inLen, byte **out, RsaKey *key)
	Used to verify that the message was signed by RSA key. The output uses the same byte array as the input. More...
int	wc_RsaSSL_Verify (const byte *in, word32 inLen, byte *out, word32 outLen, RsaKey *key)
	Used to verify that the message was signed by key. More...
int	wc_RsaPSS_Sign (const byte *in, word32 inLen, byte *out, word32 outLen, enum wc_HashType hash, int mgf, RsaKey *key, WC_RNG *rng)
	Signs the provided array with the private key. More...
int	wc_RsaPSS_Verify (byte *in, word32 inLen, byte *out, word32 outLen, enum wc_HashType hash, int mgf, RsaKey *key)
	Decrypt input signature to verify that the message was signed by key. The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING is enabled. More...
int	wc_RsaPSS_VerifyInline (byte *in, word32 inLen, byte **out, enum wc_HashType hash, int mgf, RsaKey *key)
	Decrypt input signature to verify that the message was signed by RSA key. The output uses the same byte array as the input. The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING is enabled. More...
int	wc_RsaPSS_VerifyCheck (byte *in, word32 inLen, byte *out, word32 outLen, const byte *digest, word32 digestLen, enum wc_HashType hash, int mgf, RsaKey *key)
	Verify the message signed with RSA-PSS. Salt length is equal to hash length. The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING is enabled. More...
int	wc_RsaPSS_VerifyCheck_ex (byte *in, word32 inLen, byte *out, word32 outLen, const byte *digest, word32 digestLen, enum wc_HashType hash, int mgf, int saltLen, RsaKey *key)
	Verify the message signed with RSA-PSS. The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING is enabled. More...
int	wc_RsaPSS_VerifyCheckInline (byte *in, word32 inLen, byte **out, const byte *digest, word32 digentLen, enum wc_HashType hash, int mgf, RsaKey *key)
	Verify the message signed with RSA-PSS. The input buffer is reused for the output buffer. Salt length is equal to hash length. More...
int	wc_RsaPSS_VerifyCheckInline_ex (byte *in, word32 inLen, byte **out, const byte *digest, word32 digentLen, enum wc_HashType hash, int mgf, int saltLen, RsaKey *key)
	Verify the message signed with RSA-PSS. The input buffer is reused for the output buffer. The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING is enabled. More...
int	wc_RsaPSS_CheckPadding (const byte *in, word32 inLen, byte *sig, word32 sigSz, enum wc_HashType hashType)
	Checks the PSS data to ensure that the signature matches. Salt length is equal to hash length. The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING is enabled. More...
int	wc_RsaPSS_CheckPadding_ex (const byte *in, word32 inLen, byte *sig, word32 sigSz, enum wc_HashType hashType, int saltLen, int bits)
	Checks the PSS data to ensure that the signature matches. Salt length is equal to hash length. More...
int	wc_RsaEncryptSize (RsaKey *key)
	Returns the encryption size for the provided key structure. More...
int	wc_RsaPrivateKeyDecode (const byte *input, word32 *inOutIdx, RsaKey *key, word32 inSz)
	This function parses a DER-formatted RSA private key, extracts the private key and stores it in the given RsaKey structure. It also sets the distance parsed in idx. More...
int	wc_RsaPublicKeyDecode (const byte *input, word32 *inOutIdx, RsaKey *key, word32 inSz)
	This function parses a DER-formatted RSA public key, extracts the public key and stores it in the given RsaKey structure. It also sets the distance parsed in idx. More...
int	wc_RsaPublicKeyDecodeRaw (const byte *n, word32 nSz, const byte *e, word32 eSz, RsaKey *key)
	This function decodes the raw elements of an RSA public key, taking in the public modulus (n) and exponent (e). It stores these raw elements in the provided RsaKey structure, allowing one to use them in the encryption/decryption process. More...
int	wc_RsaKeyToDer (RsaKey *key, byte *output, word32 inLen)
	This function converts an RsaKey key to DER format. The result is written to output and it returns the number of bytes written. More...
int	wc_RsaPublicEncrypt_ex (const byte *in, word32 inLen, byte *out, word32 outLen, RsaKey *key, WC_RNG *rng, int type, enum wc_HashType hash, int mgf, byte *label, word32 labelSz)
	This function performs RSA encrypt while allowing the choice of which padding to use. More...
int	wc_RsaPrivateDecrypt_ex (const byte *in, word32 inLen, byte *out, word32 outLen, RsaKey *key, int type, enum wc_HashType hash, int mgf, byte *label, word32 labelSz)
	This function uses RSA to decrypt a message and gives the option of what padding type. More...
int	wc_RsaPrivateDecryptInline_ex (byte *in, word32 inLen, byte **out, RsaKey *key, int type, enum wc_HashType hash, int mgf, byte *label, word32 labelSz)
	This function uses RSA to decrypt a message inline and gives the option of what padding type. The in buffer will contain the decrypted message after being called and the out byte pointer will point to the location in the “in” buffer where the plain text is. More...
int	wc_RsaFlattenPublicKey (RsaKey *key, byte *e, word32 *eSz, byte *n, word32 *nSz)
	Flattens the RsaKey structure into individual elements (e, n) used for the RSA algorithm. More...
int	wc_RsaKeyToPublicDer (RsaKey *key, byte *output, word32 inLen)
	Convert Rsa Public key to DER format. Writes to output, and returns count of bytes written. More...
int	wc_RsaKeyToPublicDer_ex (RsaKey *key, byte *output, word32 inLen, int with_header)
	Convert RSA Public key to DER format. Writes to output, and returns count of bytes written. If with_header is 0 then only the ( seq + n + e) is returned in ASN.1 DER format and will exclude the header. More...
int	wc_MakeRsaKey (RsaKey *key, int size, long e, WC_RNG *rng)
	This function generates a RSA private key of length size (in bits) and given exponent (e). It then stores this key in the provided RsaKey structure, so that it may be used for encryption/decryption. A secure number to use for e is 65537. size is required to be greater than RSA_MIN_SIZE and less than RSA_MAX_SIZE. For this function to be available, the option WOLFSSL_KEY_GEN must be enabled at compile time. This can be accomplished with –enable-keygen if using ./configure. More...
int	wc_RsaSetNonBlock (RsaKey *key, RsaNb *nb)
	This function sets the non-blocking RSA context. When a RsaNb context is set it enables fast math based non-blocking exptmod, which splits the RSA function into many smaller operations. Enabled when WC_RSA_NONBLOCK is defined. More...
int	wc_RsaSetNonBlockTime (RsaKey *key, word32 maxBlockUs, word32 cpuMHz)
	This function configures the maximum amount of blocking time in microseconds. It uses a pre-computed table (see tfm.c exptModNbInst) along with the CPU speed in megahertz to determine if the next operation can be completed within the maximum blocking time provided. Enabled when WC_RSA_NONBLOCK_TIME is defined. More...