]>
Commit | Line | Data |
---|---|---|
bae26b58 DSH |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
68c12bfc DSH |
5 | X509_get_serialNumber, |
6 | X509_get0_serialNumber, | |
7 | X509_set_serialNumber | |
8 | - get or set certificate serial number | |
bae26b58 DSH |
9 | |
10 | =head1 SYNOPSIS | |
11 | ||
12 | #include <openssl/x509.h> | |
13 | ||
14 | ASN1_INTEGER *X509_get_serialNumber(X509 *x); | |
68c12bfc | 15 | const ASN1_INTEGER *X509_get0_serialNumber(const X509 *x); |
bae26b58 DSH |
16 | int X509_set_serialNumber(X509 *x, ASN1_INTEGER *serial); |
17 | ||
18 | =head1 DESCRIPTION | |
19 | ||
20 | X509_get_serialNumber() returns the serial number of certificate B<x> as an | |
21 | B<ASN1_INTEGER> structure which can be examined or initialised. The value | |
22 | returned is an internal pointer which B<MUST NOT> be freed up after the call. | |
23 | ||
68c12bfc DSH |
24 | X509_get0_serialNumber() is the same as X509_get_serialNumber() except it |
25 | accepts a const parameter and returns a const result. | |
26 | ||
bae26b58 DSH |
27 | X509_set_serialNumber() sets the serial number of certificate B<x> to |
28 | B<serial>. A copy of the serial number is used internally so B<serial> should | |
29 | be freed up after use. | |
30 | ||
31 | =head1 RETURN VALUES | |
32 | ||
68c12bfc DSH |
33 | X509_get_serialNumber() and X509_get0_serialNumber() return an B<ASN1_INTEGER> |
34 | structure. | |
bae26b58 DSH |
35 | |
36 | X509_set_serialNumber() returns 1 for success and 0 for 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_NAME_add_entry_by_txt(3)>, | |
49 | L<X509_NAME_ENTRY_get_object(3)>, | |
50 | L<X509_NAME_get_index_by_NID(3)>, | |
51 | L<X509_NAME_print_ex(3)>, | |
52 | L<X509_new(3)>, | |
53 | L<X509_sign(3)>, | |
54 | L<X509V3_get_d2i(3)>, | |
55 | L<X509_verify_cert(3)> | |
56 | ||
57 | =head1 HISTORY | |
58 | ||
fc5ecadd DMSP |
59 | The X509_get_serialNumber() and X509_set_serialNumber() functions are |
60 | available in all versions of OpenSSL. | |
61 | The X509_get0_serialNumber() function was added in OpenSSL 1.1.0. | |
bae26b58 | 62 | |
e2f92610 RS |
63 | =head1 COPYRIGHT |
64 | ||
65 | Copyright 2016 The OpenSSL Project Authors. All Rights Reserved. | |
66 | ||
4746f25a | 67 | Licensed under the Apache License 2.0 (the "License"). You may not use |
e2f92610 RS |
68 | this file except in compliance with the License. You can obtain a copy |
69 | in the file LICENSE in the source distribution or at | |
70 | L<https://www.openssl.org/source/license.html>. | |
71 | ||
72 | =cut |