projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| 5165148f DSH |
1 | =pod |
| 2 | ||
| 3 | =head1 NAME | |
| 4 | ||
| bb9ad09e | 5 | EVP_PKEY_CTX_new, EVP_PKEY_CTX_new_id, EVP_PKEY_CTX_dup, EVP_PKEY_CTX_free - public key algorithm context functions |
| 5165148f DSH |
6 | |
| 7 | =head1 SYNOPSIS | |
| 8 | ||
| 9 | #include <openssl/evp.h> | |
| 10 | ||
| 11 | EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e); | |
| 12 | EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e); | |
| 13 | EVP_PKEY_CTX *EVP_PKEY_CTX_dup(EVP_PKEY_CTX *ctx); | |
| 14 | void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx); | |
| 15 | ||
| 16 | =head1 DESCRIPTION | |
| 17 | ||
| 18 | The EVP_PKEY_CTX_new() function allocates public key algorithm context using | |
| 19 | the algorithm specified in B<pkey> and ENGINE B<e>. | |
| 20 | ||
| 21 | The EVP_PKEY_CTX_new_id() function allocates public key algorithm context | |
| 22 | using the algorithm specified by B<id> and ENGINE B<e>. It is normally used | |
| 23 | when no B<EVP_PKEY> structure is associated with the operations, for example | |
| 186bb907 | 24 | during parameter generation of key generation for some algorithms. |
| 5165148f DSH |
25 | |
| 26 | EVP_PKEY_CTX_dup() duplicates the context B<ctx>. | |
| 27 | ||
| 28 | EVP_PKEY_CTX_free() frees up the context B<ctx>. | |
| c5ba2d99 | 29 | If B<ctx> is NULL, nothing is done. |
| 5165148f DSH |
30 | |
| 31 | =head1 NOTES | |
| 32 | ||
| 33 | The B<EVP_PKEY_CTX> structure is an opaque public key algorithm context used | |
| 34 | by the OpenSSL high level public key API. Contexts B<MUST NOT> be shared between | |
| 35 | threads: that is it is not permissible to use the same context simultaneously | |
| 36 | in two threads. | |
| 37 | ||
| 38 | =head1 RETURN VALUES | |
| 39 | ||
| 40 | EVP_PKEY_CTX_new(), EVP_PKEY_CTX_new_id(), EVP_PKEY_CTX_dup() returns either | |
| 41 | the newly allocated B<EVP_PKEY_CTX> structure of B<NULL> if an error occurred. | |
| 42 | ||
| 43 | EVP_PKEY_CTX_free() does not return a value. | |
| 44 | ||
| 45 | =head1 SEE ALSO | |
| 46 | ||
| 9b86974e | 47 | L<EVP_PKEY_new(3)> |
| 5165148f DSH |
48 | |
| 49 | =head1 HISTORY | |
| 50 | ||
| fb552ac6 | 51 | These functions were first added to OpenSSL 1.0.0. |
| 5165148f | 52 | |
| e2f92610 RS |
53 | =head1 COPYRIGHT |
| 54 | ||
| 55 | Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved. | |
| 56 | ||
| 57 | Licensed under the OpenSSL license (the "License"). You may not use | |
| 58 | this file except in compliance with the License. You can obtain a copy | |
| 59 | in the file LICENSE in the source distribution or at | |
| 60 | L<https://www.openssl.org/source/license.html>. | |
| 61 | ||
| 62 | =cut |