$NetBSD: EVP_PKEY_todata.3,v 1.5 2024/09/08 13:08:24 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "EVP_PKEY_todata 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
EVP_PKEY_todata, EVP_PKEY_export \- functions to return keys as an array of key parameters Header "SYNOPSIS" .Vb 1 #include <openssl/evp.h> \& int EVP_PKEY_todata(const EVP_PKEY *pkey, int selection, OSSL_PARAM **params); int EVP_PKEY_export(const EVP_PKEY *pkey, int selection, OSSL_CALLBACK *export_cb, void *export_cbarg); .Ve Header "DESCRIPTION" The functions described here are used to extract EVP_PKEY key values as an array of OSSL_PARAM\|(3).

\fBEVP_PKEY_todata() extracts values from a key pkey using the selection. \fIselection is described in "Selections" in EVP_PKEY_fromdata\|(3). \fBOSSL_PARAM_free\|(3) should be used to free the returned parameters in \fI*params.

\fBEVP_PKEY_export() is similar to EVP_PKEY_todata() but uses a callback \fIexport_cb that gets passed the value of export_cbarg. See openssl-core.h\|(7) for more information about the callback. Note that the \fBOSSL_PARAM\|(3) array that is passed to the callback is not persistent after the callback returns. The user must preserve the items of interest, or use \fBEVP_PKEY_todata() if persistence is required.

Header "NOTES" These functions only work with key management methods coming from a provider. This is the mirror function to EVP_PKEY_fromdata\|(3). Header "RETURN VALUES" \fBEVP_PKEY_todata() and EVP_PKEY_export() return 1 for success and 0 for failure. Header "SEE ALSO" \fBOSSL_PARAM\|(3), openssl-core.h\|(7), \fBEVP_PKEY_fromdata\|(3), \fBEVP_PKEY-RSA\|(7), EVP_PKEY-DSA\|(7), EVP_PKEY-DH\|(7), EVP_PKEY-EC\|(7), \fBEVP_PKEY-ED448\|(7), EVP_PKEY-X25519\|(7), EVP_PKEY-X448\|(7), \fBEVP_PKEY-ED25519\|(7) Header "HISTORY" These functions were added in OpenSSL 3.0. Header "COPYRIGHT" Copyright 2021-2023 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 <https://www.openssl.org/source/license.html>.