[#OSSL_PASSPHRASE_CALLBACK]
= OSSL&lowbar;PASSPHRASE&lowbar;CALLBACK
:mrdocs:

Callback that obtains a passphrase, optionally guided by OSSL&lowbar;PARAM descriptors&period;

== Synopsis

Declared in `&lt;openssl&sol;core&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
typedef int OSSL&lowbar;PASSPHRASE&lowbar;CALLBACK(char*, size&lowbar;t, size&lowbar;t*, xref:OSSL_PARAM.adoc[OSSL&lowbar;PARAM] const[], void*);
----

== Return Value

1 on success, or 0 on failure &sol; cancellation&period;

== Parameters

[cols="1,4"]
|===
| Name| Description
| *pass*
| Output buffer for the passphrase octets (not necessarily NUL&hyphen;terminated)&period;
| *pass&lowbar;size*
| Capacity of `pass` in bytes&period;
| *pass&lowbar;len*
| Receives the number of bytes written to `pass&period;`
| *params*
| Optional parameters describing UI prompts &sol; verification, or NULL&period;
| *arg*
| Caller&hyphen;supplied opaque pointer&period;
|===


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