[#OSSL_PASSPHRASE_CALLBACK]
= OSSL_PASSPHRASE_CALLBACK
:mrdocs:

Callback that obtains a passphrase, optionally guided by OSSL_PARAM descriptors.

== Synopsis

Declared in `<openssl/core.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
typedef int OSSL_PASSPHRASE_CALLBACK(char*, size_t, size_t*, xref:OSSL_PARAM.adoc[OSSL_PARAM] const[], void*);
----

== Return Value

1 on success, or 0 on failure / cancellation.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *pass*
| Output buffer for the passphrase octets (not necessarily NUL‐terminated).
| *pass_size*
| Capacity of `pass` in bytes.
| *pass_len*
| Receives the number of bytes written to `pass.`
| *params*
| Optional parameters describing UI prompts / verification, or NULL.
| *arg*
| Caller‐supplied opaque pointer.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#