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