doc/man3/X509_verify.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 X509_verify_ex, X509_verify, X509_self_signed,
   6 X509_REQ_verify_ex, X509_REQ_verify,
   7 X509_CRL_verify -
   8 verify certificate, certificate request, or CRL signature
   9
  10 =head1 SYNOPSIS
  11
  12  #include <openssl/x509.h>
  13
  14  int X509_verify_ex(X509 *x, EVP_PKEY *pkey,
  15                     OPENSSL_CTX *libctx, const char *propq);
  16  int X509_verify(X509 *x, EVP_PKEY *pkey);
  17  int X509_self_signed(X509 *cert, int verify_signature);
  18
  19  int X509_REQ_verify_ex(X509_REQ *a, EVP_PKEY *pkey,
  20                         OPENSSL_CTX *libctx, const char *propq);
  21  int X509_REQ_verify(X509_REQ *a, EVP_PKEY *r);
  22  int X509_CRL_verify(X509_CRL *a, EVP_PKEY *r);
  23
  24 =head1 DESCRIPTION
  25
  26 X509_verify_ex() verifies the signature of certificate I<x> using public key
  27 I<pkey>. Any cryptographic algorithms required for the verification are fetched
  28 using the library context I<libctx> and the property query string I<propq>.
  29 Only the signature is checked:
  30 no other checks (such as certificate chain validity) are performed.
  31
  32 X509_verify() is the same as X509_verify_ex() except that the default library
  33 context and property query string are used.
  34
  35 X509_self_signed() checks whether a certificate is self-signed.
  36 For success the issuer and subject names must match, the components of the
  37 authority key identifier (if present) must match the subject key identifier etc.
  38 The signature itself is actually verified only if B<verify_signature> is 1, as
  39 for explicitly trusted certificates this verification is not worth the effort.
  40
  41 X509_REQ_verify_ex(), X509_REQ_verify() and X509_CRL_verify()
  42 verify the signatures of certificate requests and CRLs, respectively.
  43
  44 =head1 RETURN VALUES
  45
  46 X509_verify_ex(), X509_verify(),
  47 X509_REQ_verify_ex(), X509_REQ_verify() and X509_CRL_verify()
  48 return 1 if the signature is valid and 0 if the signature check fails.
  49 If the signature could not be checked at all because it was ill-formed
  50 or some other error occurred then -1 is returned.
  51
  52 X509_self_signed() returns the same values but also returns 1
  53 if all respective fields match and B<verify_signature> is 0.
  54
  55 =head1 SEE ALSO
  56
  57 L<d2i_X509(3)>,
  58 L<ERR_get_error(3)>,
  59 L<X509_CRL_get0_by_serial(3)>,
  60 L<X509_get0_signature(3)>,
  61 L<X509_get_ext_d2i(3)>,
  62 L<X509_get_extension_flags(3)>,
  63 L<X509_get_pubkey(3)>,
  64 L<X509_get_subject_name(3)>,
  65 L<X509_get_version(3)>,
  66 L<X509_NAME_ENTRY_get_object(3)>,
  67 L<X509_NAME_get_index_by_NID(3)>,
  68 L<X509_NAME_print_ex(3)>,
  69 L<X509V3_get_d2i(3)>,
  70 L<X509_verify_cert(3)>,
  71 L<OPENSSL_CTX(3)>
  72
  73 =head1 HISTORY
  74
  75 The X509_verify(), X509_REQ_verify(), and X509_CRL_verify()
  76 functions are available in all versions of OpenSSL.
  77
  78 X509_verify_ex(), X509_REQ_verify_ex(), and X509_self_signed()
  79 were added in OpenSSL 3.0.
  80
  81 =head1 COPYRIGHT
  82
  83 Copyright 2015-2020 The OpenSSL Project Authors. All Rights Reserved.
  84
  85 Licensed under the Apache License 2.0 (the "License").  You may not use
  86 this file except in compliance with the License.  You can obtain a copy
  87 in the file LICENSE in the source distribution or at
  88 L<https://www.openssl.org/source/license.html>.
  89
  90 =cut