Blame doc/man3/EVP_PKEY_CTX_new.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
EVP_PKEY_CTX_new, EVP_PKEY_CTX_new_id, EVP_PKEY_CTX_dup, EVP_PKEY_CTX_free - public key algorithm context functions
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/evp.h>
Packit c4476c
Packit c4476c
 EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e);
Packit c4476c
 EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e);
Packit c4476c
 EVP_PKEY_CTX *EVP_PKEY_CTX_dup(EVP_PKEY_CTX *ctx);
Packit c4476c
 void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
The EVP_PKEY_CTX_new() function allocates public key algorithm context using
Packit c4476c
the algorithm specified in B<pkey> and ENGINE B<e>.
Packit c4476c
Packit c4476c
The EVP_PKEY_CTX_new_id() function allocates public key algorithm context
Packit c4476c
using the algorithm specified by B<id> and ENGINE B<e>. It is normally used
Packit c4476c
when no B<EVP_PKEY> structure is associated with the operations, for example
Packit c4476c
during parameter generation of key generation for some algorithms.
Packit c4476c
Packit c4476c
EVP_PKEY_CTX_dup() duplicates the context B<ctx>.
Packit c4476c
Packit c4476c
EVP_PKEY_CTX_free() frees up the context B<ctx>.
Packit c4476c
If B<ctx> is NULL, nothing is done.
Packit c4476c
Packit c4476c
=head1 NOTES
Packit c4476c
Packit c4476c
The B<EVP_PKEY_CTX> structure is an opaque public key algorithm context used
Packit c4476c
by the OpenSSL high level public key API. Contexts B<MUST NOT> be shared between
Packit c4476c
threads: that is it is not permissible to use the same context simultaneously
Packit c4476c
in two threads.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
EVP_PKEY_CTX_new(), EVP_PKEY_CTX_new_id(), EVP_PKEY_CTX_dup() returns either
Packit c4476c
the newly allocated B<EVP_PKEY_CTX> structure of B<NULL> if an error occurred.
Packit c4476c
Packit c4476c
EVP_PKEY_CTX_free() does not return a value.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<EVP_PKEY_new(3)>
Packit c4476c
Packit c4476c
=head1 HISTORY
Packit c4476c
Packit c4476c
These functions were added in OpenSSL 1.0.0.
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut