xref: /freebsd/secure/lib/libcrypto/man/man3/EVP_PKEY_CTX_get_algor.3 (revision 4757b351ea9d59d71d4a38b82506d2d16fcd560d)
-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.0102 (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 ========================================================================

Title "EVP_PKEY_CTX_GET_ALGOR 3ossl"
EVP_PKEY_CTX_GET_ALGOR 3ossl 2025-07-01 3.5.1 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
EVP_CIPHER_CTX_get_algor, EVP_CIPHER_CTX_get_algor_params, EVP_CIPHER_CTX_set_algor_params, EVP_PKEY_CTX_get_algor, EVP_PKEY_CTX_get_algor_params, EVP_PKEY_CTX_set_algor_params \- pass AlgorithmIdentifier and its params to/from algorithm implementations
SYNOPSIS
Header "SYNOPSIS" .Vb 3 int EVP_TYPE_CTX_get_algor(EVP_TYPE_CTX *ctx, X509_ALGOR **alg); int EVP_TYPE_CTX_get_algor_params(EVP_TYPE_CTX *ctx, X509_ALGOR *alg); int EVP_TYPE_CTX_set_algor_params(EVP_TYPE_CTX *ctx, const X509_ALGOR *alg); .Ve
DESCRIPTION
Header "DESCRIPTION" In the description here and the "SYNOPSIS" above, \f(BITYPE is used as a placeholder for any EVP operation type.

\fBEVP_\f(BITYPE_CTX_get_algor() attempts to retrieve a complete AlgorithmIdentifier from the EVP_\f(BITYPE implementation, and populates \fI*alg with it. If alg is NULL, calling this function will serve to see if calling this function is supported at all by the EVP_\f(BITYPE implementation. If *alg is NULL, space will be allocated automatically, and assigned to \fI*alg.

\fBEVP_\f(BITYPE_CTX_get_algor_params() attempts to retrieve the parameters part of an AlgorithmIdentifier from the EVP_\f(BITYPE implementation, and populates alg-parameters> with it. If alg is NULL, calling this function will serve to see if calling this function is supported at all by the EVP_\f(BITYPE implementation. If alg->parameters is NULL, space will be allocated automatically, and assigned to alg->parameters. If alg->parameters is not NULL, its previous contents will be overwritten with the retrieved AlgorithmIdentifier parameters. Beware!

\fBEVP_\f(BITYPE_CTX_set_algor_params() attempts to pass alg->parameters to the EVP_\f(BITYPE implementation. If alg is NULL, calling this function will serve to see if calling this function is supported at all by the EVP_\f(BITYPE implementation.

"RETURN VALUES"
Header "RETURN VALUES" All functions return 1 for success, and 0 or a negative number if an error occurs. In particular, -2 is returned when the function isn't supported by the EVP_\f(BITYPE implementation.
HISTORY
Header "HISTORY" These functions were added in OpenSSL 3.4.
COPYRIGHT
Header "COPYRIGHT" Copyright 2024 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>.