xref: /openssl/doc/man3/X509_get_pubkey.pod (revision 1e4cef5f)
1=pod
2
3=head1 NAME
4
5X509_get_pubkey, X509_get0_pubkey, X509_set_pubkey, X509_get_X509_PUBKEY,
6X509_REQ_get_pubkey, X509_REQ_get0_pubkey, X509_REQ_set_pubkey,
7X509_REQ_get_X509_PUBKEY - get or set certificate or certificate request
8public key
9
10=head1 SYNOPSIS
11
12 #include <openssl/x509.h>
13
14 EVP_PKEY *X509_get_pubkey(X509 *x);
15 EVP_PKEY *X509_get0_pubkey(const X509 *x);
16 int X509_set_pubkey(X509 *x, EVP_PKEY *pkey);
17 X509_PUBKEY *X509_get_X509_PUBKEY(const X509 *x);
18
19 EVP_PKEY *X509_REQ_get_pubkey(X509_REQ *req);
20 EVP_PKEY *X509_REQ_get0_pubkey(X509_REQ *req);
21 int X509_REQ_set_pubkey(X509_REQ *x, EVP_PKEY *pkey);
22 X509_PUBKEY *X509_REQ_get_X509_PUBKEY(X509_REQ *x);
23
24=head1 DESCRIPTION
25
26X509_get_pubkey() attempts to decode the public key for certificate B<x>. If
27successful it returns the public key as an B<EVP_PKEY> pointer with its
28reference count incremented: this means the returned key must be freed up
29after use. X509_get0_pubkey() is similar except it does B<not> increment
30the reference count of the returned B<EVP_PKEY> so it must not be freed up
31after use.
32
33X509_get_X509_PUBKEY() returns an internal pointer to the B<X509_PUBKEY>
34structure which encodes the certificate of B<x>. The returned value
35must not be freed up after use.
36
37X509_set_pubkey() attempts to set the public key for certificate B<x> to
38B<pkey>. The key B<pkey> should be freed up after use.
39
40X509_REQ_get_pubkey(), X509_REQ_get0_pubkey(), X509_REQ_set_pubkey() and
41X509_REQ_get_X509_PUBKEY() are similar but operate on certificate request B<req>.
42
43=head1 NOTES
44
45The first time a public key is decoded the B<EVP_PKEY> structure is
46cached in the certificate or certificate request itself. Subsequent calls
47return the cached structure with its reference count incremented to
48improve performance.
49
50=head1 RETURN VALUES
51
52X509_get_pubkey(), X509_get0_pubkey(), X509_get_X509_PUBKEY(),
53X509_REQ_get_pubkey() and X509_REQ_get_X509_PUBKEY() return a public key or
54B<NULL> if an error occurred.
55
56X509_set_pubkey() and X509_REQ_set_pubkey() return 1 for success and 0
57for failure.
58
59=head1 SEE ALSO
60
61L<d2i_X509(3)>,
62L<ERR_get_error(3)>,
63L<X509_CRL_get0_by_serial(3)>,
64L<X509_get0_signature(3)>,
65L<X509_get_ext_d2i(3)>,
66L<X509_get_extension_flags(3)>,
67L<X509_get_subject_name(3)>,
68L<X509_get_version(3)>,
69L<X509_NAME_add_entry_by_txt(3)>,
70L<X509_NAME_ENTRY_get_object(3)>,
71L<X509_NAME_get_index_by_NID(3)>,
72L<X509_NAME_print_ex(3)>,
73L<X509_new(3)>,
74L<X509_sign(3)>,
75L<X509V3_get_d2i(3)>,
76L<X509_verify_cert(3)>
77
78=head1 COPYRIGHT
79
80Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
81
82Licensed under the Apache License 2.0 (the "License").  You may not use
83this file except in compliance with the License.  You can obtain a copy
84in the file LICENSE in the source distribution or at
85L<https://www.openssl.org/source/license.html>.
86
87=cut
88