EVP_ASYM_CIPHER-RSA.pod 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. =pod
  2. =head1 NAME
  3. EVP_ASYM_CIPHER-RSA
  4. - RSA Asymmetric Cipher algorithm support
  5. =head1 DESCRIPTION
  6. Asymmetric Cipher support for the B<RSA> key type.
  7. =head2 RSA Asymmetric Cipher parameters
  8. =over 4
  9. =item "pad-mode" (B<OSSL_ASYM_CIPHER_PARAM_PAD_MODE>) <UTF8 string>
  10. The default provider understands these RSA padding modes in string form:
  11. =over 4
  12. =item "none" (B<OSSL_PKEY_RSA_PAD_MODE_NONE>)
  13. =item "oaep" (B<OSSL_PKEY_RSA_PAD_MODE_OAEP>)
  14. =item "pkcs1" (B<OSSL_PKEY_RSA_PAD_MODE_PKCSV15>)
  15. =item "x931" (B<OSSL_PKEY_RSA_PAD_MODE_X931>)
  16. =back
  17. =item "pad-mode" (B<OSSL_ASYM_CIPHER_PARAM_PAD_MODE>) <integer>
  18. The default provider understands these RSA padding modes in integer form:
  19. =over 4
  20. =item 1 (B<RSA_PKCS1_PADDING>)
  21. =item 3 (B<RSA_NO_PADDING>)
  22. =item 4 (B<RSA_PKCS1_OAEP_PADDING>)
  23. =item 5 (B<RSA_X931_PADDING>)
  24. =back
  25. See L<EVP_PKEY_CTX_set_rsa_padding(3)> for further details.
  26. =item "digest" (B<OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST>) <UTF8 string>
  27. =item "digest-props" (B<OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS>) <UTF8 string>
  28. =item "mgf1-digest" (B<OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST>) <UTF8 string>
  29. =item "mgf1-digest-props" (B<OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS>) <UTF8 string>
  30. =item "oaep-label" (B<OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL>) <octet string>
  31. =item "tls-client-version" (B<OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION>) <unsigned integer>
  32. See B<RSA_PKCS1_WITH_TLS_PADDING> on the page L<EVP_PKEY_CTX_set_rsa_padding(3)>.
  33. =item "tls-negotiated-version" (B<OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION>) <unsigned integer>
  34. See B<RSA_PKCS1_WITH_TLS_PADDING> on the page L<EVP_PKEY_CTX_set_rsa_padding(3)>.
  35. See L<provider-asym_cipher(7)/Asymmetric Cipher Parameters> for more information.
  36. =back
  37. =head1 SEE ALSO
  38. L<EVP_PKEY-RSA(7)>,
  39. L<EVP_PKEY(3)>,
  40. L<provider-asym_cipher(7)>,
  41. L<provider-keymgmt(7)>,
  42. L<OSSL_PROVIDER-default(7)>
  43. L<OSSL_PROVIDER-FIPS(7)>
  44. =head1 COPYRIGHT
  45. Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
  46. Licensed under the Apache License 2.0 (the "License"). You may not use
  47. this file except in compliance with the License. You can obtain a copy
  48. in the file LICENSE in the source distribution or at
  49. L<https://www.openssl.org/source/license.html>.
  50. =cut