projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| e7fabc5e DSH |
1 | =pod |
| 2 | ||
| 3 | =head1 NAME | |
| 4 | ||
| 5 | X509_get_pubkey, X509_set_pubkey, X509_get_X509_PUBKEY, | |
| 6 | X509_REQ_get_pubkey, X509_REQ_set_pubkey, X509_REQ_get_X509_PUBKEY - get or | |
| 7 | set certificate or certificate request public key. | |
| 8 | ||
| 9 | =head1 SYNOPSIS | |
| 10 | ||
| 11 | #include <openssl/x509.h> | |
| 12 | ||
| 13 | EVP_PKEY *X509_get_pubkey(X509 *x); | |
| 14 | int X509_set_pubkey(X509 *x, EVP_PKEY *pkey); | |
| 15 | X509_PUBKEY *X509_get_X509_PUBKEY(X509 *x); | |
| 16 | ||
| 17 | EVP_PKEY *X509_REQ_get_pubkey(X509_REQ *req); | |
| 18 | int X509_REQ_set_pubkey(X509_REQ *x, EVP_PKEY *pkey); | |
| 19 | X509_PUBKEY *X509_REQ_get_X509_PUBKEY(X509_REQ *x); | |
| 20 | ||
| 21 | =head1 DESCRIPTION | |
| 22 | ||
| 23 | X509_get_pubkey() attempts to decode the public key for certificate B<x>. If | |
| 24 | successful it returns the public key as an B<EVP_PKEY> pointer with its | |
| 25 | reference count incremented: this means the returned key must be freed up | |
| 26 | after use. | |
| 27 | ||
| 28 | X509_get_X509_PUBKEY() returns an internal pointer to the B<X509_PUBKEY> | |
| 29 | structure which encodes the certificate of B<x>. The returned value | |
| 30 | must not be freed up after use. | |
| 31 | ||
| 32 | X509_set_pubkey() attempts to set the public key for certificate B<x> to | |
| 33 | B<pkey>. The key B<pkey> should be freed up after use. | |
| 34 | ||
| 35 | X509_REQ_get_pubkey(), X509_REQ_set_pubkey() and X509_REQ_get_X509_PUBKEY() | |
| 36 | are similar but operate on certificate request B<req>. | |
| 37 | ||
| 38 | =head1 NOTES | |
| 39 | ||
| 40 | The first time a public key is decoded the B<EVP_PKEY> structure is | |
| 41 | cached in the certificate or certificate request itself. Subsequent calls | |
| 42 | return the cached structure with its reference count incremented to | |
| 43 | improve performance. | |
| 44 | ||
| 45 | =head1 RETURN VALUES | |
| 46 | ||
| 47 | X509_get_pubkey(), X509_get_X509_PUBKEY(), X509_REQ_get_pubkey() and | |
| 48 | X509_REQ_get_X509_PUBKEY() return a public key or B<NULL> if an error | |
| 49 | occurred. | |
| 50 | ||
| 51 | X509_set_pubkey() and X509_REQ_set_pubkey() rerturn 1 for success and 0 | |
| 52 | for failure. | |
| 53 | ||
| 54 | =head1 SEE ALSO | |
| 55 | ||
| 56 | L<d2i_X509(3)>, | |
| 57 | L<ERR_get_error(3)>, | |
| 58 | L<X509_CRL_get0_by_serial(3)>, | |
| 59 | L<X509_get0_signature(3)>, | |
| 60 | L<X509_get_ext_d2i(3)>, | |
| 61 | L<X509_get_extension_flags(3)>, | |
| 62 | L<X509_get_subject_name(3)>, | |
| 63 | L<X509_get_version(3)>, | |
| 64 | L<X509_NAME_add_entry_by_txt(3)>, | |
| 65 | L<X509_NAME_ENTRY_get_object(3)>, | |
| 66 | L<X509_NAME_get_index_by_NID(3)>, | |
| 67 | L<X509_NAME_print_ex(3)>, | |
| 68 | L<X509_new(3)>, | |
| 69 | L<X509_sign(3)>, | |
| 70 | L<X509V3_get_d2i(3)>, | |
| 71 | L<X509_verify_cert(3)> | |
| 72 | ||
| 73 | =head1 HISTORY | |
| 74 | ||
| 75 | =cut |