diff options
Diffstat (limited to 'openssl-1.1.0h/doc/crypto/EVP_PKEY_new.pod')
-rw-r--r-- | openssl-1.1.0h/doc/crypto/EVP_PKEY_new.pod | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/openssl-1.1.0h/doc/crypto/EVP_PKEY_new.pod b/openssl-1.1.0h/doc/crypto/EVP_PKEY_new.pod new file mode 100644 index 0000000..956d699 --- /dev/null +++ b/openssl-1.1.0h/doc/crypto/EVP_PKEY_new.pod @@ -0,0 +1,61 @@ +=pod + +=head1 NAME + +EVP_PKEY_new, EVP_PKEY_up_ref, EVP_PKEY_free - private key allocation functions + +=head1 SYNOPSIS + + #include <openssl/evp.h> + + EVP_PKEY *EVP_PKEY_new(void); + int EVP_PKEY_up_ref(EVP_PKEY *key); + void EVP_PKEY_free(EVP_PKEY *key); + + +=head1 DESCRIPTION + +The EVP_PKEY_new() function allocates an empty B<EVP_PKEY> structure which is +used by OpenSSL to store private keys. The reference count is set to B<1>. + +EVP_PKEY_up_ref() increments the reference count of B<key>. + +EVP_PKEY_free() decrements the reference count of B<key> and, if the reference +count is zero, frees it up. If B<key> is NULL, nothing is done. + +=head1 NOTES + +The B<EVP_PKEY> structure is used by various OpenSSL functions which require a +general private key without reference to any particular algorithm. + +The structure returned by EVP_PKEY_new() is empty. To add a private key to this +empty structure the functions described in L<EVP_PKEY_set1_RSA(3)> should be +used. + +=head1 RETURN VALUES + +EVP_PKEY_new() returns either the newly allocated B<EVP_PKEY> structure or +B<NULL> if an error occurred. + +EVP_PKEY_up_ref() returns 1 for success and 0 for failure. + +=head1 SEE ALSO + +L<EVP_PKEY_set1_RSA(3)> + +=head1 HISTORY + +EVP_PKEY_new() and EVP_PKEY_free() exist in all versions of OpenSSL. + +EVP_PKEY_up_ref() was first added to OpenSSL 1.1.0. + +=head1 COPYRIGHT + +Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (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 +L<https://www.openssl.org/source/license.html>. + +=cut |