EVP_CIPHER_CTX_get_cipher_data.pod 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. =pod
  2. =head1 NAME
  3. EVP_CIPHER_CTX_get_cipher_data, EVP_CIPHER_CTX_set_cipher_data - Routines to
  4. inspect and modify EVP_CIPHER_CTX objects
  5. =head1 SYNOPSIS
  6. #include <openssl/evp.h>
  7. void *EVP_CIPHER_CTX_get_cipher_data(const EVP_CIPHER_CTX *ctx);
  8. void *EVP_CIPHER_CTX_set_cipher_data(EVP_CIPHER_CTX *ctx, void *cipher_data);
  9. =head1 DESCRIPTION
  10. The EVP_CIPHER_CTX_get_cipher_data() function returns a pointer to the cipher
  11. data relevant to EVP_CIPHER_CTX. The contents of this data is specific to the
  12. particular implementation of the cipher. For example this data can be used by
  13. engines to store engine specific information. The data is automatically
  14. allocated and freed by OpenSSL, so applications and engines should not normally
  15. free this directly (but see below).
  16. The EVP_CIPHER_CTX_set_cipher_data() function allows an application or engine to
  17. replace the cipher data with new data. A pointer to any existing cipher data is
  18. returned from this function. If the old data is no longer required then it
  19. should be freed through a call to OPENSSL_free().
  20. =head1 RETURN VALUES
  21. The EVP_CIPHER_CTX_get_cipher_data() function returns a pointer to the current
  22. cipher data for the EVP_CIPHER_CTX.
  23. The EVP_CIPHER_CTX_set_cipher_data() function returns a pointer to the old
  24. cipher data for the EVP_CIPHER_CTX.
  25. =head1 HISTORY
  26. The EVP_CIPHER_CTX_get_cipher_data() and EVP_CIPHER_CTX_set_cipher_data()
  27. functions were added in OpenSSL 1.1.0.
  28. =head1 COPYRIGHT
  29. Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
  30. Licensed under the Apache License 2.0 (the "License"). You may not use
  31. this file except in compliance with the License. You can obtain a copy
  32. in the file LICENSE in the source distribution or at
  33. L<https://www.openssl.org/source/license.html>.
  34. =cut