doc/crypto/X509_get0_signature.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 X509_get0_signature, X509_get_signature_nid, X509_get0_tbs_sigalg,
   6 X509_REQ_get0_signature, 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  X509_ALGOR *X509_get0_tbs_sigalg(X509 *x);
  17
  18  void X509_REQ_get0_signature(ASN1_BIT_STRING **psig, X509_ALGOR **palg,
  19                               const X509_REQ *crl);
  20  int X509_REQ_get_signature_nid(const X509_REQ *crl);
  21
  22  void X509_CRL_get0_signature(const X509_CRL *crl,
  23                               const ASN1_BIT_STRING **psig,
  24                               const X509_ALGOR **palg);
  25  int X509_CRL_get_signature_nid(const X509_CRL *crl);
  26
  27 =head1 DESCRIPTION
  28
  29 X509_get0_signature() sets B<*psig> to the signature of B<x> and B<*palg>
  30 to the signature algorithm of B<x>. The values returned are internal
  31 pointers which B<MUST NOT> be freed up after the call.
  32
  33 X509_get0_tbs_sigalg() returns the signature algorithm in the signed
  34 portion of B<x>.
  35
  36 X509_get_signature_nid() returns the NID corresponding to the signature
  37 algorithm of B<x>.
  38
  39 X509_REQ_get0_signature(), X509_REQ_get_signature_nid()
  40 X509_CRL_get0_signature() and X509_CRL_get_signature_nid() perform the
  41 same function for certificate requests and CRLs.
  42
  43 =head1 NOTES
  44
  45 These functions provide lower level access to signatures in certificates
  46 where an application wishes to analyse or generate a signature in a form
  47 where X509_sign() et al is not appropriate (for example a non standard
  48 or unsupported format).
  49
  50 =head1 RETURN VALUES
  51
  52 X509_get_signature_nid(), X509_REQ_get_signature_nid() and
  53 X509_CRL_get_signature_nid() return a NID.
  54
  55 X509_get0_signature(), X509_REQ_get0_signature() and
  56 X509_CRL_get0_signature() do not return values.
  57
  58 =head1 SEE ALSO
  59
  60 L<d2i_X509(3)>,
  61 L<ERR_get_error(3)>,
  62 L<X509_CRL_get0_by_serial(3)>,
  63 L<X509_get_ext_d2i(3)>,
  64 L<X509_get_extension_flags(3)>,
  65 L<X509_get_pubkey(3)>,
  66 L<X509_get_subject_name(3)>,
  67 L<X509_get_version(3)>,
  68 L<X509_NAME_add_entry_by_txt(3)>,
  69 L<X509_NAME_ENTRY_get_object(3)>,
  70 L<X509_NAME_get_index_by_NID(3)>,
  71 L<X509_NAME_print_ex(3)>,
  72 L<X509_new(3)>,
  73 L<X509_sign(3)>,
  74 L<X509V3_get_d2i(3)>,
  75 L<X509_verify_cert(3)>
  76
  77 =head1 HISTORY
  78
  79 X509_get0_signature() and X509_get_signature_nid() were first added to
  80 OpenSSL 1.0.2.
  81
  82 X509_REQ_get0_signature(), X509_REQ_get_signature_nid(),
  83 X509_CRL_get0_signature() and X509_CRL_get_signature_nid() were first added
  84 to OpenSSL 1.1.0.
  85
  86 =head1 COPYRIGHT
  87
  88 Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
  89
  90 Licensed under the OpenSSL license (the "License").  You may not use
  91 this file except in compliance with the License.  You can obtain a copy
  92 in the file LICENSE in the source distribution or at
  93 L<https://www.openssl.org/source/license.html>.
  94
  95 =cut