| blob | 7841843c5f91418a9220db969d0128d6e857fc92 |
1 .\" $OpenBSD: d2i_TS_REQ.3,v 1.1 2016/12/27 20:56:18 schwarze Exp $
2 .\"
3 .\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org>
4 .\"
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
8 .\"
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 .\"
17 .Dd $Mdocdate: December 27 2016 $
18 .Dt D2I_TS_REQ 3
19 .Os
20 .Sh NAME
21 .Nm d2i_TS_REQ ,
22 .Nm i2d_TS_REQ ,
23 .Nm d2i_TS_REQ_bio ,
24 .Nm i2d_TS_REQ_bio ,
25 .Nm d2i_TS_REQ_fp ,
26 .Nm i2d_TS_REQ_fp ,
27 .Nm d2i_TS_RESP ,
28 .Nm i2d_TS_RESP ,
29 .Nm d2i_TS_RESP_bio ,
30 .Nm i2d_TS_RESP_bio ,
31 .Nm d2i_TS_RESP_fp ,
32 .Nm i2d_TS_RESP_fp ,
33 .Nm d2i_TS_STATUS_INFO ,
34 .Nm i2d_TS_STATUS_INFO ,
35 .Nm d2i_TS_TST_INFO ,
36 .Nm i2d_TS_TST_INFO ,
37 .Nm d2i_TS_TST_INFO_bio ,
38 .Nm i2d_TS_TST_INFO_bio ,
39 .Nm d2i_TS_TST_INFO_fp ,
40 .Nm i2d_TS_TST_INFO_fp ,
41 .Nm d2i_TS_ACCURACY ,
42 .Nm i2d_TS_ACCURACY ,
43 .Nm d2i_TS_MSG_IMPRINT ,
44 .Nm i2d_TS_MSG_IMPRINT ,
45 .Nm d2i_TS_MSG_IMPRINT_bio ,
46 .Nm i2d_TS_MSG_IMPRINT_bio ,
47 .Nm d2i_TS_MSG_IMPRINT_fp ,
48 .Nm i2d_TS_MSG_IMPRINT_fp
49 .Nd decode and encode X.509 time-stamp protocol structures
50 .Sh SYNOPSIS
51 .In openssl/ts.h
52 .Ft TS_REQ *
53 .Fo d2i_TS_REQ
54 .Fa "TS_REQ **val_out"
55 .Fa "const unsigned char **der_in"
56 .Fa "long length"
57 .Fc
58 .Ft int
59 .Fo i2d_TS_REQ
60 .Fa "const TS_REQ *val_in"
61 .Fa "unsigned char **der_out"
62 .Fc
63 .Ft TS_REQ *
64 .Fo d2i_TS_REQ_bio
65 .Fa "BIO *in_bio"
66 .Fa "TS_REQ **val_out"
67 .Fc
68 .Ft int
69 .Fo i2d_TS_REQ_bio
70 .Fa "BIO *out_bio"
71 .Fa "TS_REQ *val_in"
72 .Fc
73 .Ft TS_REQ *
74 .Fo d2i_TS_REQ_fp
75 .Fa "FILE *in_fp"
76 .Fa "TS_REQ **val_out"
77 .Fc
78 .Ft int
79 .Fo i2d_TS_REQ_fp
80 .Fa "FILE *out_fp"
81 .Fa "TS_REQ *val_in"
82 .Fc
83 .Ft TS_RESP *
84 .Fo d2i_TS_RESP
85 .Fa "TS_RESP **val_out"
86 .Fa "const unsigned char **der_in"
87 .Fa "long length"
88 .Fc
89 .Ft int
90 .Fo i2d_TS_RESP
91 .Fa "const TS_RESP *val_in"
92 .Fa "unsigned char **der_out"
93 .Fc
94 .Ft TS_RESP *
95 .Fo d2i_TS_RESP_bio
96 .Fa "BIO *in_bio"
97 .Fa "TS_RESP **val_out"
98 .Fc
99 .Ft int
100 .Fo i2d_TS_RESP_bio
101 .Fa "BIO *out_bio"
102 .Fa "TS_RESP *val_in"
103 .Fc
104 .Ft TS_RESP *
105 .Fo d2i_TS_RESP_fp
106 .Fa "FILE *in_fp"
107 .Fa "TS_RESP **val_out"
108 .Fc
109 .Ft int
110 .Fo i2d_TS_RESP_fp
111 .Fa "FILE *out_fp"
112 .Fa "TS_RESP *val_in"
113 .Fc
114 .Ft TS_STATUS_INFO *
115 .Fo d2i_TS_STATUS_INFO
116 .Fa "TS_STATUS_INFO **val_out"
117 .Fa "const unsigned char **der_in"
118 .Fa "long length"
119 .Fc
120 .Ft int
121 .Fo i2d_TS_STATUS_INFO
122 .Fa "const TS_STATUS_INFO *val_in"
123 .Fa "unsigned char **der_out"
124 .Fc
125 .Ft TS_TST_INFO *
126 .Fo d2i_TS_TST_INFO
127 .Fa "TS_TST_INFO **val_out"
128 .Fa "const unsigned char **der_in"
129 .Fa "long length"
130 .Fc
131 .Ft int
132 .Fo i2d_TS_TST_INFO
133 .Fa "const TS_TST_INFO *val_in"
134 .Fa "unsigned char **der_out"
135 .Fc
136 .Ft TS_TST_INFO *
137 .Fo d2i_TS_TST_INFO_bio
138 .Fa "BIO *in_bio"
139 .Fa "TS_TST_INFO **val_out"
140 .Fc
141 .Ft int
142 .Fo i2d_TS_TST_INFO_bio
143 .Fa "BIO *out_bio"
144 .Fa "TS_TST_INFO *val_in"
145 .Fc
146 .Ft TS_TST_INFO *
147 .Fo d2i_TS_TST_INFO_fp
148 .Fa "FILE *in_fp"
149 .Fa "TS_TST_INFO **val_out"
150 .Fc
151 .Ft int
152 .Fo i2d_TS_TST_INFO_fp
153 .Fa "FILE *out_fp"
154 .Fa "TS_TST_INFO *val_in"
155 .Fc
156 .Ft TS_ACCURACY *
157 .Fo d2i_TS_ACCURACY
158 .Fa "TS_ACCURACY **val_out"
159 .Fa "const unsigned char **der_in"
160 .Fa "long length"
161 .Fc
162 .Ft int
163 .Fo i2d_TS_ACCURACY
164 .Fa "const TS_ACCURACY *val_in"
165 .Fa "unsigned char **der_out"
166 .Fc
167 .Ft TS_MSG_IMPRINT *
168 .Fo d2i_TS_MSG_IMPRINT
169 .Fa "TS_MSG_IMPRINT **val_out"
170 .Fa "const unsigned char **der_in"
171 .Fa "long length"
172 .Fc
173 .Ft int
174 .Fo i2d_TS_MSG_IMPRINT
175 .Fa "const TS_MSG_IMPRINT *val_in"
176 .Fa "unsigned char **der_out"
177 .Fc
178 .Ft TS_MSG_IMPRINT *
179 .Fo d2i_TS_MSG_IMPRINT_bio
180 .Fa "BIO *in_bio"
181 .Fa "TS_MSG_IMPRINT **val_out"
182 .Fc
183 .Ft int
184 .Fo i2d_TS_MSG_IMPRINT_bio
185 .Fa "BIO *out_bio"
186 .Fa "TS_MSG_IMPRINT *val_in"
187 .Fc
188 .Ft TS_MSG_IMPRINT *
189 .Fo d2i_TS_MSG_IMPRINT_fp
190 .Fa "FILE *in_fp"
191 .Fa "TS_MSG_IMPRINT **val_out"
192 .Fc
193 .Ft int
194 .Fo i2d_TS_MSG_IMPRINT_fp
195 .Fa "FILE *out_fp"
196 .Fa "TS_MSG_IMPRINT *val_in"
197 .Fc
198 .Sh DESCRIPTION
199 These functions decode and encode X.509 structures used for the
200 time-stamp protocol.
201 For details about the semantics, examples, caveats, and bugs, see
202 .Xr ASN1_item_d2i 3 .
203 .Pp
204 .Fn d2i_TS_REQ
205 and
206 .Fn i2d_TS_REQ
207 decode and encode an ASN.1
208 .Vt TimeStampReq
209 structure defined in RFC 3161 section 2.4.1.
210 .Fn d2i_TS_REQ_bio ,
211 .Fn i2d_TS_REQ_bio ,
212 .Fn d2i_TS_REQ_fp ,
213 and
214 .Fn i2d_TS_REQ_fp
215 are similar except that they decode or encode using a
216 .Vt BIO
217 or
218 .Vt FILE
219 pointer.
220 .Pp
221 .Fn d2i_TS_RESP
222 and
223 .Fn i2d_TS_RESP
224 decode and encode an ASN.1
225 .Vt TimeStampResp
226 structure defined in RFC 3161 section 2.4.2.
227 .Fn d2i_TS_RESP_bio ,
228 .Fn i2d_TS_RESP_bio ,
229 .Fn d2i_TS_RESP_fp ,
230 and
231 .Fn i2d_TS_RESP_fp
232 are similar except that they decode or encode using a
233 .Vt BIO
234 or
235 .Vt FILE
236 pointer.
237 .Pp
238 .Fn d2i_TS_STATUS_INFO
239 and
240 .Fn i2d_TS_STATUS_INFO
241 decode and encode an ASN.1
242 .Vt PKIStatusInfo
243 structure defined in RFC 3161 section 2.4.2.
244 .Pp
245 .Fn d2i_TS_TST_INFO
246 and
247 .Fn i2d_TS_TST_INFO
248 decode and encode an ASN.1
249 .Vt TSTInfo
250 structure defined in RFC 3161 section 2.4.2.
251 .Fn d2i_TS_TST_INFO_bio ,
252 .Fn i2d_TS_TST_INFO_bio ,
253 .Fn d2i_TS_TST_INFO_fp ,
254 and
255 .Fn i2d_TS_TST_INFO_fp
256 are similar except that they decode or encode using a
257 .Vt BIO
258 or
259 .Vt FILE
260 pointer.
261 .Pp
262 .Fn d2i_TS_ACCURACY
263 and
264 .Fn i2d_TS_ACCURACY
265 decode and encode an ASN.1
266 .Vt Accuracy
267 structure defined in RFC 3161 section 2.4.2.
268 .Pp
269 .Fn d2i_TS_MSG_IMPRINT
270 and
271 .Fn i2d_TS_MSG_IMPRINT
272 decode and encode an ASN.1
273 .Vt MessageImprint
274 structure defined in RFC 3161 section 2.4.1.
275 .Fn d2i_TS_MSG_IMPRINT_bio ,
276 .Fn i2d_TS_MSG_IMPRINT_bio ,
277 .Fn d2i_TS_MSG_IMPRINT_fp ,
278 and
279 .Fn i2d_TS_MSG_IMPRINT_fp
280 are similar except that they decode or encode using a
281 .Vt BIO
282 or
283 .Vt FILE
284 pointer.
285 .Sh RETURN VALUES
286 .Fn d2i_TS_REQ ,
287 .Fn d2i_TS_REQ_bio ,
288 .Fn d2i_TS_REQ_fp ,
289 .Fn d2i_TS_RESP ,
290 .Fn d2i_TS_RESP_bio ,
291 .Fn d2i_TS_RESP_fp ,
292 .Fn d2i_TS_STATUS_INFO ,
293 .Fn d2i_TS_TST_INFO ,
294 .Fn d2i_TS_TST_INFO_bio ,
295 .Fn d2i_TS_TST_INFO_fp ,
296 .Fn d2i_TS_ACCURACY ,
297 .Fn d2i_TS_MSG_IMPRINT ,
298 .Fn d2i_TS_MSG_IMPRINT_bio ,
299 and
300 .Fn d2i_TS_MSG_IMPRINT_fp
301 return an object of the respective type or
302 .Dv NULL
303 if an error occurs.
304 .Pp
305 .Fn i2d_TS_REQ ,
306 .Fn i2d_TS_RESP ,
307 .Fn i2d_TS_STATUS_INFO ,
308 .Fn i2d_TS_TST_INFO ,
309 .Fn i2d_TS_ACCURACY ,
310 and
311 .Fn i2d_TS_MSG_IMPRINT
312 return the number of bytes successfully encoded or a negative value
313 if an error occurs.
314 .Pp
315 .Fn i2d_TS_REQ_bio ,
316 .Fn i2d_TS_REQ_fp ,
317 .Fn i2d_TS_RESP_bio ,
318 .Fn i2d_TS_RESP_fp ,
319 .Fn i2d_TS_TST_INFO_bio ,
320 .Fn i2d_TS_TST_INFO_fp ,
321 .Fn i2d_TS_MSG_IMPRINT_bio ,
322 and
323 .Fn i2d_TS_MSG_IMPRINT_fp
324 return 1 for success or 0 if an error occurs.
325 .Sh SEE ALSO
326 .Xr ASN1_item_d2i 3 ,
327 .Xr TS_REQ_new 3
328 .Sh STANDARDS
329 RFC 3161: Internet X.509 Public Key Infrastructure Time-Stamp Protocol