xref: /openbsd-src/lib/libcrypto/man/d2i_TS_REQ.3 (revision 56929f715bd5fc8d3d16d15fbc2ecf4028a27606)

.\"	$OpenBSD: d2i_TS_REQ.3,v 1.2 2018/03/23 04:34:23 schwarze Exp $
.\"
.\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: March 23 2018 $
.Dt D2I_TS_REQ 3
.Os
.Sh NAME
.Nm d2i_TS_REQ ,
.Nm i2d_TS_REQ ,
.Nm d2i_TS_REQ_bio ,
.Nm i2d_TS_REQ_bio ,
.Nm d2i_TS_REQ_fp ,
.Nm i2d_TS_REQ_fp ,
.Nm d2i_TS_RESP ,
.Nm i2d_TS_RESP ,
.Nm d2i_TS_RESP_bio ,
.Nm i2d_TS_RESP_bio ,
.Nm d2i_TS_RESP_fp ,
.Nm i2d_TS_RESP_fp ,
.Nm d2i_TS_STATUS_INFO ,
.Nm i2d_TS_STATUS_INFO ,
.Nm d2i_TS_TST_INFO ,
.Nm i2d_TS_TST_INFO ,
.Nm d2i_TS_TST_INFO_bio ,
.Nm i2d_TS_TST_INFO_bio ,
.Nm d2i_TS_TST_INFO_fp ,
.Nm i2d_TS_TST_INFO_fp ,
.Nm d2i_TS_ACCURACY ,
.Nm i2d_TS_ACCURACY ,
.Nm d2i_TS_MSG_IMPRINT ,
.Nm i2d_TS_MSG_IMPRINT ,
.Nm d2i_TS_MSG_IMPRINT_bio ,
.Nm i2d_TS_MSG_IMPRINT_bio ,
.Nm d2i_TS_MSG_IMPRINT_fp ,
.Nm i2d_TS_MSG_IMPRINT_fp
.Nd decode and encode X.509 time-stamp protocol structures
.Sh SYNOPSIS
.In openssl/ts.h
.Ft TS_REQ *
.Fo d2i_TS_REQ
.Fa "TS_REQ **val_out"
.Fa "const unsigned char **der_in"
.Fa "long length"
.Fc
.Ft int
.Fo i2d_TS_REQ
.Fa "const TS_REQ *val_in"
.Fa "unsigned char **der_out"
.Fc
.Ft TS_REQ *
.Fo d2i_TS_REQ_bio
.Fa "BIO *in_bio"
.Fa "TS_REQ **val_out"
.Fc
.Ft int
.Fo i2d_TS_REQ_bio
.Fa "BIO *out_bio"
.Fa "TS_REQ *val_in"
.Fc
.Ft TS_REQ *
.Fo d2i_TS_REQ_fp
.Fa "FILE *in_fp"
.Fa "TS_REQ **val_out"
.Fc
.Ft int
.Fo i2d_TS_REQ_fp
.Fa "FILE *out_fp"
.Fa "TS_REQ *val_in"
.Fc
.Ft TS_RESP *
.Fo d2i_TS_RESP
.Fa "TS_RESP **val_out"
.Fa "const unsigned char **der_in"
.Fa "long length"
.Fc
.Ft int
.Fo i2d_TS_RESP
.Fa "const TS_RESP *val_in"
.Fa "unsigned char **der_out"
.Fc
.Ft TS_RESP *
.Fo d2i_TS_RESP_bio
.Fa "BIO *in_bio"
.Fa "TS_RESP **val_out"
.Fc
.Ft int
.Fo i2d_TS_RESP_bio
.Fa "BIO *out_bio"
.Fa "TS_RESP *val_in"
.Fc
.Ft TS_RESP *
.Fo d2i_TS_RESP_fp
.Fa "FILE *in_fp"
.Fa "TS_RESP **val_out"
.Fc
.Ft int
.Fo i2d_TS_RESP_fp
.Fa "FILE *out_fp"
.Fa "TS_RESP *val_in"
.Fc
.Ft TS_STATUS_INFO *
.Fo d2i_TS_STATUS_INFO
.Fa "TS_STATUS_INFO **val_out"
.Fa "const unsigned char **der_in"
.Fa "long length"
.Fc
.Ft int
.Fo i2d_TS_STATUS_INFO
.Fa "const TS_STATUS_INFO *val_in"
.Fa "unsigned char **der_out"
.Fc
.Ft TS_TST_INFO *
.Fo d2i_TS_TST_INFO
.Fa "TS_TST_INFO **val_out"
.Fa "const unsigned char **der_in"
.Fa "long length"
.Fc
.Ft int
.Fo i2d_TS_TST_INFO
.Fa "const TS_TST_INFO *val_in"
.Fa "unsigned char **der_out"
.Fc
.Ft TS_TST_INFO *
.Fo d2i_TS_TST_INFO_bio
.Fa "BIO *in_bio"
.Fa "TS_TST_INFO **val_out"
.Fc
.Ft int
.Fo i2d_TS_TST_INFO_bio
.Fa "BIO *out_bio"
.Fa "TS_TST_INFO *val_in"
.Fc
.Ft TS_TST_INFO *
.Fo d2i_TS_TST_INFO_fp
.Fa "FILE *in_fp"
.Fa "TS_TST_INFO **val_out"
.Fc
.Ft int
.Fo i2d_TS_TST_INFO_fp
.Fa "FILE *out_fp"
.Fa "TS_TST_INFO *val_in"
.Fc
.Ft TS_ACCURACY *
.Fo d2i_TS_ACCURACY
.Fa "TS_ACCURACY **val_out"
.Fa "const unsigned char **der_in"
.Fa "long length"
.Fc
.Ft int
.Fo i2d_TS_ACCURACY
.Fa "const TS_ACCURACY *val_in"
.Fa "unsigned char **der_out"
.Fc
.Ft TS_MSG_IMPRINT *
.Fo d2i_TS_MSG_IMPRINT
.Fa "TS_MSG_IMPRINT **val_out"
.Fa "const unsigned char **der_in"
.Fa "long length"
.Fc
.Ft int
.Fo i2d_TS_MSG_IMPRINT
.Fa "const TS_MSG_IMPRINT *val_in"
.Fa "unsigned char **der_out"
.Fc
.Ft TS_MSG_IMPRINT *
.Fo d2i_TS_MSG_IMPRINT_bio
.Fa "BIO *in_bio"
.Fa "TS_MSG_IMPRINT **val_out"
.Fc
.Ft int
.Fo i2d_TS_MSG_IMPRINT_bio
.Fa "BIO *out_bio"
.Fa "TS_MSG_IMPRINT *val_in"
.Fc
.Ft TS_MSG_IMPRINT *
.Fo d2i_TS_MSG_IMPRINT_fp
.Fa "FILE *in_fp"
.Fa "TS_MSG_IMPRINT **val_out"
.Fc
.Ft int
.Fo i2d_TS_MSG_IMPRINT_fp
.Fa "FILE *out_fp"
.Fa "TS_MSG_IMPRINT *val_in"
.Fc
.Sh DESCRIPTION
These functions decode and encode X.509 structures used for the
time-stamp protocol.
For details about the semantics, examples, caveats, and bugs, see
.Xr ASN1_item_d2i 3 .
.Pp
.Fn d2i_TS_REQ
and
.Fn i2d_TS_REQ
decode and encode an ASN.1
.Vt TimeStampReq
structure defined in RFC 3161 section 2.4.1.
.Fn d2i_TS_REQ_bio ,
.Fn i2d_TS_REQ_bio ,
.Fn d2i_TS_REQ_fp ,
and
.Fn i2d_TS_REQ_fp
are similar except that they decode or encode using a
.Vt BIO
or
.Vt FILE
pointer.
.Pp
.Fn d2i_TS_RESP
and
.Fn i2d_TS_RESP
decode and encode an ASN.1
.Vt TimeStampResp
structure defined in RFC 3161 section 2.4.2.
.Fn d2i_TS_RESP_bio ,
.Fn i2d_TS_RESP_bio ,
.Fn d2i_TS_RESP_fp ,
and
.Fn i2d_TS_RESP_fp
are similar except that they decode or encode using a
.Vt BIO
or
.Vt FILE
pointer.
.Pp
.Fn d2i_TS_STATUS_INFO
and
.Fn i2d_TS_STATUS_INFO
decode and encode an ASN.1
.Vt PKIStatusInfo
structure defined in RFC 3161 section 2.4.2.
.Pp
.Fn d2i_TS_TST_INFO
and
.Fn i2d_TS_TST_INFO
decode and encode an ASN.1
.Vt TSTInfo
structure defined in RFC 3161 section 2.4.2.
.Fn d2i_TS_TST_INFO_bio ,
.Fn i2d_TS_TST_INFO_bio ,
.Fn d2i_TS_TST_INFO_fp ,
and
.Fn i2d_TS_TST_INFO_fp
are similar except that they decode or encode using a
.Vt BIO
or
.Vt FILE
pointer.
.Pp
.Fn d2i_TS_ACCURACY
and
.Fn i2d_TS_ACCURACY
decode and encode an ASN.1
.Vt Accuracy
structure defined in RFC 3161 section 2.4.2.
.Pp
.Fn d2i_TS_MSG_IMPRINT
and
.Fn i2d_TS_MSG_IMPRINT
decode and encode an ASN.1
.Vt MessageImprint
structure defined in RFC 3161 section 2.4.1.
.Fn d2i_TS_MSG_IMPRINT_bio ,
.Fn i2d_TS_MSG_IMPRINT_bio ,
.Fn d2i_TS_MSG_IMPRINT_fp ,
and
.Fn i2d_TS_MSG_IMPRINT_fp
are similar except that they decode or encode using a
.Vt BIO
or
.Vt FILE
pointer.
.Sh RETURN VALUES
.Fn d2i_TS_REQ ,
.Fn d2i_TS_REQ_bio ,
.Fn d2i_TS_REQ_fp ,
.Fn d2i_TS_RESP ,
.Fn d2i_TS_RESP_bio ,
.Fn d2i_TS_RESP_fp ,
.Fn d2i_TS_STATUS_INFO ,
.Fn d2i_TS_TST_INFO ,
.Fn d2i_TS_TST_INFO_bio ,
.Fn d2i_TS_TST_INFO_fp ,
.Fn d2i_TS_ACCURACY ,
.Fn d2i_TS_MSG_IMPRINT ,
.Fn d2i_TS_MSG_IMPRINT_bio ,
and
.Fn d2i_TS_MSG_IMPRINT_fp
return an object of the respective type or
.Dv NULL
if an error occurs.
.Pp
.Fn i2d_TS_REQ ,
.Fn i2d_TS_RESP ,
.Fn i2d_TS_STATUS_INFO ,
.Fn i2d_TS_TST_INFO ,
.Fn i2d_TS_ACCURACY ,
and
.Fn i2d_TS_MSG_IMPRINT
return the number of bytes successfully encoded or a negative value
if an error occurs.
.Pp
.Fn i2d_TS_REQ_bio ,
.Fn i2d_TS_REQ_fp ,
.Fn i2d_TS_RESP_bio ,
.Fn i2d_TS_RESP_fp ,
.Fn i2d_TS_TST_INFO_bio ,
.Fn i2d_TS_TST_INFO_fp ,
.Fn i2d_TS_MSG_IMPRINT_bio ,
and
.Fn i2d_TS_MSG_IMPRINT_fp
return 1 for success or 0 if an error occurs.
.Sh SEE ALSO
.Xr ASN1_item_d2i 3 ,
.Xr TS_REQ_new 3
.Sh STANDARDS
RFC 3161: Internet X.509 Public Key Infrastructure Time-Stamp Protocol
.Sh HISTORY
These functions first appeared in OpenSSL 1.0.0
and have been available since
.Ox 4.9 .