1X509_PUBKEY_NEW(3ossl) OpenSSL X509_PUBKEY_NEW(3ossl)
2
6 X509_PUBKEY_new_ex, X509_PUBKEY_new, X509_PUBKEY_free, X509_PUBKEY_dup,
7 X509_PUBKEY_set, X509_PUBKEY_get0, X509_PUBKEY_get, d2i_PUBKEY_ex,
8 d2i_PUBKEY, i2d_PUBKEY, d2i_PUBKEY_bio, d2i_PUBKEY_fp, i2d_PUBKEY_fp,
9 i2d_PUBKEY_bio, X509_PUBKEY_set0_param, X509_PUBKEY_get0_param,
10 X509_PUBKEY_eq - SubjectPublicKeyInfo public key functions
11
13 #include <openssl/x509.h>
14 X509_PUBKEY *X509_PUBKEY_new_ex(OSSL_LIB_CTX *libctx, const char *propq);
16 X509_PUBKEY *X509_PUBKEY_new(void);
17 void X509_PUBKEY_free(X509_PUBKEY *a);
18 X509_PUBKEY *X509_PUBKEY_dup(const X509_PUBKEY *a);
19 int X509_PUBKEY_set(X509_PUBKEY **x, EVP_PKEY *pkey);
21 EVP_PKEY *X509_PUBKEY_get0(const X509_PUBKEY *key);
22 EVP_PKEY *X509_PUBKEY_get(const X509_PUBKEY *key);
23 EVP_PKEY *d2i_PUBKEY_ex(EVP_PKEY **a, const unsigned char **pp, long length,
25 OSSL_LIB_CTX *libctx, const char *propq);
26 EVP_PKEY *d2i_PUBKEY(EVP_PKEY **a, const unsigned char **pp, long length);
27 int i2d_PUBKEY(const EVP_PKEY *a, unsigned char **pp);
28 EVP_PKEY *d2i_PUBKEY_bio(BIO *bp, EVP_PKEY **a);
30 EVP_PKEY *d2i_PUBKEY_fp(FILE *fp, EVP_PKEY **a);
31 int i2d_PUBKEY_fp(const FILE *fp, EVP_PKEY *pkey);
33 int i2d_PUBKEY_bio(BIO *bp, const EVP_PKEY *pkey);
34 int X509_PUBKEY_set0_param(X509_PUBKEY *pub, ASN1_OBJECT *aobj,
36 int ptype, void *pval,
37 unsigned char *penc, int penclen);
38 int X509_PUBKEY_get0_param(ASN1_OBJECT **ppkalg,
39 const unsigned char **pk, int *ppklen,
40 X509_ALGOR **pa, const X509_PUBKEY *pub);
41 int X509_PUBKEY_eq(X509_PUBKEY *a, X509_PUBKEY *b);
42
44 The X509_PUBKEY structure represents the ASN.1 SubjectPublicKeyInfo
45 structure defined in RFC5280 and used in certificates and certificate
46 requests.
47 X509_PUBKEY_new_ex() allocates and initializes an X509_PUBKEY structure
49 associated with the given OSSL_LIB_CTX in the libctx parameter. Any
50 algorithm fetches associated with using the X509_PUBKEY object will use
51 the property query string propq. See "ALGORITHM FETCHING" in crypto(7)
52 for further information about algorithm fetching.
53 X509_PUBKEY_new() is the same as X509_PUBKEY_new_ex() except that the
55 default (NULL) OSSL_LIB_CTX and a NULL property query string are used.
56 X509_PUBKEY_dup() creates a duplicate copy of the X509_PUBKEY object
58 specified by a.
59 X509_PUBKEY_free() frees up X509_PUBKEY structure a. If a is NULL
61 nothing is done.
62 X509_PUBKEY_set() sets the public key in *x to the public key contained
64 in the EVP_PKEY structure pkey. If *x is not NULL any existing public
65 key structure will be freed.
66 X509_PUBKEY_get0() returns the public key contained in key. The
68 returned value is an internal pointer which MUST NOT be freed after
69 use.
70 X509_PUBKEY_get() is similar to X509_PUBKEY_get0() except the reference
72 count on the returned key is incremented so it MUST be freed using
73 EVP_PKEY_free() after use.
74 d2i_PUBKEY_ex() decodes an EVP_PKEY structure using
76 SubjectPublicKeyInfo format. Some public key decoding implementations
77 may use cryptographic algorithms. In this case the supplied library
78 context libctx and property query string propq are used. d2i_PUBKEY()
79 does the same as d2i_PUBKEY_ex() except that the default library
80 context and property query string are used.
81 i2d_PUBKEY() encodes an EVP_PKEY structure using SubjectPublicKeyInfo
83 format.
84 d2i_PUBKEY_bio(), d2i_PUBKEY_fp(), i2d_PUBKEY_bio() and i2d_PUBKEY_fp()
86 are similar to d2i_PUBKEY() and i2d_PUBKEY() except they decode or
87 encode using a BIO or FILE pointer.
88 X509_PUBKEY_set0_param() sets the public key parameters of pub. The OID
90 associated with the algorithm is set to aobj. The type of the algorithm
91 parameters is set to type using the structure pval. The encoding of
92 the public key itself is set to the penclen bytes contained in buffer
93 penc. On success ownership of all the supplied parameters is passed to
94 pub so they must not be freed after the call.
95 X509_PUBKEY_get0_param() retrieves the public key parameters from pub,
97 *ppkalg is set to the associated OID and the encoding consists of
98 *ppklen bytes at *pk, *pa is set to the associated AlgorithmIdentifier
99 for the public key. If the value of any of these parameters is not
100 required it can be set to NULL. All of the retrieved pointers are
101 internal and must not be freed after the call.
102 X509_PUBKEY_eq() compares two X509_PUBKEY values.
104
106 The X509_PUBKEY functions can be used to encode and decode public keys
107 in a standard format.
108 In many cases applications will not call the X509_PUBKEY functions
110 directly: they will instead call wrapper functions such as
111 X509_get0_pubkey().
112
114 If the allocation fails, X509_PUBKEY_new() and X509_PUBKEY_dup() return
115 NULL and set an error code that can be obtained by ERR_get_error(3).
116 Otherwise they return a pointer to the newly allocated structure.
117 X509_PUBKEY_free() does not return a value.
119 X509_PUBKEY_get0() and X509_PUBKEY_get() return a pointer to an
121 EVP_PKEY structure or NULL if an error occurs.
122 X509_PUBKEY_set(), X509_PUBKEY_set0_param() and
124 X509_PUBKEY_get0_param() return 1 for success and 0 if an error
125 occurred.
126 X509_PUBKEY_eq() returns 1 for equal, 0 for different, and < 0 on
128 error.
129
131 d2i_X509(3), ERR_get_error(3), X509_get_pubkey(3),
132
134 The X509_PUBKEY_new_ex() and X509_PUBKEY_eq() functions were added in
135 OpenSSL 3.0.
136
138 Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.
139 Licensed under the Apache License 2.0 (the "License"). You may not use
141 this file except in compliance with the License. You can obtain a copy
142 in the file LICENSE in the source distribution or at
143 <https://www.openssl.org/source/license.html>.
1443.1.1 2023-08-31 X509_PUBKEY_NEW(3ossl)