8 EVP_PKEY_new_raw_private_key_ex,
9 EVP_PKEY_new_raw_private_key,
10 EVP_PKEY_new_raw_public_key_ex,
11 EVP_PKEY_new_raw_public_key,
12 EVP_PKEY_new_CMAC_key_ex,
13 EVP_PKEY_new_CMAC_key,
15 EVP_PKEY_get_raw_private_key,
16 EVP_PKEY_get_raw_public_key
17 - public/private key allocation and raw key handling functions
21 #include <openssl/evp.h>
23 EVP_PKEY *EVP_PKEY_new(void);
24 int EVP_PKEY_up_ref(EVP_PKEY *key);
25 void EVP_PKEY_free(EVP_PKEY *key);
27 EVP_PKEY *EVP_PKEY_new_raw_private_key_ex(OSSL_LIB_CTX *libctx,
30 const unsigned char *key,
32 EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
33 const unsigned char *key, size_t keylen);
34 EVP_PKEY *EVP_PKEY_new_raw_public_key_ex(OSSL_LIB_CTX *libctx,
37 const unsigned char *key,
39 EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
40 const unsigned char *key, size_t keylen);
41 EVP_PKEY *EVP_PKEY_new_CMAC_key_ex(const unsigned char *priv, size_t len,
42 const char *cipher_name,
43 OSSL_LIB_CTX *libctx, const char *propq);
44 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
45 size_t len, const EVP_CIPHER *cipher);
46 EVP_PKEY *EVP_PKEY_new_mac_key(int type, ENGINE *e, const unsigned char *key,
49 int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
51 int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
56 The EVP_PKEY_new() function allocates an empty B<EVP_PKEY> structure which is
57 used by OpenSSL to store public and private keys. The reference count is set to
60 EVP_PKEY_up_ref() increments the reference count of I<key>.
62 EVP_PKEY_free() decrements the reference count of I<key> and, if the reference
63 count is zero, frees it up. If I<key> is NULL, nothing is done.
65 EVP_PKEY_new_raw_private_key_ex() allocates a new B<EVP_PKEY>. Unless
66 an engine should be used for the key type, a provider for the key is found using
67 the library context I<libctx> and the property query string I<propq>. The
68 I<keytype> argument indicates what kind of key this is. The value should be a
69 string for a public key algorithm that supports raw private keys, i.e one of
70 "POLY1305", "SIPHASH", "X25519", "ED25519", "X448" or "ED448". Note that you may
71 also use "HMAC" which is not a public key algorithm but is treated as such by
72 some OpenSSL APIs. You are encouraged to use the EVP_MAC APIs instead for HMAC
73 (see L<EVP_MAC(3)>). I<key> points to the raw private key data for this
74 B<EVP_PKEY> which should be of length I<keylen>. The length should be
75 appropriate for the type of the key. The public key data will be automatically
76 derived from the given private key data (if appropriate for the algorithm type).
78 EVP_PKEY_new_raw_private_key() does the same as
79 EVP_PKEY_new_raw_private_key_ex() except that the default library
80 context and default property query are used instead. If I<e> is non-NULL then
81 the new B<EVP_PKEY> structure is associated with the engine I<e>. The I<type>
82 argument indicates what kind of key this is. The value should be a NID for a
83 public key algorithm that supports raw private keys, i.e. one of
84 B<EVP_PKEY_POLY1305>, B<EVP_PKEY_SIPHASH>, B<EVP_PKEY_X25519>,
85 B<EVP_PKEY_ED25519>, B<EVP_PKEY_X448> or B<EVP_PKEY_ED448>. As for
86 EVP_PKEY_new_raw_private_key_ex() you may also use B<EVP_PKEY_HMAC>.
88 EVP_PKEY_new_raw_public_key_ex() works in the same way as
89 EVP_PKEY_new_raw_private_key_ex() except that I<key> points to the raw
90 public key data. The B<EVP_PKEY> structure will be initialised without any
91 private key information. Algorithm types that support raw public keys are
92 "X25519", "ED25519", "X448" or "ED448".
94 EVP_PKEY_new_raw_public_key() works in the same way as
95 EVP_PKEY_new_raw_private_key() except that I<key> points to the raw public key
96 data. The B<EVP_PKEY> structure will be initialised without any private key
97 information. Algorithm types that support raw public keys are
98 B<EVP_PKEY_X25519>, B<EVP_PKEY_ED25519>, B<EVP_PKEY_X448> or B<EVP_PKEY_ED448>.
100 EVP_PKEY_new_CMAC_key_ex() works in the same way as
101 EVP_PKEY_new_raw_private_key() except it is only for the B<EVP_PKEY_CMAC>
102 algorithm type. In addition to the raw private key data, it also takes a cipher
103 algorithm to be used during creation of a CMAC in the I<cipher> argument. The
104 cipher should be a standard encryption only cipher. For example AEAD and XTS
105 ciphers should not be used. Finally it also takes a library context I<libctx>
106 and property query I<propq> which are used when fetching any cryptographic
107 algorithms which may be NULL to use the default values.
109 EVP_PKEY_new_CMAC_key() is the same as EVP_PKEY_new_CMAC_key_ex()
110 except that the default values are used for I<libctx> and I<propq>.
112 EVP_PKEY_new_mac_key() works in the same way as EVP_PKEY_new_raw_private_key().
113 New applications should use EVP_PKEY_new_raw_private_key() instead.
115 EVP_PKEY_get_raw_private_key() fills the buffer provided by I<priv> with raw
116 private key data. The size of the I<priv> buffer should be in I<*len> on entry
117 to the function, and on exit I<*len> is updated with the number of bytes
118 actually written. If the buffer I<priv> is NULL then I<*len> is populated with
119 the number of bytes required to hold the key. The calling application is
120 responsible for ensuring that the buffer is large enough to receive the private
121 key data. This function only works for algorithms that support raw private keys.
122 Currently this is: B<EVP_PKEY_HMAC>, B<EVP_PKEY_POLY1305>, B<EVP_PKEY_SIPHASH>,
123 B<EVP_PKEY_X25519>, B<EVP_PKEY_ED25519>, B<EVP_PKEY_X448> or B<EVP_PKEY_ED448>.
125 EVP_PKEY_get_raw_public_key() fills the buffer provided by I<pub> with raw
126 public key data. The size of the I<pub> buffer should be in I<*len> on entry
127 to the function, and on exit I<*len> is updated with the number of bytes
128 actually written. If the buffer I<pub> is NULL then I<*len> is populated with
129 the number of bytes required to hold the key. The calling application is
130 responsible for ensuring that the buffer is large enough to receive the public
131 key data. This function only works for algorithms that support raw public keys.
132 Currently this is: B<EVP_PKEY_X25519>, B<EVP_PKEY_ED25519>, B<EVP_PKEY_X448> or
137 The B<EVP_PKEY> structure is used by various OpenSSL functions which require a
138 general private key without reference to any particular algorithm.
140 The structure returned by EVP_PKEY_new() is empty. To add a private or public
141 key to this empty structure use the appropriate functions described in
142 L<EVP_PKEY_set1_RSA(3)>, L<EVP_PKEY_set1_DSA(3)>, L<EVP_PKEY_set1_DH(3)> or
143 L<EVP_PKEY_set1_EC_KEY(3)>.
147 EVP_PKEY_new(), EVP_PKEY_new_raw_private_key(), EVP_PKEY_new_raw_public_key(),
148 EVP_PKEY_new_CMAC_key() and EVP_PKEY_new_mac_key() return either the newly
149 allocated B<EVP_PKEY> structure or B<NULL> if an error occurred.
151 EVP_PKEY_up_ref(), EVP_PKEY_get_raw_private_key() and
152 EVP_PKEY_get_raw_public_key() return 1 for success and 0 for failure.
156 L<EVP_PKEY_set1_RSA(3)>, L<EVP_PKEY_set1_DSA(3)>, L<EVP_PKEY_set1_DH(3)> or
157 L<EVP_PKEY_set1_EC_KEY(3)>
162 EVP_PKEY_new() and EVP_PKEY_free() functions exist in all versions of OpenSSL.
164 The EVP_PKEY_up_ref() function was added in OpenSSL 1.1.0.
167 EVP_PKEY_new_raw_private_key(), EVP_PKEY_new_raw_public_key(),
168 EVP_PKEY_new_CMAC_key(), EVP_PKEY_new_raw_private_key() and
169 EVP_PKEY_get_raw_public_key() functions were added in OpenSSL 1.1.1.
171 The EVP_PKEY_new_raw_private_key_ex(),
172 EVP_PKEY_new_raw_public_key_ex() and
173 EVP_PKEY_new_CMAC_key_ex() functions were added in OpenSSL 3.0.
177 Copyright 2002-2020 The OpenSSL Project Authors. All Rights Reserved.
179 Licensed under the Apache License 2.0 (the "License"). You may not use
180 this file except in compliance with the License. You can obtain a copy
181 in the file LICENSE in the source distribution or at
182 L<https://www.openssl.org/source/license.html>.