diff options
author | Matt Caswell <matt@openssl.org> | 2018-03-15 12:19:16 +0000 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2018-03-15 12:47:27 +0000 |
commit | f929439f61e7e4cf40e06de56880758b5344f198 (patch) | |
tree | 648214966a8152d218f81d3420b56fffdf744da4 /doc | |
parent | e8f9f08f17e4f15ee737115d336d110dc8dea0ec (diff) |
Rename EVP_PKEY_new_private_key()/EVP_PKEY_new_public_key()
Renamed to EVP_PKEY_new_raw_private_key()/EVP_new_raw_public_key() as per
feedback.
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/5520)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/EVP_PKEY_ASN1_METHOD.pod | 4 | ||||
-rw-r--r-- | doc/man3/EVP_PKEY_CTX_ctrl.pod | 4 | ||||
-rw-r--r-- | doc/man3/EVP_PKEY_new.pod | 44 | ||||
-rw-r--r-- | doc/man7/Ed25519.pod | 12 | ||||
-rw-r--r-- | doc/man7/X25519.pod | 12 |
5 files changed, 38 insertions, 38 deletions
diff --git a/doc/man3/EVP_PKEY_ASN1_METHOD.pod b/doc/man3/EVP_PKEY_ASN1_METHOD.pod index 9b635c480e..eb15e4288d 100644 --- a/doc/man3/EVP_PKEY_ASN1_METHOD.pod +++ b/doc/man3/EVP_PKEY_ASN1_METHOD.pod @@ -345,8 +345,8 @@ L<EVP_PKEY_param_check(3)> respectively. The set_priv_key() and set_pub_key() methods are used to set the raw private and public key data for an EVP_PKEY. They MUST return 0 on error, or 1 on success. -They are called by L<EVP_PKEY_new_private_key(3)>, and -L<EVP_PKEY_new_public_key(3)> respectively. +They are called by L<EVP_PKEY_new_raw_private_key(3)>, and +L<EVP_PKEY_new_raw_public_key(3)> respectively. =head2 Functions diff --git a/doc/man3/EVP_PKEY_CTX_ctrl.pod b/doc/man3/EVP_PKEY_CTX_ctrl.pod index ed4fd80917..bfc5c85c49 100644 --- a/doc/man3/EVP_PKEY_CTX_ctrl.pod +++ b/doc/man3/EVP_PKEY_CTX_ctrl.pod @@ -88,10 +88,10 @@ allow private key data to be set explicitly using the EVP_PKEY_CTX_set_mac_key() macro. In this case key generation is simply the process of setting up the parameters for the key and then setting the raw key data to the value explicitly provided by that macro. Normally applications would call -L<EVP_PKEY_new_private_key(3)> or similar functions instead of this macro. +L<EVP_PKEY_new_raw_private_key(3)> or similar functions instead of this macro. The EVP_PKEY_CTX_set_mac_key() macro can be used with any of the algorithms -supported by the L<EVP_PKEY_new_private_key(3)> function. +supported by the L<EVP_PKEY_new_raw_private_key(3)> function. The macro EVP_PKEY_CTX_set_rsa_padding() sets the RSA padding mode for B<ctx>. The B<pad> parameter can take the value RSA_PKCS1_PADDING for PKCS#1 padding, diff --git a/doc/man3/EVP_PKEY_new.pod b/doc/man3/EVP_PKEY_new.pod index e426a38c98..98a0dd158a 100644 --- 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 diff --git a/doc/man7/Ed25519.pod b/doc/man7/Ed25519.pod index f2f6fb2a32..eacc05f2ed 100644 --- a/doc/man7/Ed25519.pod +++ b/doc/man7/Ed25519.pod @@ -40,14 +40,14 @@ For the B<Ed448> algorithm a context can be obtained by calling: EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_ED448, NULL); Ed25519 or Ed448 private keys can be set directly using -L<EVP_PKEY_new_private_key(3)> or loaded from a PKCS#8 private key file using -L<PEM_read_bio_PrivateKey(3)> (or similar function). Completely new keys can -also be generated (see the example below). Setting a private key also sets the -associated public key. +L<EVP_PKEY_new_raw_private_key(3)> or loaded from a PKCS#8 private key file +using L<PEM_read_bio_PrivateKey(3)> (or similar function). Completely new keys +can also be generated (see the example below). Setting a private key also sets +the associated public key. Ed25519 or Ed448 public keys can be set directly using -L<EVP_PKEY_new_public_key(3)> or loaded from a SubjectPublicKeyInfo structure -in a PEM file using L<PEM_read_bio_PUBKEY(3)> (or similar function). +L<EVP_PKEY_new_raw_public_key(3)> or loaded from a SubjectPublicKeyInfo +structure in a PEM file using L<PEM_read_bio_PUBKEY(3)> (or similar function). =head1 EXAMPLE diff --git a/doc/man7/X25519.pod b/doc/man7/X25519.pod index f1a9c4928e..7cb6ff6b3b 100644 --- a/doc/man7/X25519.pod +++ b/doc/man7/X25519.pod @@ -28,14 +28,14 @@ For the B<X448> algorithm a context can be obtained by calling: EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_X448, NULL); X25519 or X448 private keys can be set directly using -L<EVP_PKEY_new_private_key(3)> or loaded from a PKCS#8 private key file using -L<PEM_read_bio_PrivateKey(3)> (or similar function). Completely new keys can -also be generated (see the example below). Setting a private key also sets the -associated public key. +L<EVP_PKEY_new_raw_private_key(3)> or loaded from a PKCS#8 private key file +using L<PEM_read_bio_PrivateKey(3)> (or similar function). Completely new keys +can also be generated (see the example below). Setting a private key also sets +the associated public key. X25519 or X448 public keys can be set directly using -L<EVP_PKEY_new_public_key(3)> or loaded from a SubjectPublicKeyInfo structure -in a PEM file using L<PEM_read_bio_PUBKEY(3)> (or similar function). +L<EVP_PKEY_new_raw_public_key(3)> or loaded from a SubjectPublicKeyInfo +structure in a PEM file using L<PEM_read_bio_PUBKEY(3)> (or similar function). =head1 EXAMPLE |