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