xref: /openbsd-src/lib/libcrypto/man/d2i_X509_REQ.3 (revision 10e00d1796876719ecd5784348f9f4f2b3dd83c5)

.\"	$OpenBSD: d2i_X509_REQ.3,v 1.7 2018/03/27 17:35:50 schwarze Exp $
.\"	OpenSSL bb9ad09e Jun 6 00:43:05 2016 -0400
.\"
.\" 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 27 2018 $
.Dt D2I_X509_REQ 3
.Os
.Sh NAME
.Nm d2i_X509_REQ ,
.Nm i2d_X509_REQ ,
.Nm d2i_X509_REQ_bio ,
.Nm d2i_X509_REQ_fp ,
.Nm i2d_X509_REQ_bio ,
.Nm i2d_X509_REQ_fp ,
.Nm d2i_X509_REQ_INFO ,
.Nm i2d_X509_REQ_INFO
.Nd decode and encode PKCS#10 certification requests
.Sh SYNOPSIS
.In openssl/x509.h
.Ft X509_REQ *
.Fo d2i_X509_REQ
.Fa "X509_REQ **val_out"
.Fa "const unsigned char **der_in"
.Fa "long length"
.Fc
.Ft int
.Fo i2d_X509_REQ
.Fa "X509_REQ *val_in"
.Fa "unsigned char **der_out"
.Fc
.Ft X509_REQ *
.Fo d2i_X509_REQ_bio
.Fa "BIO *in_bio"
.Fa "X509_REQ **val_out"
.Fc
.Ft X509_REQ *
.Fo d2i_X509_REQ_fp
.Fa "FILE *in_fp"
.Fa "X509_REQ **val_out"
.Fc
.Ft int
.Fo i2d_X509_REQ_bio
.Fa "BIO *out_bio"
.Fa "X509_REQ *val_in"
.Fc
.Ft int
.Fo i2d_X509_REQ_fp
.Fa "FILE *out_fp"
.Fa "X509_REQ *val_in"
.Fc
.Ft X509_REQ_INFO *
.Fo d2i_X509_REQ_INFO
.Fa "X509_REQ_INFO **val_out"
.Fa "const unsigned char **der_in"
.Fa "long length"
.Fc
.Ft int
.Fo i2d_X509_REQ_INFO
.Fa "X509_REQ_INFO *val_in"
.Fa "unsigned char **der_out"
.Fc
.Sh DESCRIPTION
These functions decode and encode PKCS#10 certification requests.
For details about the semantics, examples, caveats, and bugs, see
.Xr ASN1_item_d2i 3 .
.Pp
.Fn d2i_X509_REQ
and
.Fn i2d_X509_REQ
decode and encode an ASN.1
.Vt CertificationRequest
structure defined in RFC 2986 section 4.2.
.Fn d2i_X509_REQ_bio ,
.Fn d2i_X509_REQ_fp ,
.Fn i2d_X509_REQ_bio ,
and
.Fn i2d_X509_REQ_fp
are similar except that they decode or encode using a
.Vt BIO
or
.Vt FILE
pointer.
.Pp
.Fn d2i_X509_REQ_INFO
and
.Fn i2d_X509_REQ_INFO
decode and encode an ASN.1
.Vt CertificationRequestInfo
structure defined in RFC 2986 section 4.1.
.Sh RETURN VALUES
.Fn d2i_X509_REQ ,
.Fn d2i_X509_REQ_bio ,
and
.Fn d2i_X509_REQ_fp
return an
.Vt X509_REQ
object or
.Dv NULL
if an error occurs.
.Pp
.Fn d2i_X509_REQ_INFO
returns an
.Vt X509_REQ_INFO
object or
.Dv NULL
if an error occurs.
.Pp
.Fn i2d_X509_REQ
and
.Fn i2d_X509_REQ_INFO
return the number of bytes successfully encoded or a negative value
if an error occurs.
.Pp
.Fn i2d_X509_REQ_bio
and
.Fn i2d_X509_REQ_fp
return 1 for success or 0 if an error occurs.
.Sh SEE ALSO
.Xr ASN1_item_d2i 3 ,
.Xr PEM_read_X509_REQ 3 ,
.Xr X509_REQ_new 3
.Sh STANDARDS
RFC 2986: PKCS #10: Certification Request Syntax Specification
.Sh HISTORY
.Fn d2i_X509_REQ ,
.Fn i2d_X509_REQ ,
.Fn d2i_X509_REQ_fp ,
.Fn i2d_X509_REQ_fp ,
.Fn d2i_X509_REQ_INFO ,
and
.Fn i2d_X509_REQ_INFO
first appeared in SSLeay 0.5.1.
.Fn d2i_X509_REQ_bio
and
.Fn i2d_X509_REQ_bio
first appeared in SSLeay 0.6.0.
These functions have been available since
.Ox 2.4 .