summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTheo Buehler <tb@cvs.openbsd.org>2018-07-23 18:30:30 +0000
committerTheo Buehler <tb@cvs.openbsd.org>2018-07-23 18:30:30 +0000
commite8cd273bceec2a8d4a1b11daf5e7983a4bba8e1f (patch)
tree21b25960ac916284c7ed08d16894468372b62f76
parentcac2951dab8eb4cbb425aa6dc48697f714c6a69e (diff)
Document tls_peer_ocsp_result() and use it in place of the non-existent
tls_peer_ocsp_result_msg() in the documentation. input & ok jsing Reads fine to jmc and makes sense to schwarze
-rw-r--r--lib/libtls/man/tls_ocsp_process_response.318
1 files changed, 12 insertions, 6 deletions
diff --git a/lib/libtls/man/tls_ocsp_process_response.3 b/lib/libtls/man/tls_ocsp_process_response.3
index cb979e80881..b40e9a02d56 100644
--- a/lib/libtls/man/tls_ocsp_process_response.3
+++ b/lib/libtls/man/tls_ocsp_process_response.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: tls_ocsp_process_response.3,v 1.4 2017/01/29 18:00:21 beck Exp $
+.\" $OpenBSD: tls_ocsp_process_response.3,v 1.5 2018/07/23 18:30:29 tb Exp $
.\"
.\" Copyright (c) 2016 Bob Beck <beck@openbsd.org>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: January 29 2017 $
+.Dd $Mdocdate: July 23 2018 $
.Dt TLS_OCSP_PROCESS_RESPONSE 3
.Os
.Sh NAME
@@ -23,7 +23,7 @@
.Nm tls_peer_ocsp_crl_reason ,
.Nm tls_peer_ocsp_next_update ,
.Nm tls_peer_ocsp_response_status ,
-.Nm tls_peer_ocsp_result_msg ,
+.Nm tls_peer_ocsp_result ,
.Nm tls_peer_ocsp_revocation_time ,
.Nm tls_peer_ocsp_this_update ,
.Nm tls_peer_ocsp_url
@@ -45,7 +45,7 @@
.Ft int
.Fn tls_peer_ocsp_response_status "struct tls *ctx"
.Ft const char *
-.Fn tls_peer_ocsp_result_msg "struct tls *ctx"
+.Fn tls_peer_ocsp_result "struct tls *ctx"
.Ft time_t
.Fn tls_peer_ocsp_revocation_time "struct tls *ctx"
.Ft time_t
@@ -86,7 +86,13 @@ returns the OCSP next update time.
.Fn tls_peer_ocsp_response_status
returns the OCSP response status as per RFC 6960 section 2.3.
.Pp
-.\" XXX Fn tls_peer_ocsp_result_msg does what?
+.Fn tls_peer_ocsp_result
+returns a string indicating the OCSP status.
+If the OCSP response was valid and the certificate was not
+revoked, the string indicates the OCSP certificate status.
+Otherwise, the string indicates
+the OCSP certificate revocation reason or the OCSP error.
+.Pp
.Fn tls_peer_ocsp_revocation_time
returns the OCSP revocation time.
.Pp
@@ -139,7 +145,7 @@ and
.Fn tls_peer_ocsp_this_update
return a time in epoch-seconds on success or -1 on error.
.Pp
-.Fn tls_peer_ocsp_result_msg
+.Fn tls_peer_ocsp_result
and
.Fn tls_peer_ocsp_url
return