Debian Codegraph @

upstream/debian-unstable/man3/X509_get_serialNumber.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "X509_GET_SERIALNUMBER 3SSL"
58 .TH X509_GET_SERIALNUMBER 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 X509_get_serialNumber,
65 X509_get0_serialNumber,
66 X509_set_serialNumber,
67 X509_ACERT_get0_serialNumber,
68 X509_ACERT_set1_serialNumber
69 \&\- get or set certificate serial number
70 .SH SYNOPSIS
71 .IX Header "SYNOPSIS"
72 .Vb 1
73 \& #include <openssl/x509.h>
74 \&
75 \& ASN1_INTEGER *X509_get_serialNumber(X509 *x);
76 \& const ASN1_INTEGER *X509_get0_serialNumber(const X509 *x);
77 \& int X509_set_serialNumber(X509 *x, ASN1_INTEGER *serial);
78 \&
79 \& #include <openssl/x509_acert.h>
80 \&
81 \& ASN1_INTEGER *X509_ACERT_get0_serialNumber(X509_ACERT *x);
82 \& int X509_ACERT_set1_serialNumber(X509_ACERT *x, ASN1_INTEGER *serial);
83 .Ve
84 .SH DESCRIPTION
85 .IX Header "DESCRIPTION"
86 \&\fBX509_get_serialNumber()\fR returns the serial number of certificate \fBx\fR as an
87 \&\fBASN1_INTEGER\fR structure which can be examined or initialised. The value
88 returned is an internal pointer which \fBMUST NOT\fR be freed up after the call.
89 .PP
90 \&\fBX509_get0_serialNumber()\fR is the same as \fBX509_get_serialNumber()\fR except it
91 accepts a const parameter and returns a const result.
92 .PP
93 \&\fBX509_set_serialNumber()\fR sets the serial number of certificate \fBx\fR to
94 \&\fBserial\fR. A copy of the serial number is used internally so \fBserial\fR should
95 be freed up after use.
96 .PP
97 \&\fBX509_ACERT_get0_serialNumber()\fR performs the same operation as
98 \&\fBX509_get_serialNumber()\fR for attribute certificates.
99 .PP
100 \&\fBX509_ACERT_set1_serialNumber()\fR performs the same operation as
101 \&\fBX509_set_serialNumber()\fR for attribute certificates.
102 .SH "RETURN VALUES"
103 .IX Header "RETURN VALUES"
104 \&\fBX509_get_serialNumber()\fR, \fBX509_get0_serialNumber()\fR and
105 \&\fBX509_ACERT_get0_serialNumber()\fR return a pointer to an \fBASN1_INTEGER\fR structure.
106 .PP
107 \&\fBX509_set_serialNumber()\fR and \fBX509_ACERT_set1_serialNumber()\fR return 1 for success
108 and 0 for failure.
109 .SH "SEE ALSO"
110 .IX Header "SEE ALSO"
111 \&\fBd2i_X509\fR\|(3),
112 \&\fBERR_get_error\fR\|(3),
113 \&\fBX509_CRL_get0_by_serial\fR\|(3),
114 \&\fBX509_get0_signature\fR\|(3),
115 \&\fBX509_get_ext_d2i\fR\|(3),
116 \&\fBX509_get_extension_flags\fR\|(3),
117 \&\fBX509_get_pubkey\fR\|(3),
118 \&\fBX509_get_subject_name\fR\|(3),
119 \&\fBX509_NAME_add_entry_by_txt\fR\|(3),
120 \&\fBX509_NAME_ENTRY_get_object\fR\|(3),
121 \&\fBX509_NAME_get_index_by_NID\fR\|(3),
122 \&\fBX509_NAME_print_ex\fR\|(3),
123 \&\fBX509_new\fR\|(3),
124 \&\fBX509_sign\fR\|(3),
125 \&\fBX509V3_get_d2i\fR\|(3),
126 \&\fBX509_verify_cert\fR\|(3)
127 .SH HISTORY
128 .IX Header "HISTORY"
129 The \fBX509_get_serialNumber()\fR and \fBX509_set_serialNumber()\fR functions are
130 available in all versions of OpenSSL.
131 The \fBX509_get0_serialNumber()\fR function was added in OpenSSL 1.1.0.
132 The \fBX509_ACERT_get0_serialNumber()\fR and \fBX509_ACERT_set1_serialNumber()\fR
133 functions were added in OpenSSL 3.4.
134 .SH COPYRIGHT
135 .IX Header "COPYRIGHT"
136 Copyright 2016\-2024 The OpenSSL Project Authors. All Rights Reserved.
137 .PP
138 Licensed under the Apache License 2.0 (the "License"). You may not use
139 this file except in compliance with the License. You can obtain a copy
140 in the file LICENSE in the source distribution or at
141 <https://www.openssl.org/source/license.html>.