-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)

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
Required to disable full justification in groff 1.23.0.
========================================================================

Title "EVP_PKEY_GET_SIZE 3ossl" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
EVP_PKEY_get_size, EVP_PKEY_get_bits, EVP_PKEY_get_security_bits, EVP_PKEY_bits, EVP_PKEY_security_bits, EVP_PKEY_size \- EVP_PKEY information functions Header "SYNOPSIS" .Vb 1 #include <openssl/evp.h> \& int EVP_PKEY_get_size(const EVP_PKEY *pkey); int EVP_PKEY_get_bits(const EVP_PKEY *pkey); int EVP_PKEY_get_security_bits(const EVP_PKEY *pkey); \& #define EVP_PKEY_bits EVP_PKEY_get_bits #define EVP_PKEY_security_bits EVP_PKEY_get_security_bits #define EVP_PKEY_size EVP_PKEY_get_size .Ve Header "DESCRIPTION" \fBEVP_PKEY_get_size() returns the maximum suitable size for the output buffers for almost all operations that can be done with pkey. This corresponds to the provider parameter OSSL_PKEY_PARAM_MAX_SIZE. The primary documented use is with EVP_SignFinal\|(3) and \fBEVP_SealInit\|(3), but it isn\*(Aqt limited there. The returned size is also large enough for the output buffer of EVP_PKEY_sign\|(3), \fBEVP_PKEY_encrypt\|(3), EVP_PKEY_decrypt\|(3), EVP_PKEY_derive\|(3).

It must be stressed that, unless the documentation for the operation that\*(Aqs being performed says otherwise, the size returned by \fBEVP_PKEY_get_size() is only preliminary and not exact, so the final contents of the target buffer may be smaller. It is therefore crucial to take note of the size given back by the function that performs the operation, such as EVP_PKEY_sign\|(3) (the siglen argument will receive that length), to avoid bugs.

\fBEVP_PKEY_get_bits() returns the cryptographic length of the cryptosystem to which the key in pkey belongs, in bits. Note that the definition of cryptographic length is specific to the key cryptosystem. This length corresponds to the provider parameter OSSL_PKEY_PARAM_BITS.

\fBEVP_PKEY_get_security_bits() returns the number of security bits of the given \fIpkey, bits of security is defined in NIST SP800-57. This corresponds to the provider parameter OSSL_PKEY_PARAM_SECURITY_BITS.

Header "RETURN VALUES" \fBEVP_PKEY_get_size(), EVP_PKEY_get_bits() and EVP_PKEY_get_security_bits() return a positive number, or 0 if this size isn\*(Aqt available. Header "NOTES" Most functions that have an output buffer and are mentioned with \fBEVP_PKEY_get_size() have a functionality where you can pass NULL for the buffer and still pass a pointer to an integer and get the exact size that this function call delivers in the context that it\*(Aqs called in. This allows those functions to be called twice, once to find out the exact buffer size, then allocate the buffer in between, and call that function again actually output the data. For those functions, it isn\*(Aqt strictly necessary to call EVP_PKEY_get_size() to find out the buffer size, but may be useful in cases where it\*(Aqs desirable to know the upper limit in advance.

It should also be especially noted that EVP_PKEY_get_size() shouldn\*(Aqt be used to get the output size for EVP_DigestSignFinal(), according to "NOTES" in EVP_DigestSignFinal\|(3).

Header "SEE ALSO" \fBprovider-keymgmt\|(7), \fBEVP_SignFinal\|(3), \fBEVP_SealInit\|(3), \fBEVP_PKEY_sign\|(3), \fBEVP_PKEY_encrypt\|(3), \fBEVP_PKEY_decrypt\|(3), \fBEVP_PKEY_derive\|(3) Header "HISTORY" The EVP_PKEY_bits(), EVP_PKEY_security_bits(), and EVP_PKEY_size() functions were renamed to include \*(C`get\*(C' in their names in OpenSSL 3.0, respectively. The old names are kept as non-deprecated alias macros. Header "COPYRIGHT" Copyright 2020-2021 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>.