Fix grammar in certificates.txt
[openssl.git] / doc / man3 / X509_get0_uids.pod
1 =pod
2
3 =head1 NAME
4
5 X509_get0_uids, X509_ACERT_get0_issuerUID
6 - get certificate and attribute certificate unique identifiers
7
8 =head1 SYNOPSIS
9
10  #include <openssl/x509.h>
11
12  void X509_get0_uids(const X509 *x, const ASN1_BIT_STRING **piuid,
13                      const ASN1_BIT_STRING **psuid);
14
15  #include <openssl/x509_acert.h>
16
17  ASN1_BIT_STRING *X509_ACERT_get0_issuerUID(X509_ACERT *x);
18 =head1 DESCRIPTION
19
20 X509_get0_uids() sets B<*piuid> and B<*psuid> to the issuer and subject unique
21 identifiers of certificate B<x> or NULL if the fields are not present.
22
23 X509_ACERT_get0_issuerUID() returns the issuer unique identifier of the
24 attribute certificate B<x> or NULL if the field is not present.
25
26 =head1 NOTES
27
28 The issuer and subject unique identifier fields are very rarely encountered in
29 practice outside test cases.
30
31 =head1 RETURN VALUES
32
33 X509_get0_uids() does not return a value.
34
35 X509_ACERT_get0_issuerUID() returns a unique identifier on success or NULL
36 on failure.
37
38 =head1 SEE ALSO
39
40 L<d2i_X509(3)>,
41 L<ERR_get_error(3)>,
42 L<X509_CRL_get0_by_serial(3)>,
43 L<X509_get0_signature(3)>,
44 L<X509_get_ext_d2i(3)>,
45 L<X509_get_extension_flags(3)>,
46 L<X509_get_pubkey(3)>,
47 L<X509_get_subject_name(3)>,
48 L<X509_get_version(3)>,
49 L<X509_NAME_add_entry_by_txt(3)>,
50 L<X509_NAME_ENTRY_get_object(3)>,
51 L<X509_NAME_get_index_by_NID(3)>,
52 L<X509_NAME_print_ex(3)>,
53 L<X509_new(3)>,
54 L<X509_sign(3)>,
55 L<X509V3_get_d2i(3)>,
56 L<X509_verify_cert(3)>
57
58 =head1 HISTORY
59
60 X509_get0_uids() was added in OpenSSL 1.1.0.
61
62 X509_ACERT_get0_issuerUID() was added in OpenSSL 3.4.
63
64 =head1 COPYRIGHT
65
66 Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
67
68 Licensed under the Apache License 2.0 (the "License").  You may not use
69 this file except in compliance with the License.  You can obtain a copy
70 in the file LICENSE in the source distribution or at
71 L<https://www.openssl.org/source/license.html>.
72
73 =cut