secure/lib/libcrypto/man/man3/EVP_PKEY_new.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "EVP_PKEY_NEW 3"
 136 .TH EVP_PKEY_NEW 3 "2022-05-03" "1.1.1o" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 EVP_PKEY_new, EVP_PKEY_up_ref, EVP_PKEY_free, EVP_PKEY_new_raw_private_key, EVP_PKEY_new_raw_public_key, EVP_PKEY_new_CMAC_key, EVP_PKEY_new_mac_key, EVP_PKEY_get_raw_private_key, EVP_PKEY_get_raw_public_key \&\- public/private key allocation and raw key handling functions
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/evp.h>
 147 \&
 148 \& EVP_PKEY *EVP_PKEY_new(void);
 149 \& int EVP_PKEY_up_ref(EVP_PKEY *key);
 150 \& void EVP_PKEY_free(EVP_PKEY *key);
 151 \&
 152 \& EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
 153 \&                                        const unsigned char *key, size_t keylen);
 154 \& EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
 155 \&                                       const unsigned char *key, size_t keylen);
 156 \& EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
 157 \&                                 size_t len, const EVP_CIPHER *cipher);
 158 \& EVP_PKEY *EVP_PKEY_new_mac_key(int type, ENGINE *e, const unsigned char *key,
 159 \&                                int keylen);
 160 \&
 161 \& int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
 162 \&                                  size_t *len);
 163 \& int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
 164 \&                                 size_t *len);
 165 .Ve
 166 .SH "DESCRIPTION"
 167 .IX Header "DESCRIPTION"
 168 The \fBEVP_PKEY_new()\fR function allocates an empty \fB\s-1EVP_PKEY\s0\fR structure which is
 169 used by OpenSSL to store public and private keys. The reference count is set to
 170 \&\fB1\fR.
 171 .PP
 172 \&\fBEVP_PKEY_up_ref()\fR increments the reference count of \fBkey\fR.
 173 .PP
 174 \&\fBEVP_PKEY_free()\fR decrements the reference count of \fBkey\fR and, if the reference
 175 count is zero, frees it up. If \fBkey\fR is \s-1NULL,\s0 nothing is done.
 176 .PP
 177 \&\fBEVP_PKEY_new_raw_private_key()\fR allocates a new \fB\s-1EVP_PKEY\s0\fR. If \fBe\fR is non-NULL
 178 then the new \fB\s-1EVP_PKEY\s0\fR structure is associated with the engine \fBe\fR. The
 179 \&\fBtype\fR argument indicates what kind of key this is. The value should be a \s-1NID\s0
 180 for a public key algorithm that supports raw private keys, i.e. one of
 181 \&\fB\s-1EVP_PKEY_HMAC\s0\fR, \fB\s-1EVP_PKEY_POLY1305\s0\fR, \fB\s-1EVP_PKEY_SIPHASH\s0\fR, \fB\s-1EVP_PKEY_X25519\s0\fR,
 182 \&\fB\s-1EVP_PKEY_ED25519\s0\fR, \fB\s-1EVP_PKEY_X448\s0\fR or \fB\s-1EVP_PKEY_ED448\s0\fR. \fBkey\fR points to the
 183 raw private key data for this \fB\s-1EVP_PKEY\s0\fR which should be of length \fBkeylen\fR.
 184 The length should be appropriate for the type of the key. The public key data
 185 will be automatically derived from the given private key data (if appropriate
 186 for the algorithm type).
 187 .PP
 188 \&\fBEVP_PKEY_new_raw_public_key()\fR works in the same way as
 189 \&\fBEVP_PKEY_new_raw_private_key()\fR except that \fBkey\fR points to the raw public key
 190 data. The \fB\s-1EVP_PKEY\s0\fR structure will be initialised without any private key
 191 information. Algorithm types that support raw public keys are
 192 \&\fB\s-1EVP_PKEY_X25519\s0\fR, \fB\s-1EVP_PKEY_ED25519\s0\fR, \fB\s-1EVP_PKEY_X448\s0\fR or \fB\s-1EVP_PKEY_ED448\s0\fR.
 193 .PP
 194 \&\fBEVP_PKEY_new_CMAC_key()\fR works in the same way as \fBEVP_PKEY_new_raw_private_key()\fR
 195 except it is only for the \fB\s-1EVP_PKEY_CMAC\s0\fR algorithm type. In addition to the
 196 raw private key data, it also takes a cipher algorithm to be used during
 197 creation of a \s-1CMAC\s0 in the \fBcipher\fR argument. The cipher should be a standard
 198 encryption only cipher. For example \s-1AEAD\s0 and \s-1XTS\s0 ciphers should not be used.
 199 .PP
 200 \&\fBEVP_PKEY_new_mac_key()\fR works in the same way as \fBEVP_PKEY_new_raw_private_key()\fR.
 201 New applications should use \fBEVP_PKEY_new_raw_private_key()\fR instead.
 202 .PP
 203 \&\fBEVP_PKEY_get_raw_private_key()\fR fills the buffer provided by \fBpriv\fR with raw
 204 private key data. The size of the \fBpriv\fR buffer should be in \fB*len\fR on entry
 205 to the function, and on exit \fB*len\fR is updated with the number of bytes
 206 actually written. If the buffer \fBpriv\fR is \s-1NULL\s0 then \fB*len\fR is populated with
 207 the number of bytes required to hold the key. The calling application is
 208 responsible for ensuring that the buffer is large enough to receive the private
 209 key data. This function only works for algorithms that support raw private keys.
 210 Currently this is: \fB\s-1EVP_PKEY_HMAC\s0\fR, \fB\s-1EVP_PKEY_POLY1305\s0\fR, \fB\s-1EVP_PKEY_SIPHASH\s0\fR,
 211 \&\fB\s-1EVP_PKEY_X25519\s0\fR, \fB\s-1EVP_PKEY_ED25519\s0\fR, \fB\s-1EVP_PKEY_X448\s0\fR or \fB\s-1EVP_PKEY_ED448\s0\fR.
 212 .PP
 213 \&\fBEVP_PKEY_get_raw_public_key()\fR fills the buffer provided by \fBpub\fR with raw
 214 public key data. The size of the \fBpub\fR buffer should be in \fB*len\fR on entry
 215 to the function, and on exit \fB*len\fR is updated with the number of bytes
 216 actually written. If the buffer \fBpub\fR is \s-1NULL\s0 then \fB*len\fR is populated with
 217 the number of bytes required to hold the key. The calling application is
 218 responsible for ensuring that the buffer is large enough to receive the public
 219 key data. This function only works for algorithms that support raw public  keys.
 220 Currently this is: \fB\s-1EVP_PKEY_X25519\s0\fR, \fB\s-1EVP_PKEY_ED25519\s0\fR, \fB\s-1EVP_PKEY_X448\s0\fR or
 221 \&\fB\s-1EVP_PKEY_ED448\s0\fR.
 222 .SH "NOTES"
 223 .IX Header "NOTES"
 224 The \fB\s-1EVP_PKEY\s0\fR structure is used by various OpenSSL functions which require a
 225 general private key without reference to any particular algorithm.
 226 .PP
 227 The structure returned by \fBEVP_PKEY_new()\fR is empty. To add a private or public
 228 key to this empty structure use the appropriate functions described in
 229 \&\fBEVP_PKEY_set1_RSA\fR\|(3), EVP_PKEY_set1_DSA, EVP_PKEY_set1_DH or
 230 EVP_PKEY_set1_EC_KEY.
 231 .SH "RETURN VALUES"
 232 .IX Header "RETURN VALUES"
 233 \&\fBEVP_PKEY_new()\fR, \fBEVP_PKEY_new_raw_private_key()\fR, \fBEVP_PKEY_new_raw_public_key()\fR,
 234 \&\fBEVP_PKEY_new_CMAC_key()\fR and \fBEVP_PKEY_new_mac_key()\fR return either the newly
 235 allocated \fB\s-1EVP_PKEY\s0\fR structure or \fB\s-1NULL\s0\fR if an error occurred.
 236 .PP
 237 \&\fBEVP_PKEY_up_ref()\fR, \fBEVP_PKEY_get_raw_private_key()\fR and
 238 \&\fBEVP_PKEY_get_raw_public_key()\fR return 1 for success and 0 for failure.
 239 .SH "SEE ALSO"
 240 .IX Header "SEE ALSO"
 241 \&\fBEVP_PKEY_set1_RSA\fR\|(3), EVP_PKEY_set1_DSA, EVP_PKEY_set1_DH or
 242 EVP_PKEY_set1_EC_KEY
 243 .SH "HISTORY"
 244 .IX Header "HISTORY"
 245 The
 246 \&\fBEVP_PKEY_new()\fR and \fBEVP_PKEY_free()\fR functions exist in all versions of OpenSSL.
 247 .PP
 248 The \fBEVP_PKEY_up_ref()\fR function was added in OpenSSL 1.1.0.
 249 .PP
 250 The
 251 \&\fBEVP_PKEY_new_raw_private_key()\fR, \fBEVP_PKEY_new_raw_public_key()\fR,
 252 \&\fBEVP_PKEY_new_CMAC_key()\fR, \fBEVP_PKEY_new_raw_private_key()\fR and
 253 \&\fBEVP_PKEY_get_raw_public_key()\fR functions were added in OpenSSL 1.1.1.
 254 .SH "COPYRIGHT"
 255 .IX Header "COPYRIGHT"
 256 Copyright 2002\-2020 The OpenSSL Project Authors. All Rights Reserved.
 257 .PP
 258 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 259 this file except in compliance with the License.  You can obtain a copy
 260 in the file \s-1LICENSE\s0 in the source distribution or at
 261 <https://www.openssl.org/source/license.html>.