Debian Codegraph @

upstream/debian-unstable/man3/i2d_re_X509_tbs.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 "I2D_RE_X509_TBS 3SSL"
58 .TH I2D_RE_X509_TBS 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 d2i_X509_AUX, i2d_X509_AUX,
65 i2d_re_X509_tbs, i2d_re_X509_CRL_tbs, i2d_re_X509_REQ_tbs
66 \&\- X509 encode and decode functions
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/x509.h>
71 \&
72 \& X509 *d2i_X509_AUX(X509 **px, const unsigned char **in, long len);
73 \& int i2d_X509_AUX(const X509 *x, unsigned char **out);
74 \& int i2d_re_X509_tbs(X509 *x, unsigned char **out);
75 \& int i2d_re_X509_CRL_tbs(X509_CRL *crl, unsigned char **pp);
76 \& int i2d_re_X509_REQ_tbs(X509_REQ *req, unsigned char **pp);
77 .Ve
78 .SH DESCRIPTION
79 .IX Header "DESCRIPTION"
80 The X509 encode and decode routines encode and parse an
81 \&\fBX509\fR structure, which represents an X509 certificate.
82 .PP
83 \&\fBd2i_X509_AUX()\fR is similar to \fBd2i_X509\fR\|(3) but the input is expected to
84 consist of an X509 certificate followed by auxiliary trust information.
85 This is used by the PEM routines to read "TRUSTED CERTIFICATE" objects.
86 This function should not be called on untrusted input.
87 .PP
88 \&\fBi2d_X509_AUX()\fR is similar to \fBi2d_X509\fR\|(3), but the encoded output
89 contains both the certificate and any auxiliary trust information.
90 This is used by the PEM routines to write "TRUSTED CERTIFICATE" objects.
91 Note that this is a non-standard OpenSSL-specific data format.
92 .PP
93 \&\fBi2d_re_X509_tbs()\fR is similar to \fBi2d_X509\fR\|(3) except it encodes only
94 the TBSCertificate portion of the certificate. \fBi2d_re_X509_CRL_tbs()\fR
95 and \fBi2d_re_X509_REQ_tbs()\fR are analogous for CRL and certificate request,
96 respectively. The "re" in \fBi2d_re_X509_tbs\fR stands for "re-encode",
97 and ensures that a fresh encoding is generated in case the object has been
98 modified after creation (see the BUGS section).
99 .PP
100 The encoding of the TBSCertificate portion of a certificate is cached
101 in the \fBX509\fR structure internally to improve encoding performance
102 and to ensure certificate signatures are verified correctly in some
103 certificates with broken (non-DER) encodings.
104 .PP
105 If, after modification, the \fBX509\fR object is re-signed with \fBX509_sign()\fR,
106 the encoding is automatically renewed. Otherwise, the encoding of the
107 TBSCertificate portion of the \fBX509\fR can be manually renewed by calling
108 \&\fBi2d_re_X509_tbs()\fR.
109 .SH "RETURN VALUES"
110 .IX Header "RETURN VALUES"
111 \&\fBd2i_X509_AUX()\fR returns a valid \fBX509\fR structure or NULL if an error occurred.
112 .PP
113 \&\fBi2d_X509_AUX()\fR returns the length of encoded data or \-1 on error.
114 .PP
115 \&\fBi2d_re_X509_tbs()\fR, \fBi2d_re_X509_CRL_tbs()\fR and \fBi2d_re_X509_REQ_tbs()\fR return the
116 length of encoded data or <=0 on error.
117 .SH "SEE ALSO"
118 .IX Header "SEE ALSO"
119 \&\fBERR_get_error\fR\|(3)
120 \&\fBX509_CRL_get0_by_serial\fR\|(3),
121 \&\fBX509_get0_signature\fR\|(3),
122 \&\fBX509_get_ext_d2i\fR\|(3),
123 \&\fBX509_get_extension_flags\fR\|(3),
124 \&\fBX509_get_pubkey\fR\|(3),
125 \&\fBX509_get_subject_name\fR\|(3),
126 \&\fBX509_get_version\fR\|(3),
127 \&\fBX509_NAME_add_entry_by_txt\fR\|(3),
128 \&\fBX509_NAME_ENTRY_get_object\fR\|(3),
129 \&\fBX509_NAME_get_index_by_NID\fR\|(3),
130 \&\fBX509_NAME_print_ex\fR\|(3),
131 \&\fBX509_new\fR\|(3),
132 \&\fBX509_sign\fR\|(3),
133 \&\fBX509V3_get_d2i\fR\|(3),
134 \&\fBX509_verify_cert\fR\|(3)
135 .SH COPYRIGHT
136 .IX Header "COPYRIGHT"
137 Copyright 2002\-2018 The OpenSSL Project Authors. All Rights Reserved.
138 .PP
139 Licensed under the Apache License 2.0 (the "License"). You may not use
140 this file except in compliance with the License. You can obtain a copy
141 in the file LICENSE in the source distribution or at
142 <https://www.openssl.org/source/license.html>.