Standard preamble:
========================================================================
..
.... Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================
Title "EVP_PKEY_NEW 3ossl"
way too many mistakes in technical documents.
The following function has been deprecated since OpenSSL 3.0, and can be hidden entirely by defining \s-1OPENSSL_API_COMPAT\s0 with a suitable version value, see openssl_user_macros\|(7):
.Vb 2 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv, size_t len, const EVP_CIPHER *cipher); .Ve
Conceptually, an \s-1EVP_PKEY\s0 internal key may hold a private key, a public key, or both (a keypair), and along with those, key parameters if the key type requires them. The presence of these components determine what operations can be made; for example, signing normally requires the presence of a private key, and verifying normally requires the presence of a public key.
\fB\s-1EVP_PKEY\s0 has also been used for \s-1MAC\s0 algorithm that were conceived as producing signatures, although not being public key algorithms; \*(L"\s-1POLY1305\*(R", \*(L"SIPHASH\*(R", \*(L"HMAC\*(R", \*(L"CMAC\*(R".\s0 This usage is considered legacy and is discouraged in favor of the \s-1EVP_MAC\s0\|(3) \s-1API.\s0
The EVP_PKEY_new() function allocates an empty \s-1EVP_PKEY\s0 structure which is used by OpenSSL to store public and private keys. The reference count is set to \fB1.
\fBEVP_PKEY_up_ref() increments the reference count of key.
\fBEVP_PKEY_dup() duplicates the key. The key must not be \s-1ENGINE\s0 based or a raw key, otherwise the duplication will fail.
\fBEVP_PKEY_free() decrements the reference count of key and, if the reference count is zero, frees it up. If key is \s-1NULL,\s0 nothing is done.
\fBEVP_PKEY_new_raw_private_key_ex() allocates a new \s-1EVP_PKEY\s0. Unless an engine should be used for the key type, a provider for the key is found using the library context libctx and the property query string propq. The \fIkeytype argument indicates what kind of key this is. The value should be a string for a public key algorithm that supports raw private keys, i.e one of \*(L"X25519\*(R", \*(L"\s-1ED25519\*(R", \*(L"X448\*(R"\s0 or \*(L"\s-1ED448\*(R".\s0 key points to the raw private key data for this \s-1EVP_PKEY\s0 which should be of length keylen. 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).
\fBEVP_PKEY_new_raw_private_key() does the same as \fBEVP_PKEY_new_raw_private_key_ex() except that the default library context and default property query are used instead. If e is non-NULL then the new \fB\s-1EVP_PKEY\s0 structure is associated with the engine e. The type argument indicates what kind of key this is. The value should be a \s-1NID\s0 for a public key algorithm that supports raw private keys, i.e. one of \s-1EVP_PKEY_X25519\s0, \fB\s-1EVP_PKEY_ED25519\s0, \s-1EVP_PKEY_X448\s0 or \s-1EVP_PKEY_ED448\s0.
\fBEVP_PKEY_new_raw_private_key_ex() and EVP_PKEY_new_raw_private_key() may also be used with most MACs implemented as public key algorithms, so key types such as \*(L"\s-1HMAC\*(R", \*(L"POLY1305\*(R", \*(L"SIPHASH\*(R",\s0 or their \s-1NID\s0 form \s-1EVP_PKEY_POLY1305\s0, \fB\s-1EVP_PKEY_SIPHASH\s0, \s-1EVP_PKEY_HMAC\s0 are also accepted. This usage is, as mentioned above, discouraged in favor of the \s-1EVP_MAC\s0\|(3) \s-1API.\s0
\fBEVP_PKEY_new_raw_public_key_ex() works in the same way as \fBEVP_PKEY_new_raw_private_key_ex() except that key points to the raw public key data. The \s-1EVP_PKEY\s0 structure will be initialised without any private key information. Algorithm types that support raw public keys are \*(L"X25519\*(R", \*(L"\s-1ED25519\*(R", \*(L"X448\*(R"\s0 or \*(L"\s-1ED448\*(R".\s0
\fBEVP_PKEY_new_raw_public_key() works in the same way as \fBEVP_PKEY_new_raw_private_key() except that key points to the raw public key data. The \s-1EVP_PKEY\s0 structure will be initialised without any private key information. Algorithm types that support raw public keys are \fB\s-1EVP_PKEY_X25519\s0, \s-1EVP_PKEY_ED25519\s0, \s-1EVP_PKEY_X448\s0 or \s-1EVP_PKEY_ED448\s0.
\fBEVP_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.
\fBEVP_PKEY_get_raw_private_key() fills the buffer provided by priv with raw private key data. The size of the priv buffer should be in *len on entry to the function, and on exit *len is updated with the number of bytes actually written. If the buffer priv is \s-1NULL\s0 then *len is populated with the number of bytes required to hold the key. The calling application is responsible for ensuring that the buffer is large enough to receive the private key data. This function only works for algorithms that support raw private keys. Currently this is: \s-1EVP_PKEY_HMAC\s0, \s-1EVP_PKEY_POLY1305\s0, \s-1EVP_PKEY_SIPHASH\s0, \fB\s-1EVP_PKEY_X25519\s0, \s-1EVP_PKEY_ED25519\s0, \s-1EVP_PKEY_X448\s0 or \s-1EVP_PKEY_ED448\s0.
\fBEVP_PKEY_get_raw_public_key() fills the buffer provided by pub with raw public key data. The size of the pub buffer should be in *len on entry to the function, and on exit *len is updated with the number of bytes actually written. If the buffer pub is \s-1NULL\s0 then *len is populated with the number of bytes required to hold the key. The calling application is responsible for ensuring that the buffer is large enough to receive the public key data. This function only works for algorithms that support raw public keys. Currently this is: \s-1EVP_PKEY_X25519\s0, \s-1EVP_PKEY_ED25519\s0, \s-1EVP_PKEY_X448\s0 or \fB\s-1EVP_PKEY_ED448\s0.
\fBEVP_PKEY_new_CMAC_key() works in the same way as EVP_PKEY_new_raw_private_key() except it is only for the \s-1EVP_PKEY_CMAC\s0 algorithm type. In addition to the raw private key data, it also takes a cipher algorithm to be used during creation of a \s-1CMAC\s0 in the cipher argument. The cipher should be a standard encryption-only cipher. For example \s-1AEAD\s0 and \s-1XTS\s0 ciphers should not be used.
Applications should use the \s-1EVP_MAC\s0\|(3) \s-1API\s0 instead and set the \s-1OSSL_MAC_PARAM_CIPHER\s0 parameter on the \s-1EVP_MAC_CTX\s0 object with the name of the cipher being used.
The structure returned by EVP_PKEY_new() is empty. To add a private or public key to this empty structure use the appropriate functions described in \fBEVP_PKEY_set1_RSA\|(3), EVP_PKEY_set1_DSA\|(3), EVP_PKEY_set1_DH\|(3) or \fBEVP_PKEY_set1_EC_KEY\|(3).
\fBEVP_PKEY_dup() returns the key duplicate or \s-1NULL\s0 if an error occurred.
\fBEVP_PKEY_up_ref(), EVP_PKEY_get_raw_private_key() and \fBEVP_PKEY_get_raw_public_key() return 1 for success and 0 for failure.
The EVP_PKEY_up_ref() function was added in OpenSSL 1.1.0.
The \fBEVP_PKEY_new_raw_private_key(), EVP_PKEY_new_raw_public_key(), \fBEVP_PKEY_new_CMAC_key(), EVP_PKEY_new_raw_private_key() and \fBEVP_PKEY_get_raw_public_key() functions were added in OpenSSL 1.1.1.
The EVP_PKEY_dup(), EVP_PKEY_new_raw_private_key_ex(), and \fBEVP_PKEY_new_raw_public_key_ex() functions were added in OpenSSL 3.0.
The EVP_PKEY_new_CMAC_key() was deprecated in OpenSSL 3.0.
The documentation of \s-1EVP_PKEY\s0 was amended in OpenSSL 3.0 to allow there to be the private part of the keypair without the public part, where this was previously implied to be disallowed.
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.