e2ff81235dbc239b2c10f70765ca5456fed84294
[openssl.git] / doc / man3 / X509_PUBKEY_new.pod
1 =pod
2
3 =head1 NAME
4
5 X509_PUBKEY_new, X509_PUBKEY_free, X509_PUBKEY_dup,
6 X509_PUBKEY_set, X509_PUBKEY_get0, X509_PUBKEY_get,
7 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
11 =head1 SYNOPSIS
12
13  #include <openssl/x509.h>
14
15  X509_PUBKEY *X509_PUBKEY_new(void);
16  void X509_PUBKEY_free(X509_PUBKEY *a);
17  X509_PUBKEY *X509_PUBKEY_dup(const X509_PUBKEY *a);
18
19  int X509_PUBKEY_set(X509_PUBKEY **x, EVP_PKEY *pkey);
20  EVP_PKEY *X509_PUBKEY_get0(const X509_PUBKEY *key);
21  EVP_PKEY *X509_PUBKEY_get(const X509_PUBKEY *key);
22
23  EVP_PKEY *d2i_PUBKEY(EVP_PKEY **a, const unsigned char **pp, long length);
24  int i2d_PUBKEY(const EVP_PKEY *a, unsigned char **pp);
25
26  EVP_PKEY *d2i_PUBKEY_bio(BIO *bp, EVP_PKEY **a);
27  EVP_PKEY *d2i_PUBKEY_fp(FILE *fp, EVP_PKEY **a);
28
29  int i2d_PUBKEY_fp(const FILE *fp, EVP_PKEY *pkey);
30  int i2d_PUBKEY_bio(BIO *bp, const EVP_PKEY *pkey);
31
32  int X509_PUBKEY_set0_param(X509_PUBKEY *pub, ASN1_OBJECT *aobj,
33                             int ptype, void *pval,
34                             unsigned char *penc, int penclen);
35  int X509_PUBKEY_get0_param(ASN1_OBJECT **ppkalg,
36                             const unsigned char **pk, int *ppklen,
37                             X509_ALGOR **pa, const X509_PUBKEY *pub);
38
39 =head1 DESCRIPTION
40
41 The B<X509_PUBKEY> structure represents the ASN.1 B<SubjectPublicKeyInfo>
42 structure defined in RFC5280 and used in certificates and certificate requests.
43
44 X509_PUBKEY_new() allocates and initializes an B<X509_PUBKEY> structure.
45
46 X509_PUBKEY_free() frees up B<X509_PUBKEY> structure B<a>. If B<a> is NULL
47 nothing is done.
48
49 X509_PUBKEY_set() sets the public key in B<*x> to the public key contained
50 in the B<EVP_PKEY> structure B<pkey>. If B<*x> is not NULL any existing
51 public key structure will be freed.
52
53 X509_PUBKEY_get0() returns the public key contained in B<key>. The returned
54 value is an internal pointer which B<MUST NOT> be freed after use.
55
56 X509_PUBKEY_get() is similar to X509_PUBKEY_get0() except the reference
57 count on the returned key is incremented so it B<MUST> be freed using
58 EVP_PKEY_free() after use.
59
60 d2i_PUBKEY() and i2d_PUBKEY() decode and encode an B<EVP_PKEY> structure
61 using B<SubjectPublicKeyInfo> format. They otherwise follow the conventions of
62 other ASN.1 functions such as d2i_X509().
63
64 d2i_PUBKEY_bio(), d2i_PUBKEY_fp(), i2d_PUBKEY_bio() and i2d_PUBKEY_fp() are
65 similar to d2i_PUBKEY() and i2d_PUBKEY() except they decode or encode using a
66 B<BIO> or B<FILE> pointer.
67
68 X509_PUBKEY_set0_param() sets the public key parameters of B<pub>. The
69 OID associated with the algorithm is set to B<aobj>. The type of the
70 algorithm parameters is set to B<type> using the structure B<pval>.
71 The encoding of the public key itself is set to the B<penclen>
72 bytes contained in buffer B<penc>. On success ownership of all the supplied
73 parameters is passed to B<pub> so they must not be freed after the
74 call.
75
76 X509_PUBKEY_get0_param() retrieves the public key parameters from B<pub>,
77 B<*ppkalg> is set to the associated OID and the encoding consists of
78 B<*ppklen> bytes at B<*pk>, B<*pa> is set to the associated
79 AlgorithmIdentifier for the public key. If the value of any of these
80 parameters is not required it can be set to B<NULL>. All of the
81 retrieved pointers are internal and must not be freed after the
82 call.
83
84 =head1 NOTES
85
86 The B<X509_PUBKEY> functions can be used to encode and decode public keys
87 in a standard format.
88
89 In many cases applications will not call the B<X509_PUBKEY> functions
90 directly: they will instead call wrapper functions such as X509_get0_pubkey().
91
92 =head1 RETURN VALUES
93
94 If the allocation fails, X509_PUBKEY_new() returns B<NULL> and sets an error
95 code that can be obtained by L<ERR_get_error(3)>.
96
97 Otherwise it returns a pointer to the newly allocated structure.
98
99 X509_PUBKEY_free() does not return a value.
100
101 X509_PUBKEY_get0() and X509_PUBKEY_get() return a pointer to an B<EVP_PKEY>
102 structure or B<NULL> if an error occurs.
103
104 X509_PUBKEY_set(), X509_PUBKEY_set0_param() and X509_PUBKEY_get0_param()
105 return 1 for success and 0 if an error occurred.
106
107 =head1 SEE ALSO
108
109 L<d2i_X509(3)>,
110 L<ERR_get_error(3)>,
111 L<X509_get_pubkey(3)>,
112
113 =head1 COPYRIGHT
114
115 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
116
117 Licensed under the Apache License 2.0 (the "License").  You may not use
118 this file except in compliance with the License.  You can obtain a copy
119 in the file LICENSE in the source distribution or at
120 L<https://www.openssl.org/source/license.html>.
121
122 =cut