xref: /freebsd/crypto/openssl/doc/man3/X509_CRL_get0_by_serial.pod (revision 1d386b48a555f61cb7325543adbbb5c3f3407a66)
1=pod
2
3=head1 NAME
4
5X509_CRL_get0_by_serial, X509_CRL_get0_by_cert, X509_CRL_get_REVOKED,
6X509_REVOKED_get0_serialNumber, X509_REVOKED_get0_revocationDate,
7X509_REVOKED_set_serialNumber, X509_REVOKED_set_revocationDate,
8X509_CRL_add0_revoked, X509_CRL_sort - CRL revoked entry utility
9functions
10
11=head1 SYNOPSIS
12
13 #include <openssl/x509.h>
14
15 int X509_CRL_get0_by_serial(X509_CRL *crl,
16                             X509_REVOKED **ret, const ASN1_INTEGER *serial);
17 int X509_CRL_get0_by_cert(X509_CRL *crl, X509_REVOKED **ret, X509 *x);
18
19 STACK_OF(X509_REVOKED) *X509_CRL_get_REVOKED(X509_CRL *crl);
20
21 const ASN1_INTEGER *X509_REVOKED_get0_serialNumber(const X509_REVOKED *r);
22 const ASN1_TIME *X509_REVOKED_get0_revocationDate(const X509_REVOKED *r);
23
24 int X509_REVOKED_set_serialNumber(X509_REVOKED *r, ASN1_INTEGER *serial);
25 int X509_REVOKED_set_revocationDate(X509_REVOKED *r, ASN1_TIME *tm);
26
27 int X509_CRL_add0_revoked(X509_CRL *crl, X509_REVOKED *rev);
28
29 int X509_CRL_sort(X509_CRL *crl);
30
31=head1 DESCRIPTION
32
33X509_CRL_get0_by_serial() attempts to find a revoked entry in I<crl> for
34serial number I<serial>. If it is successful, it sets I<*ret> to the internal
35pointer of the matching entry. As a result, I<*ret> B<MUST NOT> be freed
36after the call.
37
38X509_CRL_get0_by_cert() is similar to X509_get0_by_serial() except it
39looks for a revoked entry using the serial number of certificate I<x>.
40
41X509_CRL_get_REVOKED() returns an internal pointer to a STACK of all
42revoked entries for I<crl>.
43
44X509_REVOKED_get0_serialNumber() returns an internal pointer to the
45serial number of I<r>.
46
47X509_REVOKED_get0_revocationDate() returns an internal pointer to the
48revocation date of I<r>.
49
50X509_REVOKED_set_serialNumber() sets the serial number of I<r> to I<serial>.
51The supplied I<serial> pointer is not used internally so it should be
52freed after use.
53
54X509_REVOKED_set_revocationDate() sets the revocation date of I<r> to
55I<tm>. The supplied I<tm> pointer is not used internally so it should be
56freed after use.
57
58X509_CRL_add0_revoked() appends revoked entry I<rev> to CRL I<crl>. The
59pointer I<rev> is used internally so it B<MUST NOT> be freed after the call:
60it is freed when the parent CRL is freed.
61
62X509_CRL_sort() sorts the revoked entries of I<crl> into ascending serial
63number order.
64
65=head1 NOTES
66
67Applications can determine the number of revoked entries returned by
68X509_CRL_get_REVOKED() using sk_X509_REVOKED_num() and examine each one
69in turn using sk_X509_REVOKED_value().
70
71=head1 RETURN VALUES
72
73X509_CRL_get0_by_serial() and X509_CRL_get0_by_cert() return 0 for failure,
741 on success except if the revoked entry has the reason C<removeFromCRL> (8),
75in which case 2 is returned.
76
77X509_CRL_get_REVOKED() returns a STACK of revoked entries.
78
79X509_REVOKED_get0_serialNumber() returns an B<ASN1_INTEGER> structure.
80
81X509_REVOKED_get0_revocationDate() returns an B<ASN1_TIME> structure.
82
83X509_REVOKED_set_serialNumber(), X509_REVOKED_set_revocationDate(),
84X509_CRL_add0_revoked() and X509_CRL_sort() return 1 for success and 0 for
85failure.
86
87=head1 SEE ALSO
88
89L<d2i_X509(3)>,
90L<ERR_get_error(3)>,
91L<X509_get0_signature(3)>,
92L<X509_get_ext_d2i(3)>,
93L<X509_get_extension_flags(3)>,
94L<X509_get_pubkey(3)>,
95L<X509_get_subject_name(3)>,
96L<X509_get_version(3)>,
97L<X509_NAME_add_entry_by_txt(3)>,
98L<X509_NAME_ENTRY_get_object(3)>,
99L<X509_NAME_get_index_by_NID(3)>,
100L<X509_NAME_print_ex(3)>,
101L<X509_new(3)>,
102L<X509_sign(3)>,
103L<X509V3_get_d2i(3)>,
104L<X509_verify_cert(3)>
105
106=head1 COPYRIGHT
107
108Copyright 2015-2022 The OpenSSL Project Authors. All Rights Reserved.
109
110Licensed under the Apache License 2.0 (the "License").  You may not use
111this file except in compliance with the License.  You can obtain a copy
112in the file LICENSE in the source distribution or at
113L<https://www.openssl.org/source/license.html>.
114
115=cut
116