OSSL_PROVIDER-base.pod 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. =pod
  2. =head1 NAME
  3. OSSL_PROVIDER-base - OpenSSL base provider
  4. =head1 DESCRIPTION
  5. The OpenSSL base provider supplies the encoding for OpenSSL's
  6. asymmetric cryptography.
  7. =head2 Properties
  8. The implementations in this provider specifically have this property
  9. defined:
  10. =over 4
  11. =item "provider=base"
  12. =back
  13. It may be used in a property query string with fetching functions.
  14. It isn't mandatory to query for this property, except to make sure to get
  15. implementations of this provider and none other.
  16. =over 4
  17. =item "type=parameters"
  18. =item "type=private"
  19. =item "type=public"
  20. =back
  21. These may be used in a property query string with fetching functions to select
  22. which data are to be encoded. Either the private key material, the public
  23. key material or the domain parameters can be selected.
  24. =over 4
  25. =item "format=der"
  26. =item "format=pem"
  27. =item "format=text"
  28. =back
  29. These may be used in a property query string with fetching functions to select
  30. the encoding output format. Either the DER, PEM and plaintext are
  31. currently permitted.
  32. =head1 OPERATIONS AND ALGORITHMS
  33. The OpenSSL base provider supports these operations and algorithms:
  34. =head2 Asymmetric Key Encoder
  35. In addition to "provider=base", some of these encoders define the
  36. property "fips=yes", to allow them to be used together with the FIPS
  37. provider.
  38. =over 4
  39. =item RSA, see L<OSSL_ENCODER-RSA(7)>
  40. =item DH, see L<OSSL_ENCODER-DH(7)>
  41. =item DSA, see L<OSSL_ENCODER-DSA(7)>
  42. =item EC, see L<OSSL_ENCODER-EC(7)>
  43. =item X25519, see L<OSSL_ENCODER-X25519(7)>
  44. =item X448, see L<OSSL_ENCODER-X448(7)>
  45. =back
  46. =head1 SEE ALSO
  47. L<OSSL_PROVIDER-default(7)>, L<openssl-core.h(7)>,
  48. L<openssl-core_dispatch.h(7)>, L<provider(7)>
  49. =head1 COPYRIGHT
  50. Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
  51. Licensed under the Apache License 2.0 (the "License"). You may not use
  52. this file except in compliance with the License. You can obtain a copy
  53. in the file LICENSE in the source distribution or at
  54. L<https://www.openssl.org/source/license.html>.
  55. =cut