Ything-RepoMirrors/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2026-01-25 02:56:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

DOC: Add EVP_CIPHER_CTX_{get,set}_app_data documentation

Browse Source 
Fixes #9788

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
MergeDate: Fri Jan 23 10:27:16 2026
(Merged from https://github.com/openssl/openssl/pull/29704)
This commit is contained in:
Daniel Kubec
2026-01-21 15:11:38 +01:00
committed by Norbert Pocs
parent fe67753da4
commit f5f8571119
3 changed files with 44 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/build.info
View File

@@ -1139,6 +1139,10 @@ DEPEND[html/man3/EVP_BytesToKey.html]=man3/EVP_BytesToKey.pod
GENERATE[html/man3/EVP_BytesToKey.html]=man3/EVP_BytesToKey.pod
DEPEND[man/man3/EVP_BytesToKey.3]=man3/EVP_BytesToKey.pod
GENERATE[man/man3/EVP_BytesToKey.3]=man3/EVP_BytesToKey.pod
DEPEND[html/man3/EVP_CIPHER_CTX_get_app_data.html]=man3/EVP_CIPHER_CTX_get_app_data.pod
GENERATE[html/man3/EVP_CIPHER_CTX_get_app_data.html]=man3/EVP_CIPHER_CTX_get_app_data.pod
DEPEND[man/man3/EVP_CIPHER_CTX_get_app_data.3]=man3/EVP_CIPHER_CTX_get_app_data.pod
GENERATE[man/man3/EVP_CIPHER_CTX_get_app_data.3]=man3/EVP_CIPHER_CTX_get_app_data.pod
DEPEND[html/man3/EVP_CIPHER_CTX_get_cipher_data.html]=man3/EVP_CIPHER_CTX_get_cipher_data.pod
GENERATE[html/man3/EVP_CIPHER_CTX_get_cipher_data.html]=man3/EVP_CIPHER_CTX_get_cipher_data.pod
DEPEND[man/man3/EVP_CIPHER_CTX_get_cipher_data.3]=man3/EVP_CIPHER_CTX_get_cipher_data.pod
@@ -3326,6 +3330,7 @@ html/man3/ERR_remove_state.html \
html/man3/ERR_set_mark.html \
html/man3/EVP_ASYM_CIPHER_free.html \
html/man3/EVP_BytesToKey.html \
html/man3/EVP_CIPHER_CTX_get_app_data.html \
html/man3/EVP_CIPHER_CTX_get_cipher_data.html \
html/man3/EVP_CIPHER_CTX_get_original_iv.html \
html/man3/EVP_DigestInit.html \
@@ -3997,6 +4002,7 @@ man/man3/ERR_remove_state.3 \
man/man3/ERR_set_mark.3 \
man/man3/EVP_ASYM_CIPHER_free.3 \
man/man3/EVP_BytesToKey.3 \
man/man3/EVP_CIPHER_CTX_get_app_data.3 \
man/man3/EVP_CIPHER_CTX_get_cipher_data.3 \
man/man3/EVP_CIPHER_CTX_get_original_iv.3 \
man/man3/EVP_DigestInit.3 \

38
doc/man3/EVP_CIPHER_CTX_get_app_data.pod Normal file
View File

@@ -0,0 +1,38 @@
=pod
=head1 NAME
EVP_CIPHER_CTX_get_app_data, EVP_CIPHER_CTX_set_app_data - Routines to
inspect and modify application data related to EVP_CIPHER_CTX
=head1 SYNOPSIS
#include <openssl/evp.h>
void *EVP_CIPHER_CTX_get_app_data(const EVP_CIPHER_CTX *ctx);
void EVP_CIPHER_CTX_set_app_data(EVP_CIPHER_CTX *ctx, void *data);
=head1 DESCRIPTION
The functions EVP_CIPHER_CTX_set_app_data() and EVP_CIPHER_CTX_get_app_data()
associate an opaque, application-defined pointer with an EVP_CIPHER_CTX object.
This pointer is not interpreted by the library and is reserved entirely for use
by the application. It may be used to store arbitrary context or state that
needs to be accessible wherever the corresponding EVP_CIPHER_CTX is available.
=head1 RETURN VALUES
The EVP_CIPHER_CTX_get_app_data() function returns a opaque pointer to the
current application data for the EVP_CIPHER_CTX.
=head1 COPYRIGHT
Copyright 2026 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut

4
doc/man3/EVP_EncryptInit.pod
View File

@@ -69,8 +69,6 @@ EVP_CIPHER_CTX_get_block_size,
EVP_CIPHER_CTX_get_key_length,
EVP_CIPHER_CTX_get_iv_length,
EVP_CIPHER_CTX_get_tag_length,
EVP_CIPHER_CTX_get_app_data,
EVP_CIPHER_CTX_set_app_data,
EVP_CIPHER_CTX_flags,
EVP_CIPHER_CTX_set_flags,
EVP_CIPHER_CTX_clear_flags,
@@ -228,8 +226,6 @@ EVP_CIPHER_CTX_mode
int EVP_CIPHER_CTX_get_key_length(const EVP_CIPHER_CTX *ctx);
int EVP_CIPHER_CTX_get_iv_length(const EVP_CIPHER_CTX *ctx);
int EVP_CIPHER_CTX_get_tag_length(const EVP_CIPHER_CTX *ctx);
void *EVP_CIPHER_CTX_get_app_data(const EVP_CIPHER_CTX *ctx);
void EVP_CIPHER_CTX_set_app_data(const EVP_CIPHER_CTX *ctx, void *data);
int EVP_CIPHER_CTX_get_type(const EVP_CIPHER_CTX *ctx);
int EVP_CIPHER_CTX_get_mode(const EVP_CIPHER_CTX *ctx);
int EVP_CIPHER_CTX_get_num(const EVP_CIPHER_CTX *ctx);