mirror of
https://github.com/openssl/openssl.git
synced 2026-01-25 02:56:43 +00:00
DOC: Clarify EVP_PKEY_CTX_{get,set}_app_data documentation
Reviewed-by: Paul Dale <paul.dale@oracle.com> Reviewed-by: Shane Lontis <shane.lontis@oracle.com> MergeDate: Fri Jan 23 10:14:10 2026 (Merged from https://github.com/openssl/openssl/pull/29710)
This commit is contained in:
committed by
Norbert Pocs
parent
a4148379a8
commit
d2a126c20e
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user