Fix s_server/s_client handling of the split_send_frag argument
[openssl.git] / doc / crypto / EVP_CIPHER_CTX_cipher_data.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_CIPHER_CTX_cipher_data, EVP_CIPHER_CTX_set_cipher_data - Routines to inspect
6 and modify EVP_CIPHER_CTX objects
7
8 =head1 SYNOPSIS
9
10  #include <openssl/evp.h>
11
12  void *EVP_CIPHER_CTX_cipher_data(const EVP_CIPHER_CTX *ctx);
13  void *EVP_CIPHER_CTX_set_cipher_data(EVP_CIPHER_CTX *ctx, void *cipher_data);
14
15 =head1 DESCRIPTION
16
17 The EVP_CIPHER_CTX_cipher_data() function returns a pointer to the cipher data
18 relevant to EVP_CIPHER_CTX. The contents of this data is specific to the
19 particular implementation of the cipher. For example this data can be used by
20 engines to store engine specific information. The data is automatically
21 allocated and freed by OpenSSL, so applications and engines should not normally
22 free this directly (but see below).
23
24 The EVP_CIPHER_CTX_set_cipher_data() function allows an application or engine to
25 replace the cipher data with new data. A pointer to any existing cipher data is
26 returned from this function. If the old data is no longer required then it
27 should be freed through a call to OPENSSL_free().
28
29 =head1 RETURN VALUES
30
31 The EVP_CIPHER_CTX_cipher_data() function returns a pointer to the current
32 cipher data for the EVP_CIPHER_CTX.
33
34 The EVP_CIPHER_CTX_set_cipher_data() function returns a pointer to the old
35 cipher data for the EVP_CIPHER_CTX.
36
37 =head1 HISTORY
38
39 The EVP_CIPHER_CTX_set_cipher_data() function was added in OpenSSL 1.1.0.
40
41 =cut