.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "X509_PUBKEY_NEW 3ossl" .TH X509_PUBKEY_NEW 3ossl "2024-01-30" "3.2.1" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" X509_PUBKEY_new_ex, X509_PUBKEY_new, X509_PUBKEY_free, X509_PUBKEY_dup, X509_PUBKEY_set, X509_PUBKEY_get0, X509_PUBKEY_get, d2i_PUBKEY_ex, d2i_PUBKEY, i2d_PUBKEY, d2i_PUBKEY_ex_bio, d2i_PUBKEY_bio, d2i_PUBKEY_ex_fp, d2i_PUBKEY_fp, i2d_PUBKEY_fp, i2d_PUBKEY_bio, X509_PUBKEY_set0_public_key, X509_PUBKEY_set0_param, X509_PUBKEY_get0_param, X509_PUBKEY_eq \- SubjectPublicKeyInfo public key functions .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& #include \& \& X509_PUBKEY *X509_PUBKEY_new_ex(OSSL_LIB_CTX *libctx, const char *propq); \& X509_PUBKEY *X509_PUBKEY_new(void); \& void X509_PUBKEY_free(X509_PUBKEY *a); \& X509_PUBKEY *X509_PUBKEY_dup(const X509_PUBKEY *a); \& \& int X509_PUBKEY_set(X509_PUBKEY **x, EVP_PKEY *pkey); \& EVP_PKEY *X509_PUBKEY_get0(const X509_PUBKEY *key); \& EVP_PKEY *X509_PUBKEY_get(const X509_PUBKEY *key); \& \& EVP_PKEY *d2i_PUBKEY_ex(EVP_PKEY **a, const unsigned char **pp, long length, \& OSSL_LIB_CTX *libctx, const char *propq); \& EVP_PKEY *d2i_PUBKEY(EVP_PKEY **a, const unsigned char **pp, long length); \& int i2d_PUBKEY(const EVP_PKEY *a, unsigned char **pp); \& \& EVP_PKEY *d2i_PUBKEY_ex_bio(BIO *bp, EVP_PKEY **a, OSSL_LIB_CTX *libctx, \& const char *propq); \& EVP_PKEY *d2i_PUBKEY_bio(BIO *bp, EVP_PKEY **a); \& \& EVP_PKEY *d2i_PUBKEY_ex_fp(FILE *fp, EVP_PKEY **a, OSSL_LIB_CTX *libctx, \& const char *propq); \& EVP_PKEY *d2i_PUBKEY_fp(FILE *fp, EVP_PKEY **a); \& \& int i2d_PUBKEY_fp(const FILE *fp, EVP_PKEY *pkey); \& int i2d_PUBKEY_bio(BIO *bp, const EVP_PKEY *pkey); \& \& void X509_PUBKEY_set0_public_key(X509_PUBKEY *pub, \& unsigned char *penc, int penclen); \& int X509_PUBKEY_set0_param(X509_PUBKEY *pub, ASN1_OBJECT *aobj, \& int ptype, void *pval, \& unsigned char *penc, int penclen); \& int X509_PUBKEY_get0_param(ASN1_OBJECT **ppkalg, \& const unsigned char **pk, int *ppklen, \& X509_ALGOR **pa, const X509_PUBKEY *pub); \& int X509_PUBKEY_eq(X509_PUBKEY *a, X509_PUBKEY *b); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \fBX509_PUBKEY\fR structure represents the \s-1ASN.1 \s0\fBSubjectPublicKeyInfo\fR structure defined in \s-1RFC5280\s0 and used in certificates and certificate requests. .PP \&\fIX509_PUBKEY_new_ex()\fR allocates and initializes an \fBX509_PUBKEY\fR structure associated with the given \fB\s-1OSSL_LIB_CTX\s0\fR in the \fIlibctx\fR parameter. Any algorithm fetches associated with using the \fBX509_PUBKEY\fR object will use the property query string \fIpropq\fR. See \*(L"\s-1ALGORITHM FETCHING\*(R"\s0 in \fIcrypto\fR\|(7) for further information about algorithm fetching. .PP \&\fIX509_PUBKEY_new()\fR is the same as \fIX509_PUBKEY_new_ex()\fR except that the default (\s-1NULL\s0) \fB\s-1OSSL_LIB_CTX\s0\fR and a \s-1NULL\s0 property query string are used. .PP \&\fIX509_PUBKEY_dup()\fR creates a duplicate copy of the \fBX509_PUBKEY\fR object specified by \fIa\fR. .PP \&\fIX509_PUBKEY_free()\fR frees up \fBX509_PUBKEY\fR structure \fIa\fR. If \fIa\fR is \s-1NULL\s0 nothing is done. .PP \&\fIX509_PUBKEY_set()\fR sets the public key in \fI*x\fR to the public key contained in the \fB\s-1EVP_PKEY\s0\fR structure \fIpkey\fR. If \fI*x\fR is not \s-1NULL\s0 any existing public key structure will be freed. .PP \&\fIX509_PUBKEY_get0()\fR returns the public key contained in \fIkey\fR. The returned value is an internal pointer which \fB\s-1MUST NOT\s0\fR be freed after use. .PP \&\fIX509_PUBKEY_get()\fR is similar to \fIX509_PUBKEY_get0()\fR except the reference count on the returned key is incremented so it \fB\s-1MUST\s0\fR be freed using \&\fIEVP_PKEY_free()\fR after use. .PP \&\fId2i_PUBKEY_ex()\fR decodes an \fB\s-1EVP_PKEY\s0\fR structure using \fBSubjectPublicKeyInfo\fR format. Some public key decoding implementations may use cryptographic algorithms. In this case the supplied library context \fIlibctx\fR and property query string \fIpropq\fR are used. \&\fId2i_PUBKEY()\fR does the same as \fId2i_PUBKEY_ex()\fR except that the default library context and property query string are used. .PP \&\fIi2d_PUBKEY()\fR encodes an \fB\s-1EVP_PKEY\s0\fR structure using \fBSubjectPublicKeyInfo\fR format. .PP \&\fId2i_PUBKEY_bio()\fR, \fId2i_PUBKEY_fp()\fR, \fIi2d_PUBKEY_bio()\fR and \fIi2d_PUBKEY_fp()\fR are similar to \fId2i_PUBKEY()\fR and \fIi2d_PUBKEY()\fR except they decode or encode using a \&\fB\s-1BIO\s0\fR or \fB\s-1FILE\s0\fR pointer. .PP \&\fId2i_PUBKEY_ex_bio()\fR and \fId2i_PUBKEY_ex_fp()\fR are similar to \fId2i_PUBKEY_ex()\fR except they decode using a \fB\s-1BIO\s0\fR or \fB\s-1FILE\s0\fR pointer. .PP \&\fIX509_PUBKEY_set0_public_key()\fR sets the public-key encoding of \fIpub\fR to the \fIpenclen\fR bytes contained in buffer \fIpenc\fR. Any earlier public-key encoding in \fIpub\fR is freed. \&\fIpenc\fR may be \s-1NULL\s0 to indicate that there is no actual public key data. Ownership of the \fIpenc\fR argument is passed to \fIpub\fR. .PP \&\fIX509_PUBKEY_set0_param()\fR sets the public-key parameters of \fIpub\fR. The \s-1OID\s0 associated with the algorithm is set to \fIaobj\fR. The type of the algorithm parameters is set to \fItype\fR using the structure \fIpval\fR. If \fIpenc\fR is not \s-1NULL\s0 the encoding of the public key itself is set to the \fIpenclen\fR bytes contained in buffer \fIpenc\fR and any earlier public-key encoding in \fIpub\fR is freed. On success ownership of all the supplied arguments is passed to \fIpub\fR so they must not be freed after the call. .PP \&\fIX509_PUBKEY_get0_param()\fR retrieves the public key parameters from \fIpub\fR, \&\fI*ppkalg\fR is set to the associated \s-1OID\s0 and the encoding consists of \&\fI*ppklen\fR bytes at \fI*pk\fR, \fI*pa\fR is set to the associated AlgorithmIdentifier for the public key. If the value of any of these parameters is not required it can be set to \s-1NULL.\s0 All of the retrieved pointers are internal and must not be freed after the call. .PP \&\fIX509_PUBKEY_eq()\fR compares two \fBX509_PUBKEY\fR values. .SH "NOTES" .IX Header "NOTES" The \fBX509_PUBKEY\fR functions can be used to encode and decode public keys in a standard format. .PP In many cases applications will not call the \fBX509_PUBKEY\fR functions directly: they will instead call wrapper functions such as \fIX509_get0_pubkey()\fR. .SH "RETURN VALUES" .IX Header "RETURN VALUES" If the allocation fails, \fIX509_PUBKEY_new()\fR and \fIX509_PUBKEY_dup()\fR return \&\s-1NULL\s0 and set an error code that can be obtained by \fIERR_get_error\fR\|(3). Otherwise they return a pointer to the newly allocated structure. .PP \&\fIX509_PUBKEY_free()\fR does not return a value. .PP \&\fIX509_PUBKEY_get0()\fR, \fIX509_PUBKEY_get()\fR, \fId2i_PUBKEY_ex()\fR, \fId2i_PUBKEY()\fR, \&\fId2i_PUBKEY_ex_bio()\fR, \fId2i_PUBKEY_bio()\fR, \fId2i_PUBKEY_ex_fp()\fR and \fId2i_PUBKEY_fp()\fR return a pointer to an \fB\s-1EVP_PKEY\s0\fR structure or \s-1NULL\s0 if an error occurs. .PP \&\fIi2d_PUBKEY()\fR returns the number of bytes successfully encoded or a negative value if an error occurs. .PP \&\fIi2d_PUBKEY_fp()\fR and \fIi2d_PUBKEY_bio()\fR return 1 if successfully encoded or 0 if an error occurs. .PP \&\fIX509_PUBKEY_set0_public_key()\fR does not return a value. .PP \&\fIX509_PUBKEY_set()\fR, \fIX509_PUBKEY_set0_param()\fR and \fIX509_PUBKEY_get0_param()\fR return 1 for success and 0 if an error occurred. .PP \&\fIX509_PUBKEY_eq()\fR returns 1 for equal, 0 for different, and < 0 on error. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fId2i_X509\fR\|(3), \&\fIERR_get_error\fR\|(3), \&\fIX509_get_pubkey\fR\|(3), .SH "HISTORY" .IX Header "HISTORY" The \fIX509_PUBKEY_new_ex()\fR and \fIX509_PUBKEY_eq()\fR functions were added in OpenSSL 3.0. .PP The \fIX509_PUBKEY_set0_public_key()\fR, \fId2i_PUBKEY_ex_bio()\fR and \fId2i_PUBKEY_ex_fp()\fR functions were added in OpenSSL 3.2. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2016\-2022 The OpenSSL Project Authors. All Rights Reserved. .PP Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at .