diff options
author | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2016-12-27 22:06:56 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2016-12-27 22:06:56 +0000 |
commit | 8fbe73d40f52e942ab35142c6cfbc688c00d8447 (patch) | |
tree | f5d4d4d7091b507f2123a7075b688442b601ddab /lib/libcrypto | |
parent | 1f5c9b14d8933f087907d3045131e3a7cc5854fd (diff) |
Write new manual pages d2i_OCSP_REQUEST(3) and d2i_OCSP_RESPONSE(3)
from scratch. All these functions are listed in <openssl/ocsp.h>
and in OpenSSL doc/man3/d2i_X509.pod.
Diffstat (limited to 'lib/libcrypto')
-rw-r--r-- | lib/libcrypto/man/Makefile | 4 | ||||
-rw-r--r-- | lib/libcrypto/man/d2i_OCSP_REQUEST.3 | 177 | ||||
-rw-r--r-- | lib/libcrypto/man/d2i_OCSP_RESPONSE.3 | 243 |
3 files changed, 423 insertions, 1 deletions
diff --git a/lib/libcrypto/man/Makefile b/lib/libcrypto/man/Makefile index afd0fe5512d..0e8d4dde50a 100644 --- a/lib/libcrypto/man/Makefile +++ b/lib/libcrypto/man/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.104 2016/12/27 20:56:18 schwarze Exp $ +# $OpenBSD: Makefile,v 1.105 2016/12/27 22:06:55 schwarze Exp $ .include <bsd.own.mk> @@ -232,6 +232,8 @@ MAN= \ d2i_DSAPublicKey.3 \ d2i_ECPKParameters.3 \ d2i_ESS_SIGNING_CERT.3 \ + d2i_OCSP_REQUEST.3 \ + d2i_OCSP_RESPONSE.3 \ d2i_PKCS12.3 \ d2i_PKCS7.3 \ d2i_PKCS8PrivateKey_bio.3 \ diff --git a/lib/libcrypto/man/d2i_OCSP_REQUEST.3 b/lib/libcrypto/man/d2i_OCSP_REQUEST.3 new file mode 100644 index 00000000000..3f6320a1558 --- /dev/null +++ b/lib/libcrypto/man/d2i_OCSP_REQUEST.3 @@ -0,0 +1,177 @@ +.\" $OpenBSD: d2i_OCSP_REQUEST.3,v 1.1 2016/12/27 22:06:55 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: December 27 2016 $ +.Dt D2I_OCSP_REQUEST 3 +.Os +.Sh NAME +.Nm d2i_OCSP_REQUEST , +.Nm i2d_OCSP_REQUEST , +.Nm d2i_OCSP_SIGNATURE , +.Nm i2d_OCSP_SIGNATURE , +.Nm d2i_OCSP_REQINFO , +.Nm i2d_OCSP_REQINFO , +.Nm d2i_OCSP_ONEREQ , +.Nm i2d_OCSP_ONEREQ , +.Nm d2i_OCSP_CERTID , +.Nm i2d_OCSP_CERTID , +.Nm d2i_OCSP_SERVICELOC , +.Nm i2d_OCSP_SERVICELOC +.Nd decode and encode OCSP requests +.Sh SYNOPSIS +.In openssl/ocsp.h +.Ft OCSP_REQUEST * +.Fo d2i_OCSP_REQUEST +.Fa "OCSP_REQUEST **val_out" +.Fa "const unsigned char **der_in" +.Fa "long length" +.Fc +.Ft int +.Fo i2d_OCSP_REQUEST +.Fa "OCSP_REQUEST *val_in" +.Fa "unsigned char **der_out" +.Fc +.Ft OCSP_SIGNATURE * +.Fo d2i_OCSP_SIGNATURE +.Fa "OCSP_SIGNATURE **val_out" +.Fa "const unsigned char **der_in" +.Fa "long length" +.Fc +.Ft int +.Fo i2d_OCSP_SIGNATURE +.Fa "OCSP_SIGNATURE *val_in" +.Fa "unsigned char **der_out" +.Fc +.Ft OCSP_REQINFO * +.Fo d2i_OCSP_REQINFO +.Fa "OCSP_REQINFO **val_out" +.Fa "const unsigned char **der_in" +.Fa "long length" +.Fc +.Ft int +.Fo i2d_OCSP_REQINFO +.Fa "OCSP_REQINFO *val_in" +.Fa "unsigned char **der_out" +.Fc +.Ft OCSP_ONEREQ * +.Fo d2i_OCSP_ONEREQ +.Fa "OCSP_ONEREQ **val_out" +.Fa "const unsigned char **der_in" +.Fa "long length" +.Fc +.Ft int +.Fo i2d_OCSP_ONEREQ +.Fa "OCSP_ONEREQ *val_in" +.Fa "unsigned char **der_out" +.Fc +.Ft OCSP_CERTID * +.Fo d2i_OCSP_CERTID +.Fa "OCSP_CERTID **val_out" +.Fa "const unsigned char **der_in" +.Fa "long length" +.Fc +.Ft int +.Fo i2d_OCSP_CERTID +.Fa "OCSP_CERTID *val_in" +.Fa "unsigned char **der_out" +.Fc +.Ft OCSP_SERVICELOC * +.Fo d2i_OCSP_SERVICELOC +.Fa "OCSP_SERVICELOC **val_out" +.Fa "const unsigned char **der_in" +.Fa "long length" +.Fc +.Ft int +.Fo i2d_OCSP_SERVICELOC +.Fa "OCSP_SERVICELOC *val_in" +.Fa "unsigned char **der_out" +.Fc +.Sh DESCRIPTION +Theses functions decode and encode ASN.1 structures used for OCSP +requests. +For details about the semantics, examples, caveats, and bugs, see +.Xr ASN1_item_d2i 3 . +.Pp +.Fn d2i_OCSP_REQUEST +and +.Fn i2d_OCSP_REQUEST +decode and encode an ASN.1 +.Vt OCSPRequest +structure defined in RFC 6960 section 4.1.1. +.Pp +.Fn d2i_OCSP_SIGNATURE +and +.Fn i2d_OCSP_SIGNATURE +decode and encode an ASN.1 +.Vt Signature +structure defined in RFC 6960 section 4.1.1. +.Pp +.Fn d2i_OCSP_REQINFO +and +.Fn i2d_OCSP_REQINFO +decode and encode an ASN.1 +.Vt TBSRequest +structure defined in RFC 6960 section 4.1.1. +.Pp +.Fn d2i_OCSP_ONEREQ +and +.Fn i2d_OCSP_ONEREQ +decode and encode an ASN.1 +.Vt Request +structure defined in RFC 6960 section 4.1.1. +.Pp +.Fn d2i_OCSP_CERTID +and +.Fn i2d_OCSP_CERTID +decode and encode an ASN.1 +.Vt CertID +structure defined in RFC 6960 section 4.1.1. +.Pp +.Fn d2i_OCSP_SERVICELOC +and +.Fn i2d_OCSP_SERVICELOC +decode and encode an ASN.1 +.Vt ServiceLocator +structure defined in RFC 6960 section 4.4.6. +.Sh RETURN VALUES +.Fn d2i_OCSP_REQUEST , +.Fn d2i_OCSP_SIGNATURE , +.Fn d2i_OCSP_REQINFO , +.Fn d2i_OCSP_ONEREQ , +.Fn d2i_OCSP_CERTID , +and +.Fn d2i_OCSP_SERVICELOC +return an object of the respective type or +.Dv NULL +if an error occurs. +.Pp +.Fn i2d_OCSP_REQUEST , +.Fn i2d_OCSP_SIGNATURE , +.Fn i2d_OCSP_REQINFO , +.Fn i2d_OCSP_ONEREQ , +.Fn i2d_OCSP_CERTID , +and +.Fn i2d_OCSP_SERVICELOC +return the number of bytes successfully encoded or a negative value +if an error occurs. +.Sh SEE ALSO +.Xr ASN1_item_d2i 3 , +.Xr OCSP_CERTID_new 3 , +.Xr OCSP_REQUEST_new 3 , +.Xr OCSP_SERVICELOC_new 3 +.Sh STANDARDS +RFC 6960: X.509 Internet Public Key Infrastructure Online Certificate +Status Protocol, section 4.1: Request Syntax diff --git a/lib/libcrypto/man/d2i_OCSP_RESPONSE.3 b/lib/libcrypto/man/d2i_OCSP_RESPONSE.3 new file mode 100644 index 00000000000..bdc54913d16 --- /dev/null +++ b/lib/libcrypto/man/d2i_OCSP_RESPONSE.3 @@ -0,0 +1,243 @@ +.\" $OpenBSD: d2i_OCSP_RESPONSE.3,v 1.1 2016/12/27 22:06:55 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: December 27 2016 $ +.Dt D2I_OCSP_RESPONSE 3 +.Os +.Sh NAME +.Nm d2i_OCSP_RESPONSE , +.Nm i2d_OCSP_RESPONSE , +.Nm d2i_OCSP_RESPBYTES , +.Nm i2d_OCSP_RESPBYTES , +.Nm d2i_OCSP_BASICRESP , +.Nm i2d_OCSP_BASICRESP , +.Nm d2i_OCSP_RESPDATA , +.Nm i2d_OCSP_RESPDATA , +.Nm d2i_OCSP_RESPID , +.Nm i2d_OCSP_RESPID , +.Nm d2i_OCSP_SINGLERESP , +.Nm i2d_OCSP_SINGLERESP , +.Nm d2i_OCSP_CERTSTATUS , +.Nm i2d_OCSP_CERTSTATUS , +.Nm d2i_OCSP_REVOKEDINFO , +.Nm i2d_OCSP_REVOKEDINFO , +.Nm d2i_OCSP_CRLID , +.Nm i2d_OCSP_CRLID +.Nd decode and encode OCSP responses +.Sh SYNOPSIS +.In openssl/ocsp.h +.Ft OCSP_RESPONSE * +.Fo d2i_OCSP_RESPONSE +.Fa "OCSP_RESPONSE **val_out" +.Fa "const unsigned char **der_in" +.Fa "long length" +.Fc +.Ft int +.Fo i2d_OCSP_RESPONSE +.Fa "OCSP_RESPONSE *val_in" +.Fa "unsigned char **der_out" +.Fc +.Ft OCSP_RESPBYTES * +.Fo d2i_OCSP_RESPBYTES +.Fa "OCSP_RESPBYTES **val_out" +.Fa "const unsigned char **der_in" +.Fa "long length" +.Fc +.Ft int +.Fo i2d_OCSP_RESPBYTES +.Fa "OCSP_RESPBYTES *val_in" +.Fa "unsigned char **der_out" +.Fc +.Ft OCSP_BASICRESP * +.Fo d2i_OCSP_BASICRESP +.Fa "OCSP_BASICRESP **val_out" +.Fa "const unsigned char **der_in" +.Fa "long length" +.Fc +.Ft int +.Fo i2d_OCSP_BASICRESP +.Fa "OCSP_BASICRESP *val_in" +.Fa "unsigned char **der_out" +.Fc +.Ft OCSP_RESPDATA * +.Fo d2i_OCSP_RESPDATA +.Fa "OCSP_RESPDATA **val_out" +.Fa "const unsigned char **der_in" +.Fa "long length" +.Fc +.Ft int +.Fo i2d_OCSP_RESPDATA +.Fa "OCSP_RESPDATA *val_in" +.Fa "unsigned char **der_out" +.Fc +.Ft OCSP_RESPID * +.Fo d2i_OCSP_RESPID +.Fa "OCSP_RESPID **val_out" +.Fa "const unsigned char **der_in" +.Fa "long length" +.Fc +.Ft int +.Fo i2d_OCSP_RESPID +.Fa "OCSP_RESPID *val_in" +.Fa "unsigned char **der_out" +.Fc +.Ft OCSP_SINGLERESP * +.Fo d2i_OCSP_SINGLERESP +.Fa "OCSP_SINGLERESP **val_out" +.Fa "const unsigned char **der_in" +.Fa "long length" +.Fc +.Ft int +.Fo i2d_OCSP_SINGLERESP +.Fa "OCSP_SINGLERESP *val_in" +.Fa "unsigned char **der_out" +.Fc +.Ft OCSP_CERTSTATUS * +.Fo d2i_OCSP_CERTSTATUS +.Fa "OCSP_CERTSTATUS **val_out" +.Fa "const unsigned char **der_in" +.Fa "long length" +.Fc +.Ft int +.Fo i2d_OCSP_CERTSTATUS +.Fa "OCSP_CERTSTATUS *val_in" +.Fa "unsigned char **der_out" +.Fc +.Ft OCSP_REVOKEDINFO * +.Fo d2i_OCSP_REVOKEDINFO +.Fa "OCSP_REVOKEDINFO **val_out" +.Fa "const unsigned char **der_in" +.Fa "long length" +.Fc +.Ft int +.Fo i2d_OCSP_REVOKEDINFO +.Fa "OCSP_REVOKEDINFO *val_in" +.Fa "unsigned char **der_out" +.Fc +.Ft OCSP_CRLID * +.Fo d2i_OCSP_CRLID +.Fa "OCSP_CRLID **val_out" +.Fa "const unsigned char **der_in" +.Fa "long length" +.Fc +.Ft int +.Fo i2d_OCSP_CRLID +.Fa "OCSP_CRLID *val_in" +.Fa "unsigned char **der_out" +.Fc +.Sh DESCRIPTION +Theses functions decode and encode ASN.1 structures used for OCSP +responses. +For details about the semantics, examples, caveats, and bugs, see +.Xr ASN1_item_d2i 3 . +.Pp +.Fn d2i_OCSP_RESPONSE +and +.Fn i2d_OCSP_RESPONSE +decode and encode an ASN.1 +.Vt OCSPResponse +structure defined in RFC 6960 section 4.2.1. +.Pp +.Fn d2i_OCSP_RESPBYTES +and +.Fn i2d_OCSP_RESPBYTES +decode and encode an ASN.1 +.Vt ResponseBytes +structure defined in RFC 6960 section 4.2.1. +.Pp +.Fn d2i_OCSP_BASICRESP +and +.Fn i2d_OCSP_BASICRESP +decode and encode an ASN.1 +.Vt BasicOCSPResponse +structure defined in RFC 6960 section 4.2.1. +.Pp +.Fn d2i_OCSP_RESPDATA +and +.Fn i2d_OCSP_RESPDATA +decode and encode an ASN.1 +.Vt ResponseData +structure defined in RFC 6960 section 4.2.1. +.Pp +.Fn d2i_OCSP_RESPID +and +.Fn i2d_OCSP_RESPID +decode and encode an ASN.1 +.Vt ResponderID +structure defined in RFC 6960 section 4.2.1. +.Pp +.Fn d2i_OCSP_SINGLERESP +and +.Fn i2d_OCSP_SINGLERESP +decode and encode an ASN.1 +.Vt SingleResponse +structure defined in RFC 6960 section 4.2.1. +.Pp +.Fn d2i_OCSP_CERTSTATUS +and +.Fn i2d_OCSP_CERTSTATUS +decode and encode an ASN.1 +.Vt CertStatus +structure defined in RFC 6960 section 4.2.1. +.Pp +.Fn d2i_OCSP_REVOKEDINFO +and +.Fn i2d_OCSP_REVOKEDINFO +decode and encode an ASN.1 +.Vt RevokedInfo +structure defined in RFC 6960 section 4.2.1. +.Pp +.Fn d2i_OCSP_CRLID +and +.Fn i2d_OCSP_CRLID +decode and encode an ASN.1 +.Vt CrlID +structure defined in RFC 6960 section 4.4.2. +.Sh RETURN VALUES +.Fn d2i_OCSP_RESPONSE , +.Fn d2i_OCSP_RESPBYTES , +.Fn d2i_OCSP_BASICRESP , +.Fn d2i_OCSP_RESPDATA , +.Fn d2i_OCSP_RESPID , +.Fn d2i_OCSP_SINGLERESP , +.Fn d2i_OCSP_CERTSTATUS , +.Fn d2i_OCSP_REVOKEDINFO , +and +.Fn d2i_OCSP_CRLID +return an object of the respective type or +.Dv NULL +if an error occurs. +.Pp +.Fn i2d_OCSP_RESPONSE , +.Fn i2d_OCSP_RESPBYTES , +.Fn i2d_OCSP_BASICRESP , +.Fn i2d_OCSP_RESPDATA , +.Fn i2d_OCSP_RESPID , +.Fn i2d_OCSP_SINGLERESP , +.Fn i2d_OCSP_CERTSTATUS , +.Fn i2d_OCSP_REVOKEDINFO , +and +.Fn i2d_OCSP_CRLID +return the number of bytes successfully encoded or a negative value +if an error occurs. +.Sh SEE ALSO +.Xr ASN1_item_d2i 3 , +.Xr OCSP_CRLID_new 3 , +.Xr OCSP_RESPONSE_new 3 , +.Xr OCSP_SINGLERESP_new 3 +.Sh STANDARDS +RFC 6960: X.509 Internet Public Key Infrastructure Online Certificate +Status Protocol, section 4.2: Response Syntax |