Rename EVP_PKEY_new_private_key()/EVP_PKEY_new_public_key()

[thirdparty/openssl.git] / doc / man3 / EVP_PKEY_new.pod

diff --git a/doc/man3/EVP_PKEY_new.pod b/doc/man3/EVP_PKEY_new.pod
index e426a38c98562bfe5c082eec5428d6b27de06152..98a0dd158a7d977e71da7ed423a294f62abfb998 100644 (file)
--- a/doc/man3/EVP_PKEY_new.pod
+++ b/doc/man3/EVP_PKEY_new.pod
@@ -5,8 +5,8 @@
 EVP_PKEY_new,
 EVP_PKEY_up_ref,
 EVP_PKEY_free,
-EVP_PKEY_new_private_key,
-EVP_PKEY_new_public_key,
+EVP_PKEY_new_raw_private_key,
+EVP_PKEY_new_raw_public_key,
 EVP_PKEY_new_CMAC_key,
 EVP_PKEY_new_mac_key
 - public/private key allocation functions
@@ -19,10 +19,10 @@ EVP_PKEY_new_mac_key
  int EVP_PKEY_up_ref(EVP_PKEY *key);
  void EVP_PKEY_free(EVP_PKEY *key);
 
- EVP_PKEY *EVP_PKEY_new_private_key(int type, ENGINE *e,
-                                    const unsigned char *key, size_t keylen);
- EVP_PKEY *EVP_PKEY_new_public_key(int type, ENGINE *e,
-                                   const unsigned char *key, size_t keylen);
+ EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
+                                        const unsigned char *key, size_t keylen);
+ EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
+                                       const unsigned char *key, size_t keylen);
  EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
                                  size_t len, const EVP_CIPHER *cipher);
  EVP_PKEY *EVP_PKEY_new_mac_key(int type, ENGINE *e, const unsigned char *key,
@@ -38,10 +38,10 @@ 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.
 
-EVP_PKEY_new_private_key() allocates a new B<EVP_PKEY>. If B<e> is non-NULL then
-the new B<EVP_PKEY> structure is associated with the engine B<e>. The B<type>
-argument indicates what kind of key this is. The value should be a NID for a
-public key algorithm that supports raw private keys, i.e. one of
+EVP_PKEY_new_raw_private_key() allocates a new B<EVP_PKEY>. If B<e> is non-NULL
+then the new B<EVP_PKEY> structure is associated with the engine B<e>. The
+B<type> argument indicates what kind of key this is. The value should be a NID
+for a public key algorithm that supports raw private keys, i.e. one of
 B<EVP_PKEY_HMAC>, B<EVP_PKEY_POLY1305>, B<EVP_PKEY_SIPHASH>, B<EVP_PKEY_X25519>,
 B<EVP_PKEY_ED25519>, B<EVP_PKEY_X448> or B<EVP_PKEY_ED448>. B<key> points to the
 raw private key data for this B<EVP_PKEY> which should be of length B<keylen>.
@@ -49,19 +49,19 @@ The length should be appropriate for the type of the key. The public key data
 will be automatically derived from the given private key data (if appropriate
 for the algorithm type).
 
-EVP_PKEY_new_public_key() works in the same way as EVP_PKEY_new_private_key()
-except that B<key> points to the raw public key data. The B<EVP_PKEY> structure
-will be initialised without any private key information. Algorithm types that
-support raw public keys are B<EVP_PKEY_X25519>, B<EVP_PKEY_ED25519>,
-B<EVP_PKEY_X448> or B<EVP_PKEY_ED448>.
+EVP_PKEY_new_raw_public_key() works in the same way as
+EVP_PKEY_new_raw_private_key() except that B<key> points to the raw public key
+data. The B<EVP_PKEY> structure will be initialised without any private key
+information. Algorithm types that support raw public keys are
+B<EVP_PKEY_X25519>, B<EVP_PKEY_ED25519>, B<EVP_PKEY_X448> or B<EVP_PKEY_ED448>.
 
-EVP_PKEY_new_CMAC_key() works in the same way as EVP_PKEY_new_private_key()
+EVP_PKEY_new_CMAC_key() works in the same way as EVP_PKEY_new_raw_private_key()
 except it is only for the B<EVP_PKEY_CMAC> algorithm type. In addition to the
 raw private key data, it also takes a cipher algorithm to be used during
 creation of a CMAC in the B<cipher> argument.
 
-EVP_PKEY_new_mac_key() works in the same way as EVP_PKEY_new_private_key(). New
-applications should use EVP_PKEY_new_private_key() instead.
+EVP_PKEY_new_mac_key() works in the same way as EVP_PKEY_new_raw_private_key().
+New applications should use EVP_PKEY_new_raw_private_key() instead.
 
 =head1 NOTES
 
@@ -74,7 +74,7 @@ used.
 
 =head1 RETURN VALUES
 
-EVP_PKEY_new(), EVP_PKEY_new_private_key(), EVP_PKEY_new_public_key(),
+EVP_PKEY_new(), EVP_PKEY_new_raw_private_key(), EVP_PKEY_new_raw_public_key(),
 EVP_PKEY_new_CMAC_key() and EVP_PKEY_new_mac_key() return either the newly
 allocated B<EVP_PKEY> structure or B<NULL> if an error occurred.
 
@@ -88,9 +88,9 @@ L<EVP_PKEY_set1_RSA(3)>
 
 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. EVP_PKEY_new_private_key(),
-EVP_PKEY_new_public_key() and EVP_PKEY_new_CMAC_key() were first added to
-OpenSSL 1.1.1.
+EVP_PKEY_up_ref() was first added to OpenSSL 1.1.0.
+EVP_PKEY_new_raw_private_key(), EVP_PKEY_new_raw_public_key() and
+EVP_PKEY_new_CMAC_key() were first added to OpenSSL 1.1.1.
 
 =head1 COPYRIGHT