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

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   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 "X509_PUBKEY_NEW 3"
 136 .TH X509_PUBKEY_NEW 3 "2020-04-21" "1.1.1g" "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 X509_PUBKEY_new, X509_PUBKEY_free, X509_PUBKEY_set, X509_PUBKEY_get0, X509_PUBKEY_get, d2i_PUBKEY, i2d_PUBKEY, d2i_PUBKEY_bio, d2i_PUBKEY_fp, i2d_PUBKEY_fp, i2d_PUBKEY_bio, X509_PUBKEY_set0_param, X509_PUBKEY_get0_param \- SubjectPublicKeyInfo public key functions
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/x509.h>
 147 \&
 148 \& X509_PUBKEY *X509_PUBKEY_new(void);
 149 \& void X509_PUBKEY_free(X509_PUBKEY *a);
 150 \&
 151 \& int X509_PUBKEY_set(X509_PUBKEY **x, EVP_PKEY *pkey);
 152 \& EVP_PKEY *X509_PUBKEY_get0(X509_PUBKEY *key);
 153 \& EVP_PKEY *X509_PUBKEY_get(X509_PUBKEY *key);
 154 \&
 155 \& EVP_PKEY *d2i_PUBKEY(EVP_PKEY **a, const unsigned char **pp, long length);
 156 \& int i2d_PUBKEY(EVP_PKEY *a, unsigned char **pp);
 157 \&
 158 \& EVP_PKEY *d2i_PUBKEY_bio(BIO *bp, EVP_PKEY **a);
 159 \& EVP_PKEY *d2i_PUBKEY_fp(FILE *fp, EVP_PKEY **a);
 160 \&
 161 \& int i2d_PUBKEY_fp(FILE *fp, EVP_PKEY *pkey);
 162 \& int i2d_PUBKEY_bio(BIO *bp, EVP_PKEY *pkey);
 163 \&
 164 \& int X509_PUBKEY_set0_param(X509_PUBKEY *pub, ASN1_OBJECT *aobj,
 165 \&                            int ptype, void *pval,
 166 \&                            unsigned char *penc, int penclen);
 167 \& int X509_PUBKEY_get0_param(ASN1_OBJECT **ppkalg,
 168 \&                            const unsigned char **pk, int *ppklen,
 169 \&                            X509_ALGOR **pa, X509_PUBKEY *pub);
 170 .Ve
 171 .SH "DESCRIPTION"
 172 .IX Header "DESCRIPTION"
 173 The \fBX509_PUBKEY\fR structure represents the \s-1ASN.1\s0 \fBSubjectPublicKeyInfo\fR
 174 structure defined in \s-1RFC5280\s0 and used in certificates and certificate requests.
 175 .PP
 176 \&\fBX509_PUBKEY_new()\fR allocates and initializes an \fBX509_PUBKEY\fR structure.
 177 .PP
 178 \&\fBX509_PUBKEY_free()\fR frees up \fBX509_PUBKEY\fR structure \fBa\fR. If \fBa\fR is \s-1NULL\s0
 179 nothing is done.
 180 .PP
 181 \&\fBX509_PUBKEY_set()\fR sets the public key in \fB*x\fR to the public key contained
 182 in the \fB\s-1EVP_PKEY\s0\fR structure \fBpkey\fR. If \fB*x\fR is not \s-1NULL\s0 any existing
 183 public key structure will be freed.
 184 .PP
 185 \&\fBX509_PUBKEY_get0()\fR returns the public key contained in \fBkey\fR. The returned
 186 value is an internal pointer which \fB\s-1MUST NOT\s0\fR be freed after use.
 187 .PP
 188 \&\fBX509_PUBKEY_get()\fR is similar to \fBX509_PUBKEY_get0()\fR except the reference
 189 count on the returned key is incremented so it \fB\s-1MUST\s0\fR be freed using
 190 \&\fBEVP_PKEY_free()\fR after use.
 191 .PP
 192 \&\fBd2i_PUBKEY()\fR and \fBi2d_PUBKEY()\fR decode and encode an \fB\s-1EVP_PKEY\s0\fR structure
 193 using \fBSubjectPublicKeyInfo\fR format. They otherwise follow the conventions of
 194 other \s-1ASN.1\s0 functions such as \fBd2i_X509()\fR.
 195 .PP
 196 \&\fBd2i_PUBKEY_bio()\fR, \fBd2i_PUBKEY_fp()\fR, \fBi2d_PUBKEY_bio()\fR and \fBi2d_PUBKEY_fp()\fR are
 197 similar to \fBd2i_PUBKEY()\fR and \fBi2d_PUBKEY()\fR except they decode or encode using a
 198 \&\fB\s-1BIO\s0\fR or \fB\s-1FILE\s0\fR pointer.
 199 .PP
 200 \&\fBX509_PUBKEY_set0_param()\fR sets the public key parameters of \fBpub\fR. The
 201 \&\s-1OID\s0 associated with the algorithm is set to \fBaobj\fR. The type of the
 202 algorithm parameters is set to \fBtype\fR using the structure \fBpval\fR.
 203 The encoding of the public key itself is set to the \fBpenclen\fR
 204 bytes contained in buffer \fBpenc\fR. On success ownership of all the supplied
 205 parameters is passed to \fBpub\fR so they must not be freed after the
 206 call.
 207 .PP
 208 \&\fBX509_PUBKEY_get0_param()\fR retrieves the public key parameters from \fBpub\fR,
 209 \&\fB*ppkalg\fR is set to the associated \s-1OID\s0 and the encoding consists of
 210 \&\fB*ppklen\fR bytes at \fB*pk\fR, \fB*pa\fR is set to the associated
 211 AlgorithmIdentifier for the public key. If the value of any of these
 212 parameters is not required it can be set to \fB\s-1NULL\s0\fR. All of the
 213 retrieved pointers are internal and must not be freed after the
 214 call.
 215 .SH "NOTES"
 216 .IX Header "NOTES"
 217 The \fBX509_PUBKEY\fR functions can be used to encode and decode public keys
 218 in a standard format.
 219 .PP
 220 In many cases applications will not call the \fBX509_PUBKEY\fR functions
 221 directly: they will instead call wrapper functions such as \fBX509_get0_pubkey()\fR.
 222 .SH "RETURN VALUES"
 223 .IX Header "RETURN VALUES"
 224 If the allocation fails, \fBX509_PUBKEY_new()\fR returns \fB\s-1NULL\s0\fR and sets an error
 225 code that can be obtained by \fBERR_get_error\fR\|(3).
 226 .PP
 227 Otherwise it returns a pointer to the newly allocated structure.
 228 .PP
 229 \&\fBX509_PUBKEY_free()\fR does not return a value.
 230 .PP
 231 \&\fBX509_PUBKEY_get0()\fR and \fBX509_PUBKEY_get()\fR return a pointer to an \fB\s-1EVP_PKEY\s0\fR
 232 structure or \fB\s-1NULL\s0\fR if an error occurs.
 233 .PP
 234 \&\fBX509_PUBKEY_set()\fR, \fBX509_PUBKEY_set0_param()\fR and \fBX509_PUBKEY_get0_param()\fR
 235 return 1 for success and 0 if an error occurred.
 236 .SH "SEE ALSO"
 237 .IX Header "SEE ALSO"
 238 \&\fBd2i_X509\fR\|(3),
 239 \&\fBERR_get_error\fR\|(3),
 240 \&\fBX509_get_pubkey\fR\|(3),
 241 .SH "COPYRIGHT"
 242 .IX Header "COPYRIGHT"
 243 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
 244 .PP
 245 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 246 this file except in compliance with the License.  You can obtain a copy
 247 in the file \s-1LICENSE\s0 in the source distribution or at
 248 <https://www.openssl.org/source/license.html>.