Blame doc/man3/X509_get_pubkey.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
X509_get_pubkey, X509_get0_pubkey, X509_set_pubkey, X509_get_X509_PUBKEY,
Packit c4476c
X509_REQ_get_pubkey, X509_REQ_get0_pubkey, X509_REQ_set_pubkey,
Packit c4476c
X509_REQ_get_X509_PUBKEY - get or set certificate or certificate request
Packit c4476c
public key
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/x509.h>
Packit c4476c
Packit c4476c
 EVP_PKEY *X509_get_pubkey(X509 *x);
Packit c4476c
 EVP_PKEY *X509_get0_pubkey(const X509 *x);
Packit c4476c
 int X509_set_pubkey(X509 *x, EVP_PKEY *pkey);
Packit c4476c
 X509_PUBKEY *X509_get_X509_PUBKEY(X509 *x);
Packit c4476c
Packit c4476c
 EVP_PKEY *X509_REQ_get_pubkey(X509_REQ *req);
Packit c4476c
 EVP_PKEY *X509_REQ_get0_pubkey(X509_REQ *req);
Packit c4476c
 int X509_REQ_set_pubkey(X509_REQ *x, EVP_PKEY *pkey);
Packit c4476c
 X509_PUBKEY *X509_REQ_get_X509_PUBKEY(X509_REQ *x);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
X509_get_pubkey() attempts to decode the public key for certificate B<x>. If
Packit c4476c
successful it returns the public key as an B<EVP_PKEY> pointer with its
Packit c4476c
reference count incremented: this means the returned key must be freed up
Packit c4476c
after use. X509_get0_pubkey() is similar except it does B<not> increment
Packit c4476c
the reference count of the returned B<EVP_PKEY> so it must not be freed up
Packit c4476c
after use.
Packit c4476c
Packit c4476c
X509_get_X509_PUBKEY() returns an internal pointer to the B<X509_PUBKEY>
Packit c4476c
structure which encodes the certificate of B<x>. The returned value
Packit c4476c
must not be freed up after use.
Packit c4476c
Packit c4476c
X509_set_pubkey() attempts to set the public key for certificate B<x> to
Packit c4476c
B<pkey>. The key B<pkey> should be freed up after use.
Packit c4476c
Packit c4476c
X509_REQ_get_pubkey(), X509_REQ_get0_pubkey(), X509_REQ_set_pubkey() and
Packit c4476c
X509_REQ_get_X509_PUBKEY() are similar but operate on certificate request B<req>.
Packit c4476c
Packit c4476c
=head1 NOTES
Packit c4476c
Packit c4476c
The first time a public key is decoded the B<EVP_PKEY> structure is
Packit c4476c
cached in the certificate or certificate request itself. Subsequent calls
Packit c4476c
return the cached structure with its reference count incremented to
Packit c4476c
improve performance.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
X509_get_pubkey(), X509_get0_pubkey(), X509_get_X509_PUBKEY(),
Packit c4476c
X509_REQ_get_pubkey() and X509_REQ_get_X509_PUBKEY() return a public key or
Packit c4476c
B<NULL> if an error occurred.
Packit c4476c
Packit c4476c
X509_set_pubkey() and X509_REQ_set_pubkey() return 1 for success and 0
Packit c4476c
for failure.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<d2i_X509(3)>,
Packit c4476c
L<ERR_get_error(3)>,
Packit c4476c
L<X509_CRL_get0_by_serial(3)>,
Packit c4476c
L<X509_get0_signature(3)>,
Packit c4476c
L<X509_get_ext_d2i(3)>,
Packit c4476c
L<X509_get_extension_flags(3)>,
Packit c4476c
L<X509_get_subject_name(3)>,
Packit c4476c
L<X509_get_version(3)>,
Packit c4476c
L<X509_NAME_add_entry_by_txt(3)>,
Packit c4476c
L<X509_NAME_ENTRY_get_object(3)>,
Packit c4476c
L<X509_NAME_get_index_by_NID(3)>,
Packit c4476c
L<X509_NAME_print_ex(3)>,
Packit c4476c
L<X509_new(3)>,
Packit c4476c
L<X509_sign(3)>,
Packit c4476c
L<X509V3_get_d2i(3)>,
Packit c4476c
L<X509_verify_cert(3)>
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut