diff options
| author | Daniel Kubec <[email protected]> | 2026-01-21 23:48:58 +0100 |
|---|---|---|
| committer | Norbert Pocs <[email protected]> | 2026-01-23 11:16:22 +0100 |
| commit | dacef2c26b913d24393fe09fbf40318e92a096f2 (patch) | |
| tree | c00fb49ffe8a9855506cb4081aaa0f1294079801 | |
| parent | Fix NULL pointer dereference when zlib DSO fails to load (diff) | |
| download | openssl-dacef2c26b913d24393fe09fbf40318e92a096f2.tar.gz openssl-dacef2c26b913d24393fe09fbf40318e92a096f2.zip | |
DOC: Clarify EVP_PKEY_CTX_{get,set}_app_data documentation
Reviewed-by: Paul Dale <[email protected]>
Reviewed-by: Shane Lontis <[email protected]>
MergeDate: Fri Jan 23 10:16:28 2026
(Merged from https://github.com/openssl/openssl/pull/29710)
| -rw-r--r-- | doc/man3/EVP_PKEY_keygen.pod | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/man3/EVP_PKEY_keygen.pod b/doc/man3/EVP_PKEY_keygen.pod index 43312361860..4deba4e29f6 100644 --- a/doc/man3/EVP_PKEY_keygen.pod +++ b/doc/man3/EVP_PKEY_keygen.pod @@ -86,10 +86,12 @@ If the callback returns 0 then the key generation operation is aborted and an error occurs. This might occur during a time consuming operation where a user clicks on a "cancel" button. -The functions EVP_PKEY_CTX_set_app_data() and EVP_PKEY_CTX_get_app_data() set -and retrieve an opaque pointer. This can be used to set some application -defined value which can be retrieved in the callback: for example a handle -which is used to update a "progress dialog". +The functions EVP_PKEY_CTX_set_app_data() and EVP_PKEY_CTX_get_app_data() +associate an opaque, application-defined pointer with an EVP_PKEY_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_PKEY_CTX is available. EVP_PKEY_Q_keygen() abstracts from the explicit use of B<EVP_PKEY_CTX> while providing a 'quick' but limited way of generating a new asymmetric key pair. |