Dr. Stephen Henson | dd332ce | 2015-09-21 13:03:42 +0100 | [diff] [blame^] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | X509_get0_signature, X509_get_signature_nid, X509_REQ_get0_signature, |
| 6 | X509_REQ_get_signature_nid, X509_CRL_get0_signature, |
| 7 | X509_CRL_get_signature_nid - signature information. |
| 8 | |
| 9 | =head1 SYNOPSIS |
| 10 | |
| 11 | #include <openssl/x509.h> |
| 12 | |
| 13 | void X509_get0_signature(ASN1_BIT_STRING **psig, X509_ALGOR **palg, |
| 14 | const X509 *x); |
| 15 | int X509_get_signature_nid(const X509 *x); |
| 16 | |
| 17 | void X509_REQ_get0_signature(ASN1_BIT_STRING **psig, X509_ALGOR **palg, |
| 18 | const X509_REQ *crl); |
| 19 | int X509_REQ_get_signature_nid(const X509_REQ *crl); |
| 20 | |
| 21 | void X509_CRL_get0_signature(ASN1_BIT_STRING **psig, X509_ALGOR **palg, |
| 22 | const X509_CRL *crl); |
| 23 | int X509_CRL_get_signature_nid(const X509_CRL *crl); |
| 24 | |
| 25 | =head1 DESCRIPTION |
| 26 | |
| 27 | X509_get0_signature() sets B<*psig> to the signature of B<x> and B<*palg> |
| 28 | to the signature algorithm of B<x>. The values returned are internal |
| 29 | pointers which B<MUST NOT> be freed up after the call. |
| 30 | |
| 31 | X509_get_signature_nid() returns the NID corresponding to the signature |
| 32 | algorithm of B<x>. |
| 33 | |
| 34 | X509_REQ_get0_signature(), X509_REQ_get_signature_nid() |
| 35 | X509_CRL_get0_signature() and X509_CRL_get_signature_nid() perform the |
| 36 | same function for certificate requests and CRLs. |
| 37 | |
| 38 | =head1 NOTES |
| 39 | |
| 40 | These functions provide lower level access to signatures in certificates |
| 41 | where an application wishes to analyse or generate a signature in a form |
| 42 | where X509_sign() et al is not appropriate (for example a non standard |
| 43 | or unsupported format). |
| 44 | |
| 45 | =head1 RETURN VALUES |
| 46 | |
| 47 | X509_get_signature_nid(), X509_REQ_get_signature_nid() and |
| 48 | X509_CRL_get_signature_nid() return a NID. |
| 49 | |
| 50 | X509_get0_signature(), X509_REQ_get0_signature() and |
| 51 | X509_CRL_get0_signature() do not return values. |
| 52 | |
| 53 | =head1 SEE ALSO |
| 54 | |
| 55 | L<d2i_X509(3)>, |
| 56 | L<ERR_get_error(3)>, |
| 57 | L<X509_CRL_get0_by_serial(3)>, |
| 58 | L<X509_get_ext_d2i(3)>, |
| 59 | L<X509_get_extension_flags(3)>, |
| 60 | L<X509_get_pubkey(3)>, |
| 61 | L<X509_get_subject_name(3)>, |
| 62 | L<X509_get_version(3)>, |
| 63 | L<X509_NAME_add_entry_by_txt(3)>, |
| 64 | L<X509_NAME_ENTRY_get_object(3)>, |
| 65 | L<X509_NAME_get_index_by_NID(3)>, |
| 66 | L<X509_NAME_print_ex(3)>, |
| 67 | L<X509_new(3)>, |
| 68 | L<X509_sign(3)>, |
| 69 | L<X509V3_get_d2i(3)>, |
| 70 | L<X509_verify_cert(3)> |
| 71 | |
| 72 | =head1 HISTORY |
| 73 | |
| 74 | X509_get0_signature() and X509_get_signature_nid() were first added to |
| 75 | OpenSSL 1.0.2. |
| 76 | |
| 77 | X509_REQ_get0_signature(), X509_REQ_get_signature_nid(), |
| 78 | X509_CRL_get0_signature() and X509_CRL_get_signature_nid() were first added |
| 79 | to OpenSSL 1.1.0. |
| 80 | |
| 81 | =cut |