Blame doc/man3/EVP_CIPHER_CTX_get_cipher_data.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
EVP_CIPHER_CTX_get_cipher_data, EVP_CIPHER_CTX_set_cipher_data - Routines to
Packit c4476c
inspect and modify EVP_CIPHER_CTX objects
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/evp.h>
Packit c4476c
Packit c4476c
 void *EVP_CIPHER_CTX_get_cipher_data(const EVP_CIPHER_CTX *ctx);
Packit c4476c
 void *EVP_CIPHER_CTX_set_cipher_data(EVP_CIPHER_CTX *ctx, void *cipher_data);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
The EVP_CIPHER_CTX_get_cipher_data() function returns a pointer to the cipher
Packit c4476c
data relevant to EVP_CIPHER_CTX. The contents of this data is specific to the
Packit c4476c
particular implementation of the cipher. For example this data can be used by
Packit c4476c
engines to store engine specific information. The data is automatically
Packit c4476c
allocated and freed by OpenSSL, so applications and engines should not normally
Packit c4476c
free this directly (but see below).
Packit c4476c
Packit c4476c
The EVP_CIPHER_CTX_set_cipher_data() function allows an application or engine to
Packit c4476c
replace the cipher data with new data. A pointer to any existing cipher data is
Packit c4476c
returned from this function. If the old data is no longer required then it
Packit c4476c
should be freed through a call to OPENSSL_free().
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
The EVP_CIPHER_CTX_get_cipher_data() function returns a pointer to the current
Packit c4476c
cipher data for the EVP_CIPHER_CTX.
Packit c4476c
Packit c4476c
The EVP_CIPHER_CTX_set_cipher_data() function returns a pointer to the old
Packit c4476c
cipher data for the EVP_CIPHER_CTX.
Packit c4476c
Packit c4476c
=head1 HISTORY
Packit c4476c
Packit c4476c
The EVP_CIPHER_CTX_get_cipher_data() and EVP_CIPHER_CTX_set_cipher_data()
Packit c4476c
functions were added in OpenSSL 1.1.0.
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut