a1ed4d32fe65965f1e760f3c7a00af3457a78d36
[openssl.git] / doc / man3 / X509_verify.pod
1 =pod
2
3 =head1 NAME
4
5 X509_verify_ex, X509_verify,
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
18  int X509_REQ_verify_ex(X509_REQ *a, EVP_PKEY *pkey,
19                         OPENSSL_CTX *libctx, const char *propq);
20  int X509_REQ_verify(X509_REQ *a, EVP_PKEY *r);
21  int X509_CRL_verify(X509_CRL *a, EVP_PKEY *r);
22
23 =head1 DESCRIPTION
24
25 X509_verify_ex() verifies the signature of certificate I<x> using public key
26 I<pkey>. Any cryptographic algorithms required for the verification are fetched
27 using the library context I<libctx> and the property query string I<propq>.
28 Only the signature is checked:
29 no other checks (such as certificate chain validity) are performed.
30
31 X509_verify() is the same as X509_verify_ex() except that the default library
32 context and property query string are used.
33
34 X509_REQ_verify_ex(), X509_REQ_verify() and X509_CRL_verify()
35 verify the signatures of certificate requests and CRLs, respectively.
36
37 =head1 RETURN VALUES
38
39 X509_verify_ex(), X509_verify(),
40 X509_REQ_verify_ex(), X509_REQ_verify() and X509_CRL_verify()
41 return 1 if the signature is valid and 0 if the signature check fails.
42 If the signature could not be checked at all because it was ill-formed
43 or some other error occurred then -1 is returned.
44
45 =head1 SEE ALSO
46
47 L<d2i_X509(3)>,
48 L<ERR_get_error(3)>,
49 L<X509_CRL_get0_by_serial(3)>,
50 L<X509_get0_signature(3)>,
51 L<X509_get_ext_d2i(3)>,
52 L<X509_get_extension_flags(3)>,
53 L<X509_get_pubkey(3)>,
54 L<X509_get_subject_name(3)>,
55 L<X509_get_version(3)>,
56 L<X509_NAME_ENTRY_get_object(3)>,
57 L<X509_NAME_get_index_by_NID(3)>,
58 L<X509_NAME_print_ex(3)>,
59 L<X509V3_get_d2i(3)>,
60 L<X509_verify_cert(3)>,
61 L<OPENSSL_CTX(3)>
62
63 =head1 HISTORY
64
65 The X509_verify(), X509_REQ_verify(), and X509_CRL_verify()
66 functions are available in all versions of OpenSSL.
67
68 X509_verify_ex() and X509_REQ_verify_ex()
69 were added in OpenSSL 3.0.
70
71 =head1 COPYRIGHT
72
73 Copyright 2015-2020 The OpenSSL Project Authors. All Rights Reserved.
74
75 Licensed under the Apache License 2.0 (the "License").  You may not use
76 this file except in compliance with the License.  You can obtain a copy
77 in the file LICENSE in the source distribution or at
78 L<https://www.openssl.org/source/license.html>.
79
80 =cut