secure/lib/libcrypto/man/EVP_PKEY_new.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "EVP_PKEY_NEW 3"
 132 .TH EVP_PKEY_NEW 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/evp.h>
 143 \&
 144 \& EVP_PKEY *EVP_PKEY_new(void);
 145 \& int EVP_PKEY_up_ref(EVP_PKEY *key);
 146 \& void EVP_PKEY_free(EVP_PKEY *key);
 147 \&
 148 \& EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
 149 \&                                        const unsigned char *key, size_t keylen);
 150 \& EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
 151 \&                                       const unsigned char *key, size_t keylen);
 152 \& EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
 153 \&                                 size_t len, const EVP_CIPHER *cipher);
 154 \& EVP_PKEY *EVP_PKEY_new_mac_key(int type, ENGINE *e, const unsigned char *key,
 155 \&                                int keylen);
 156 \&
 157 \& int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
 158 \&                                  size_t *len);
 159 \& int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
 160 \&                                 size_t *len);
 161 .Ve
 162 .SH "DESCRIPTION"
 163 .IX Header "DESCRIPTION"
 164 The \fIEVP_PKEY_new()\fR function allocates an empty \fB\s-1EVP_PKEY\s0\fR structure which is
 165 used by OpenSSL to store public and private keys. The reference count is set to
 166 \&\fB1\fR.
 167 .PP
 168 \&\fIEVP_PKEY_up_ref()\fR increments the reference count of \fBkey\fR.
 169 .PP
 170 \&\fIEVP_PKEY_free()\fR decrements the reference count of \fBkey\fR and, if the reference
 171 count is zero, frees it up. If \fBkey\fR is \s-1NULL,\s0 nothing is done.
 172 .PP
 173 \&\fIEVP_PKEY_new_raw_private_key()\fR allocates a new \fB\s-1EVP_PKEY\s0\fR. If \fBe\fR is non-NULL
 174 then the new \fB\s-1EVP_PKEY\s0\fR structure is associated with the engine \fBe\fR. The
 175 \&\fBtype\fR argument indicates what kind of key this is. The value should be a \s-1NID\s0
 176 for a public key algorithm that supports raw private keys, i.e. one of
 177 \&\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,
 178 \&\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
 179 raw private key data for this \fB\s-1EVP_PKEY\s0\fR which should be of length \fBkeylen\fR.
 180 The length should be appropriate for the type of the key. The public key data
 181 will be automatically derived from the given private key data (if appropriate
 182 for the algorithm type).
 183 .PP
 184 \&\fIEVP_PKEY_new_raw_public_key()\fR works in the same way as
 185 \&\fIEVP_PKEY_new_raw_private_key()\fR except that \fBkey\fR points to the raw public key
 186 data. The \fB\s-1EVP_PKEY\s0\fR structure will be initialised without any private key
 187 information. Algorithm types that support raw public keys are
 188 \&\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.
 189 .PP
 190 \&\fIEVP_PKEY_new_CMAC_key()\fR works in the same way as \fIEVP_PKEY_new_raw_private_key()\fR
 191 except it is only for the \fB\s-1EVP_PKEY_CMAC\s0\fR algorithm type. In addition to the
 192 raw private key data, it also takes a cipher algorithm to be used during
 193 creation of a \s-1CMAC\s0 in the \fBcipher\fR argument.
 194 .PP
 195 \&\fIEVP_PKEY_new_mac_key()\fR works in the same way as \fIEVP_PKEY_new_raw_private_key()\fR.
 196 New applications should use \fIEVP_PKEY_new_raw_private_key()\fR instead.
 197 .PP
 198 \&\fIEVP_PKEY_get_raw_private_key()\fR fills the buffer provided by \fBpriv\fR with raw
 199 private key data. The number of bytes written is populated in \fB*len\fR. If the
 200 buffer \fBpriv\fR is \s-1NULL\s0 then \fB*len\fR is populated with the number of bytes
 201 required to hold the key. The calling application is responsible for ensuring
 202 that the buffer is large enough to receive the private key data. This function
 203 only works for algorithms that support raw private keys. Currently this is:
 204 \&\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,
 205 \&\fB\s-1EVP_PKEY_ED25519\s0\fR, \fB\s-1EVP_PKEY_X448\s0\fR or \fB\s-1EVP_PKEY_ED448\s0\fR.
 206 .PP
 207 \&\fIEVP_PKEY_get_raw_public_key()\fR fills the buffer provided by \fBpub\fR with raw
 208 public key data. The number of bytes written is populated in \fB*len\fR. If the
 209 buffer \fBpub\fR is \s-1NULL\s0 then \fB*len\fR is populated with the number of bytes
 210 required to hold the key. The calling application is responsible for ensuring
 211 that the buffer is large enough to receive the public key data. This function
 212 only works for algorithms that support raw public  keys. Currently this is:
 213 \&\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.
 214 .SH "NOTES"
 215 .IX Header "NOTES"
 216 The \fB\s-1EVP_PKEY\s0\fR structure is used by various OpenSSL functions which require a
 217 general private key without reference to any particular algorithm.
 218 .PP
 219 The structure returned by \fIEVP_PKEY_new()\fR is empty. To add a private or public
 220 key to this empty structure use the appropriate functions described in
 221 \&\fIEVP_PKEY_set1_RSA\fR\|(3), EVP_PKEY_set1_DSA, EVP_PKEY_set1_DH or
 222 EVP_PKEY_set1_EC_KEY.
 223 .SH "RETURN VALUES"
 224 .IX Header "RETURN VALUES"
 225 \&\fIEVP_PKEY_new()\fR, \fIEVP_PKEY_new_raw_private_key()\fR, \fIEVP_PKEY_new_raw_public_key()\fR,
 226 \&\fIEVP_PKEY_new_CMAC_key()\fR and \fIEVP_PKEY_new_mac_key()\fR return either the newly
 227 allocated \fB\s-1EVP_PKEY\s0\fR structure or \fB\s-1NULL\s0\fR if an error occurred.
 228 .PP
 229 \&\fIEVP_PKEY_up_ref()\fR, \fIEVP_PKEY_get_raw_private_key()\fR and
 230 \&\fIEVP_PKEY_get_raw_public_key()\fR return 1 for success and 0 for failure.
 231 .SH "SEE ALSO"
 232 .IX Header "SEE ALSO"
 233 \&\fIEVP_PKEY_set1_RSA\fR\|(3), EVP_PKEY_set1_DSA, EVP_PKEY_set1_DH or
 234 EVP_PKEY_set1_EC_KEY
 235 .SH "HISTORY"
 236 .IX Header "HISTORY"
 237 \&\fIEVP_PKEY_new()\fR and \fIEVP_PKEY_free()\fR exist in all versions of OpenSSL.
 238 .PP
 239 \&\fIEVP_PKEY_up_ref()\fR was first added to OpenSSL 1.1.0.
 240 \&\fIEVP_PKEY_new_raw_private_key()\fR, \fIEVP_PKEY_new_raw_public_key()\fR,
 241 \&\fIEVP_PKEY_new_CMAC_key()\fR, \fIEVP_PKEY_new_raw_private_key()\fR and
 242 \&\fIEVP_PKEY_get_raw_public_key()\fR were first added to OpenSSL 1.1.1.
 243 .SH "COPYRIGHT"
 244 .IX Header "COPYRIGHT"
 245 Copyright 2002\-2018 The OpenSSL Project Authors. All Rights Reserved.
 246 .PP
 247 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 248 this file except in compliance with the License.  You can obtain a copy
 249 in the file \s-1LICENSE\s0 in the source distribution or at
 250 <https://www.openssl.org/source/license.html>.