Blame doc/man3/X509_CRL_get0_by_serial.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
X509_CRL_get0_by_serial, X509_CRL_get0_by_cert, X509_CRL_get_REVOKED,
Packit c4476c
X509_REVOKED_get0_serialNumber, X509_REVOKED_get0_revocationDate,
Packit c4476c
X509_REVOKED_set_serialNumber, X509_REVOKED_set_revocationDate,
Packit c4476c
X509_CRL_add0_revoked, X509_CRL_sort - CRL revoked entry utility
Packit c4476c
functions
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/x509.h>
Packit c4476c
Packit c4476c
 int X509_CRL_get0_by_serial(X509_CRL *crl,
Packit c4476c
                             X509_REVOKED **ret, ASN1_INTEGER *serial);
Packit c4476c
 int X509_CRL_get0_by_cert(X509_CRL *crl, X509_REVOKED **ret, X509 *x);
Packit c4476c
Packit c4476c
 STACK_OF(X509_REVOKED) *X509_CRL_get_REVOKED(X509_CRL *crl);
Packit c4476c
Packit c4476c
 const ASN1_INTEGER *X509_REVOKED_get0_serialNumber(const X509_REVOKED *r);
Packit c4476c
 const ASN1_TIME *X509_REVOKED_get0_revocationDate(const X509_REVOKED *r);
Packit c4476c
Packit c4476c
 int X509_REVOKED_set_serialNumber(X509_REVOKED *r, ASN1_INTEGER *serial);
Packit c4476c
 int X509_REVOKED_set_revocationDate(X509_REVOKED *r, ASN1_TIME *tm);
Packit c4476c
Packit c4476c
 int X509_CRL_add0_revoked(X509_CRL *crl, X509_REVOKED *rev);
Packit c4476c
Packit c4476c
 int X509_CRL_sort(X509_CRL *crl);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
X509_CRL_get0_by_serial() attempts to find a revoked entry in B<crl> for
Packit c4476c
serial number B<serial>. If it is successful it sets B<*ret> to the internal
Packit c4476c
pointer of the matching entry, as a result B<*ret> must not be freed up
Packit c4476c
after the call.
Packit c4476c
Packit c4476c
X509_CRL_get0_by_cert() is similar to X509_get0_by_serial() except it
Packit c4476c
looks for a revoked entry using the serial number of certificate B<x>.
Packit c4476c
Packit c4476c
X509_CRL_get_REVOKED() returns an internal pointer to a stack of all
Packit c4476c
revoked entries for B<crl>.
Packit c4476c
Packit c4476c
X509_REVOKED_get0_serialNumber() returns an internal pointer to the
Packit c4476c
serial number of B<r>.
Packit c4476c
Packit c4476c
X509_REVOKED_get0_revocationDate() returns an internal pointer to the
Packit c4476c
revocation date of B<r>.
Packit c4476c
Packit c4476c
X509_REVOKED_set_serialNumber() sets the serial number of B<r> to B<serial>.
Packit c4476c
The supplied B<serial> pointer is not used internally so it should be
Packit c4476c
freed up after use.
Packit c4476c
Packit c4476c
X509_REVOKED_set_revocationDate() sets the revocation date of B<r> to
Packit c4476c
B<tm>. The supplied B<tm> pointer is not used internally so it should be
Packit c4476c
freed up after use.
Packit c4476c
Packit c4476c
X509_CRL_add0_revoked() appends revoked entry B<rev> to CRL B<crl>. The
Packit c4476c
pointer B<rev> is used internally so it must not be freed up after the call:
Packit c4476c
it is freed when the parent CRL is freed.
Packit c4476c
Packit c4476c
X509_CRL_sort() sorts the revoked entries of B<crl> into ascending serial
Packit c4476c
number order.
Packit c4476c
Packit c4476c
=head1 NOTES
Packit c4476c
Packit c4476c
Applications can determine the number of revoked entries returned by
Packit c4476c
X509_CRL_get_revoked() using sk_X509_REVOKED_num() and examine each one
Packit c4476c
in turn using sk_X509_REVOKED_value().
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
X509_CRL_get0_by_serial() and X509_CRL_get0_by_cert() return 0 for failure,
Packit c4476c
1 on success except if the revoked entry has the reason C<removeFromCRL> (8),
Packit c4476c
in which case 2 is returned.
Packit c4476c
Packit c4476c
X509_REVOKED_set_serialNumber(), X509_REVOKED_set_revocationDate(),
Packit c4476c
X509_CRL_add0_revoked() and X509_CRL_sort() return 1 for success and 0 for
Packit c4476c
failure.
Packit c4476c
Packit c4476c
X509_REVOKED_get0_serialNumber() returns an B<ASN1_INTEGER> pointer.
Packit c4476c
Packit c4476c
X509_REVOKED_get0_revocationDate() returns an B<ASN1_TIME> value.
Packit c4476c
Packit c4476c
X509_CRL_get_REVOKED() returns a STACK of revoked entries.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<d2i_X509(3)>,
Packit c4476c
L<ERR_get_error(3)>,
Packit c4476c
L<X509_get0_signature(3)>,
Packit c4476c
L<X509_get_ext_d2i(3)>,
Packit c4476c
L<X509_get_extension_flags(3)>,
Packit c4476c
L<X509_get_pubkey(3)>,
Packit c4476c
L<X509_get_subject_name(3)>,
Packit c4476c
L<X509_get_version(3)>,
Packit c4476c
L<X509_NAME_add_entry_by_txt(3)>,
Packit c4476c
L<X509_NAME_ENTRY_get_object(3)>,
Packit c4476c
L<X509_NAME_get_index_by_NID(3)>,
Packit c4476c
L<X509_NAME_print_ex(3)>,
Packit c4476c
L<X509_new(3)>,
Packit c4476c
L<X509_sign(3)>,
Packit c4476c
L<X509V3_get_d2i(3)>,
Packit c4476c
L<X509_verify_cert(3)>
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut