|
SharkSSL C/C++ Reference
TLS, cryptography, certificates, and PSA integration
|
Macros | |
| #define | _SHARKSSLRSAKEY_FREE 1 |
Typedefs | |
| typedef U8 * | SharkSslRSAKey |
| SharkSslRSAKey is an alias for the SharkSslCert type and is a private/public key converted by sharkssl_PEM_to_RSAKey or the command line tool SharkSslParseKey. More... | |
Functions | |
| SHARKSSL_API SharkSslRSAKey | sharkssl_PEM_to_RSAKey (const char *PEMKey, const char *passphrase) |
| Convert an RSA private or public key in PEM format to the SharkSslRSAKey format. More... | |
| SHARKSSL_API SharkSslKey | sharkssl_PEM_extractPublicKey (const char *certPEM) |
| Extract the public key form a certificate in PEM format. More... | |
| SHARKSSL_API void | SharkSslRSAKey_free (SharkSslRSAKey key) |
| Release a SharkSslRSAKey allocated by functions sharkssl_PEM_to_RSAKey and sharkssl_PEM_extractPublicKey. More... | |
| SHARKSSL_API sharkssl_RSA_RetVal | sharkssl_RSA_public_encrypt (SharkSslRSAKey pubkey, const U8 *in, int len, U8 *out, int padding) |
| Encrypt data using the public key or private key. More... | |
| SHARKSSL_API sharkssl_RSA_RetVal | sharkssl_RSA_private_decrypt (SharkSslRSAKey privkey, const U8 *in, int len, U8 *out, int padding) |
| Decrypt ciphertext using the private key. More... | |
| SHARKSSL_API sharkssl_RSA_RetVal | sharkssl_RSA_PKCS1V1_5_sign_hash (SharkSslRSAKey privkey, U8 *sig, U16 *siglen, const U8 *hash, U8 hashID) |
| Sign a hash using a private RSA key. More... | |
| SHARKSSL_API sharkssl_RSA_RetVal | sharkssl_RSA_PKCS1V1_5_verify_hash (SharkSslRSAKey pubkey, U8 *sig, U16 siglen, const U8 *hash, U8 hashID) |
| Verify a signature hash using a public RSA key. More... | |
| SHARKSSL_API sharkssl_RSA_RetVal | sharkssl_RSA_private_decrypt_OAEP (SharkSslRSAKey privkey, U8 *in, int len, U8 hashID, U8 *out, const char *label, U16 labelLen) |
| Decrypt ciphertext using the private key, padding is OAEP per RFC 8017. More... | |
| SHARKSSL_API sharkssl_RSA_RetVal | sharkssl_RSA_public_encrypt_OAEP (SharkSslRSAKey pubkey, const U8 *in, int len, U8 hashID, U8 *out, const char *label, U16 labelLen) |
| Encrypt cleartext using the public key, padding is OAEP per RFC 8017. More... | |
| SHARKSSL_API sharkssl_RSA_RetVal | sharkssl_RSA_private_encrypt (SharkSslRSAKey privkey, const U8 *in, int len, U8 *out, int padding) |
| Sign a message digest using the private key. More... | |
| SHARKSSL_API sharkssl_RSA_RetVal | sharkssl_RSA_public_decrypt (SharkSslRSAKey pubkey, const U8 *in, int len, U8 *out, int padding) |
| Bring back a message digest using the public key or private key. More... | |
| #define _SHARKSSLRSAKEY_FREE 1 |
| typedef U8* SharkSslRSAKey |
SharkSslRSAKey is an alias for the SharkSslCert type and is a private/public key converted by sharkssl_PEM_to_RSAKey or the command line tool SharkSslParseKey.
| SharkSslKey sharkssl_PEM_extractPublicKey | ( | const char * | certPEM | ) |
Extract the public key form a certificate in PEM format.
Note: the converted value must be released by calling SharkSslKey_free, when no longer needed.
example:
| certPEM | const char *; required NUL-terminated PEM certificate, or supported PEM public-key text; borrowed for the call. |
| SharkSslRSAKey sharkssl_PEM_to_RSAKey | ( | const char * | PEMKey, |
| const char * | passphrase | ||
| ) |
Convert an RSA private or public key in PEM format to the SharkSslRSAKey format.
Note: the converted value must be released by calling SharkSslRSAKey_free, when no longer needed.
example:
| PEMKey | const char *; required NUL-terminated PEM public/private key text of the matching algorithm, borrowed for the call. |
| passphrase | const char *; optional NUL-terminated password for an encrypted private key, or NULL. |
| SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_PKCS1V1_5_sign_hash | ( | SharkSslRSAKey | privkey, |
| U8 * | sig, | ||
| U16 * | siglen, | ||
| const U8 * | hash, | ||
| U8 | hashID | ||
| ) |
Sign a hash using a private RSA key.
Padding follows PKCS#1 V1.5 per RFC 8017 section 8.2.1.
| privkey | is the private key in SharkSslRSAKey format. |
| sig | Pointer to the buffer where the signature will be stored. The buffer size must be at least SharkSslRSAKey_size. |
| siglen | Pointer to store the length of the generated signature (output parameter). |
| hash | Pointer to the hash to sign. |
| hashID | Identifier for the digest function used. Valid values:
|
| SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_PKCS1V1_5_verify_hash | ( | SharkSslRSAKey | pubkey, |
| U8 * | sig, | ||
| U16 | siglen, | ||
| const U8 * | hash, | ||
| U8 | hashID | ||
| ) |
Verify a signature hash using a public RSA key.
Padding follows PKCS#1 V1.5 per RFC 8017 section 8.2.2.
| pubkey | The public key in SharkSslRSAKey format. A corresponding private key may also be used. |
| sig | Pointer to the signature to verify. |
| siglen | The length of the signature in bytes (input parameter). |
| hash | Pointer to the hash to verify against the signature. |
| hashID | Identifier for the digest function used. Valid values:
|
| SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_private_decrypt | ( | SharkSslRSAKey | privkey, |
| const U8 * | in, | ||
| int | len, | ||
| U8 * | out, | ||
| int | padding | ||
| ) |
Decrypt ciphertext using the private key.
| privkey | is the private key in SharkSslRSAKey format. |
| in | the ciphertext |
| len | is the length/size of parameter 'in'. This length must be exactly SharkSslRSAKey_size (key). |
| out | the decrypted ciphertext is copied to this buffer. The size of this buffer must be no less than SharkSslRSAKey_size (key) |
| padding | is one of SHARKSSL_RSA_PKCS1_PADDING or SHARKSSL_RSA_NO_PADDING |
| SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_private_decrypt_OAEP | ( | SharkSslRSAKey | privkey, |
| U8 * | in, | ||
| int | len, | ||
| U8 | hashID, | ||
| U8 * | out, | ||
| const char * | label, | ||
| U16 | labelLen | ||
| ) |
Decrypt ciphertext using the private key, padding is OAEP per RFC 8017.
| privkey | is the private key in SharkSslRSAKey format. |
| in | the ciphertext (must be in RAM since ITS CONTENT WILL BE MODIFIED) |
| len | is the length/size of parameter 'in'. This length must be exactly SharkSslRSAKey_size(privkey). |
| hashID | an identifier for the digest function used Allowed values are: SHARKSSL_HASHID_SHA1 |
| out | the decrypted ciphertext is copied to this buffer. The size of this buffer must be no less than the expected decrypted text |
| label | is an optional label per RFC 8017 sec. 7.1.1. Use null string when empty. |
| labelLen | is the length of the label. Specify 0 when label is empty |
| SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_private_encrypt | ( | SharkSslRSAKey | privkey, |
| const U8 * | in, | ||
| int | len, | ||
| U8 * | out, | ||
| int | padding | ||
| ) |
Sign a message digest using the private key.
See RFC 8017 sec. 7.1.2
| privkey | is the private key in SharkSslRSAKey format. |
| in | commonly, an algorithm identifier followed by a message digest |
| len | is the length/size of parameter 'in'. This length must be exactly SharkSslRSAKey_size (key) when selecting SHARKSSL_RSA_NO_PADDING or a value between 1 and (SharkSslRSAKey_size (key) - 11) when selecting SHARKSSL_RSA_PKCS1_PADDING. |
| out | the signature is copied to this buffer. The size of this buffer must be no less than SharkSslRSAKey_size (key) |
| padding | is one of SHARKSSL_RSA_PKCS1_PADDING or SHARKSSL_RSA_NO_PADDING |
| SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_public_decrypt | ( | SharkSslRSAKey | pubkey, |
| const U8 * | in, | ||
| int | len, | ||
| U8 * | out, | ||
| int | padding | ||
| ) |
Bring back a message digest using the public key or private key.
The private key includes the public key an can for this reason be used for this operation.
| pubkey | is the public key in SharkSslRSAKey format. |
| in | the RSA signature. Please notice that the RSA signature is modified by this function and must for this reason be in RAM. |
| len | is the length/size of parameter 'in'. This length must be exactly SharkSslRSAKey_size (key). |
| out | the message digest is copied to this buffer. The size of this buffer must be no less than SharkSslRSAKey_size (key) |
| padding | is one of SHARKSSL_RSA_PKCS1_PADDING or SHARKSSL_RSA_NO_PADDING |
| SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_public_encrypt | ( | SharkSslRSAKey | pubkey, |
| const U8 * | in, | ||
| int | len, | ||
| U8 * | out, | ||
| int | padding | ||
| ) |
Encrypt data using the public key or private key.
The private key includes the public key an can for this reason be used for encrypting the data.
| pubkey | is the public key in SharkSslRSAKey format. |
| in | the plaintext |
| len | is the length/size of parameter 'in'. This length must be exactly SharkSslRSAKey_size (key) when selecting SHARKSSL_RSA_NO_PADDING or a value between 1 and (SharkSslRSAKey_size (key) - 11) when selecting SHARKSSL_RSA_PKCS1_PADDING. |
| out | the encrypted ciphertext is copied to this buffer. The size of this buffer must be no less than SharkSslRSAKey_size (key) |
| padding | is one of SHARKSSL_RSA_PKCS1_PADDING or SHARKSSL_RSA_NO_PADDING |
| SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_public_encrypt_OAEP | ( | SharkSslRSAKey | pubkey, |
| const U8 * | in, | ||
| int | len, | ||
| U8 | hashID, | ||
| U8 * | out, | ||
| const char * | label, | ||
| U16 | labelLen | ||
| ) |
Encrypt cleartext using the public key, padding is OAEP per RFC 8017.
| pubkey | is the public key in SharkSslRSAKey format. The matching private key can be provided, too. |
| in | the cleartext (not required to be in RAM) |
| len | is the length/size of parameter 'in'. This length must be not greater than SharkSslRSAKey_size(pubkey) - (2 * labelLen) - 2. |
| hashID | an identifier for the digest function used Allowed values are: SHARKSSL_HASHID_SHA1 |
| out | the encrypted cleartext is copied to this buffer. The size of this buffer must be SharkSslRSAKey_size(pubkey) |
| label | is an optional label per RFC 8017 sec. 7.1.1. Use null string when empty. |
| labelLen | is the length of the label. Specify 0 when label is empty |
| void SharkSslRSAKey_free | ( | SharkSslRSAKey | key | ) |
Release a SharkSslRSAKey allocated by functions sharkssl_PEM_to_RSAKey and sharkssl_PEM_extractPublicKey.
| key | SharkSslRSAKey; dynamically allocated key returned by a conversion/creation API, or NULL. Do not pass static generated key arrays; release every borrower first. |