1X509_PUBKEY_NEW(3)                  OpenSSL                 X509_PUBKEY_NEW(3)
2
3
4

NAME

6       X509_PUBKEY_new, X509_PUBKEY_free, X509_PUBKEY_set, X509_PUBKEY_get0,
7       X509_PUBKEY_get, d2i_PUBKEY, i2d_PUBKEY, d2i_PUBKEY_bio, d2i_PUBKEY_fp,
8       i2d_PUBKEY_fp, i2d_PUBKEY_bio, X509_PUBKEY_set0_param,
9       X509_PUBKEY_get0_param - SubjectPublicKeyInfo public key functions
10

SYNOPSIS

12        #include <openssl/x509.h>
13
14        X509_PUBKEY *X509_PUBKEY_new(void);
15        void X509_PUBKEY_free(X509_PUBKEY *a);
16
17        int X509_PUBKEY_set(X509_PUBKEY **x, EVP_PKEY *pkey);
18        EVP_PKEY *X509_PUBKEY_get0(X509_PUBKEY *key);
19        EVP_PKEY *X509_PUBKEY_get(X509_PUBKEY *key);
20
21        EVP_PKEY *d2i_PUBKEY(EVP_PKEY **a, const unsigned char **pp, long length);
22        int i2d_PUBKEY(EVP_PKEY *a, unsigned char **pp);
23
24        EVP_PKEY *d2i_PUBKEY_bio(BIO *bp, EVP_PKEY **a);
25        EVP_PKEY *d2i_PUBKEY_fp(FILE *fp, EVP_PKEY **a);
26
27        int i2d_PUBKEY_fp(FILE *fp, EVP_PKEY *pkey);
28        int i2d_PUBKEY_bio(BIO *bp, EVP_PKEY *pkey);
29
30        int X509_PUBKEY_set0_param(X509_PUBKEY *pub, ASN1_OBJECT *aobj,
31                                   int ptype, void *pval,
32                                   unsigned char *penc, int penclen);
33        int X509_PUBKEY_get0_param(ASN1_OBJECT **ppkalg,
34                                   const unsigned char **pk, int *ppklen,
35                                   X509_ALGOR **pa, X509_PUBKEY *pub);
36

DESCRIPTION

38       The X509_PUBKEY structure represents the ASN.1 SubjectPublicKeyInfo
39       structure defined in RFC5280 and used in certificates and certificate
40       requests.
41
42       X509_PUBKEY_new() allocates and initializes an X509_PUBKEY structure.
43
44       X509_PUBKEY_free() frees up X509_PUBKEY structure a. If a is NULL
45       nothing is done.
46
47       X509_PUBKEY_set() sets the public key in *x to the public key contained
48       in the EVP_PKEY structure pkey. If *x is not NULL any existing public
49       key structure will be freed.
50
51       X509_PUBKEY_get0() returns the public key contained in key. The
52       returned value is an internal pointer which MUST NOT be freed after
53       use.
54
55       X509_PUBKEY_get() is similar to X509_PUBKEY_get0() except the reference
56       count on the returned key is incremented so it MUST be freed using
57       EVP_PKEY_free() after use.
58
59       d2i_PUBKEY() and i2d_PUBKEY() decode and encode an EVP_PKEY structure
60       using SubjectPublicKeyInfo format. They otherwise follow the
61       conventions of other ASN.1 functions such as d2i_X509().
62
63       d2i_PUBKEY_bio(), d2i_PUBKEY_fp(), i2d_PUBKEY_bio() and i2d_PUBKEY_fp()
64       are similar to d2i_PUBKEY() and i2d_PUBKEY() except they decode or
65       encode using a BIO or FILE pointer.
66
67       X509_PUBKEY_set0_param() sets the public key parameters of pub. The OID
68       associated with the algorithm is set to aobj. The type of the algorithm
69       parameters is set to type using the structure pval.  The encoding of
70       the public key itself is set to the penclen bytes contained in buffer
71       penc. On success ownership of all the supplied parameters is passed to
72       pub so they must not be freed after the call.
73
74       X509_PUBKEY_get0_param() retrieves the public key parameters from pub,
75       *ppkalg is set to the associated OID and the encoding consists of
76       *ppklen bytes at *pk, *pa is set to the associated AlgorithmIdentifier
77       for the public key. If the value of any of these parameters is not
78       required it can be set to NULL. All of the retrieved pointers are
79       internal and must not be freed after the call.
80

NOTES

82       The X509_PUBKEY functions can be used to encode and decode public keys
83       in a standard format.
84
85       In many cases applications will not call the X509_PUBKEY functions
86       directly: they will instead call wrapper functions such as
87       X509_get0_pubkey().
88

RETURN VALUES

90       If the allocation fails, X509_PUBKEY_new() returns NULL and sets an
91       error code that can be obtained by ERR_get_error(3).
92
93       Otherwise it returns a pointer to the newly allocated structure.
94
95       X509_PUBKEY_free() does not return a value.
96
97       X509_PUBKEY_get0() and X509_PUBKEY_get() return a pointer to an
98       EVP_PKEY structure or NULL if an error occurs.
99
100       X509_PUBKEY_set(), X509_PUBKEY_set0_param() and
101       X509_PUBKEY_get0_param() return 1 for success and 0 if an error
102       occurred.
103

SEE ALSO

105       d2i_X509(3), ERR_get_error(3), X509_get_pubkey(3),
106

108       Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
109
110       Licensed under the OpenSSL license (the "License").  You may not use
111       this file except in compliance with the License.  You can obtain a copy
112       in the file LICENSE in the source distribution or at
113       <https://www.openssl.org/source/license.html>.
114
115
116
1171.1.1k                            2021-03-26                X509_PUBKEY_NEW(3)
Impressum