evp_md_get_number.pod 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. =pod
  2. =head1 NAME
  3. ossl_decoder_get_number, evp_md_get_number, evp_cipher_get_number,
  4. evp_mac_get_number, evp_rand_get_number, evp_keymgmt_get_number,
  5. evp_signature_get_number, evp_asym_cipher_get_number, evp_kem_get_number,
  6. evp_keyexch_get_number, evp_kdf_get_number, ossl_encoder_get_number,
  7. ossl_store_loader_get_number - EVP get internal identification numbers
  8. =head1 SYNOPSIS
  9. #include "crypto/evp.h"
  10. int evp_asym_cipher_get_number(const EVP_ASYM_CIPHER *cipher);
  11. int evp_cipher_get_number(const EVP_CIPHER *e);
  12. int evp_kdf_get_number(const EVP_KDF *kdf);
  13. int evp_kem_get_number(const EVP_KEM *kem);
  14. int evp_keyexch_get_number(const EVP_KEYEXCH *exchange);
  15. int evp_keymgmt_get_number(const EVP_KEYMGMT *keymgmt);
  16. int evp_mac_get_number(const EVP_MAC *mac);
  17. int evp_md_get_number(const EVP_MD *md);
  18. int evp_rand_get_number(const EVP_RAND *rand);
  19. int evp_signature_get_number(const EVP_SIGNATURE *signature);
  20. int ossl_decoder_get_number(const OSSL_DECODER *decoder);
  21. int ossl_encoder_get_number(const OSSL_ENCODER *encoder);
  22. int ossl_store_loader_get_number(const OSSL_STORE_LOADER *loader);
  23. =head1 DESCRIPTION
  24. All provided algorithms get an associated integer identification number.
  25. This number is dynamic and should be expected to vary from run to run.
  26. These numbers should only be considered to be unique per provider per
  27. library context.
  28. =over 4
  29. =item evp_asym_cipher_get_number()
  30. Returns the internal dynamic number assigned to I<cipher>.
  31. =item evp_cipher_get_number()
  32. Returns the internal dynamic number assigned to the I<cipher>. This is only
  33. useful with fetched B<EVP_CIPHER>s.
  34. =item evp_kdf_get_number()
  35. Keturns the internal dynamic number assigned to I<kdf>.
  36. =item evp_kem_get_number()
  37. Returns the internal dynamic number assigned to I<kem>.
  38. =item evp_keyexch_get_number()
  39. Returns the internal dynamic number assigned to the I<exchange>.
  40. =item evp_keymgmt_get_number()
  41. Returns the internal dynamic number assigned to the I<keymgmt>.
  42. =item evp_mac_get_number()
  43. Returns the internal dynamic number assigned to I<mac>.
  44. =item evp_md_get_number()
  45. Returns the internal dynamic number assigned to the I<md>. This is
  46. only useful with fetched B<EVP_MD>s.
  47. =item evp_rand_get_number()
  48. Returns the internal dynamic number assigned to I<rand>.
  49. =item evp_signature_get_number()
  50. Returns the internal dynamic number assigned to I<signature>.
  51. =item ossl_decoder_get_number()
  52. Returns the internal dynamic number assigned to the given I<decoder>.
  53. =item ossl_encoder_get_number()
  54. Returns the internal dynamic number assigned to the given I<encoder>.
  55. =item ossl_store_loader_get_number()
  56. Returns the internal dynamic number assigned to the given I<loader>.
  57. =back
  58. =head1 RETURN VALUES
  59. All of these functions return the provider specific identification number
  60. for the specified algorithm.
  61. =head1 HISTORY
  62. This functionality was added to OpenSSL 3.0.
  63. =head1 COPYRIGHT
  64. Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
  65. Licensed under the Apache License 2.0 (the "License"). You may not use
  66. this file except in compliance with the License. You can obtain a copy
  67. in the file LICENSE in the source distribution or at
  68. L<https://www.openssl.org/source/license.html>.
  69. =cut