xref: /freebsd/secure/lib/libcrypto/man/man3/X509_PUBKEY_new.3 (revision e9e8876a4d6afc1ad5315faaa191b25121a813d7)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. 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 -- \(*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\} . 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.

If the F register is >0, 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'.
.. .nr rF 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 . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . 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 . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . 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 .\} ========================================================================

Title "X509_PUBKEY_NEW 3"
X509_PUBKEY_NEW 3 "2021-12-14" "1.1.1m" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
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
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/x509.h> \& X509_PUBKEY *X509_PUBKEY_new(void); void X509_PUBKEY_free(X509_PUBKEY *a); \& int X509_PUBKEY_set(X509_PUBKEY **x, EVP_PKEY *pkey); EVP_PKEY *X509_PUBKEY_get0(X509_PUBKEY *key); EVP_PKEY *X509_PUBKEY_get(X509_PUBKEY *key); \& EVP_PKEY *d2i_PUBKEY(EVP_PKEY **a, const unsigned char **pp, long length); int i2d_PUBKEY(EVP_PKEY *a, unsigned char **pp); \& EVP_PKEY *d2i_PUBKEY_bio(BIO *bp, EVP_PKEY **a); EVP_PKEY *d2i_PUBKEY_fp(FILE *fp, EVP_PKEY **a); \& int i2d_PUBKEY_fp(FILE *fp, EVP_PKEY *pkey); int i2d_PUBKEY_bio(BIO *bp, EVP_PKEY *pkey); \& 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, X509_PUBKEY *pub); .Ve
"DESCRIPTION"
Header "DESCRIPTION" The X509_PUBKEY structure represents the \s-1ASN.1\s0 SubjectPublicKeyInfo structure defined in \s-1RFC5280\s0 and used in certificates and certificate requests.

\fBX509_PUBKEY_new() allocates and initializes an X509_PUBKEY structure.

\fBX509_PUBKEY_free() frees up X509_PUBKEY structure a. If a is \s-1NULL\s0 nothing is done.

\fBX509_PUBKEY_set() sets the public key in *x to the public key contained in the \s-1EVP_PKEY\s0 structure pkey. If *x is not \s-1NULL\s0 any existing public key structure will be freed.

\fBX509_PUBKEY_get0() returns the public key contained in key. The returned value is an internal pointer which \s-1MUST NOT\s0 be freed after use.

\fBX509_PUBKEY_get() is similar to X509_PUBKEY_get0() except the reference count on the returned key is incremented so it \s-1MUST\s0 be freed using \fBEVP_PKEY_free() after use.

\fBd2i_PUBKEY() and i2d_PUBKEY() decode and encode an \s-1EVP_PKEY\s0 structure using SubjectPublicKeyInfo format. They otherwise follow the conventions of other \s-1ASN.1\s0 functions such as d2i_X509().

\fBd2i_PUBKEY_bio(), d2i_PUBKEY_fp(), i2d_PUBKEY_bio() and i2d_PUBKEY_fp() are similar to d2i_PUBKEY() and i2d_PUBKEY() except they decode or encode using a \fB\s-1BIO\s0 or \s-1FILE\s0 pointer.

\fBX509_PUBKEY_set0_param() sets the public key parameters of pub. The \s-1OID\s0 associated with the algorithm is set to aobj. The type of the algorithm parameters is set to type using the structure pval. The encoding of the public key itself is set to the penclen bytes contained in buffer penc. On success ownership of all the supplied parameters is passed to pub so they must not be freed after the call.

\fBX509_PUBKEY_get0_param() retrieves the public key parameters from pub, \fB*ppkalg is set to the associated \s-1OID\s0 and the encoding consists of \fB*ppklen bytes at *pk, *pa 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.

"NOTES"
Header "NOTES" The X509_PUBKEY functions can be used to encode and decode public keys in a standard format.

In many cases applications will not call the X509_PUBKEY functions directly: they will instead call wrapper functions such as X509_get0_pubkey().

"RETURN VALUES"
Header "RETURN VALUES" If the allocation fails, X509_PUBKEY_new() returns \s-1NULL\s0 and sets an error code that can be obtained by ERR_get_error\|(3).

Otherwise it returns a pointer to the newly allocated structure.

\fBX509_PUBKEY_free() does not return a value.

\fBX509_PUBKEY_get0() and X509_PUBKEY_get() return a pointer to an \s-1EVP_PKEY\s0 structure or \s-1NULL\s0 if an error occurs.

\fBX509_PUBKEY_set(), X509_PUBKEY_set0_param() and X509_PUBKEY_get0_param() return 1 for success and 0 if an error occurred.

"SEE ALSO"
Header "SEE ALSO" \fBd2i_X509\|(3), \fBERR_get_error\|(3), \fBX509_get_pubkey\|(3),
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (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 <https://www.openssl.org/source/license.html>.