diff options
| author | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2022-11-25 12:08:42 +0100 |
|---|---|---|
| committer | Dr. David von Oheimb <dev@ddvo.net> | 2023-01-23 10:56:55 +0100 |
| commit | de107d4c94bf1167faf4c723d4b0a7b15ba0a861 (patch) | |
| tree | ed1ab0024901955e4a9606210490acbea29b203b /doc | |
| parent | de1ce231ab35b677dd0af9ecef01470732975ebf (diff) | |
CMP docs: clarify behavior on message/total timeout values given
Clarify behavior of OSSL_CMP_CTX_set_option() when given (negative)
values for OSSL_CMP_OPT_MSG_TIMEOUT or OSSL_CMP_OPT_TOTAL_TIMEOUT.
Fix doc of -msg_timeout and -total_timeout in openssl-cmp.pod.in
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: David von Oheimb <david.von.oheimb@siemens.com>
(Merged from https://github.com/openssl/openssl/pull/19391)
(cherry picked from commit 5acd4007a0646ef1f9d0015ce438b891d1b24a62)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man1/openssl-cmp.pod.in | 10 | ||||
| -rw-r--r-- | doc/man3/OSSL_CMP_CTX_new.pod | 13 |
2 files changed, 14 insertions, 9 deletions
diff --git a/doc/man1/openssl-cmp.pod.in b/doc/man1/openssl-cmp.pod.in index ae88053e68..1bf075c66b 100644 --- a/doc/man1/openssl-cmp.pod.in +++ b/doc/man1/openssl-cmp.pod.in @@ -503,15 +503,17 @@ The default value is 1, which means preferring to keep the connection open. =item B<-msg_timeout> I<seconds> -Number of seconds (or 0 for infinite) a CMP request-response message round trip +Number of seconds a CMP request-response message round trip is allowed to take before a timeout error is returned. +A value <= 0 means no limitation (waiting indefinitely). Default is to use the B<-total_timeout> setting. =item B<-total_timeout> I<seconds> -Maximum number seconds an overall enrollment transaction may take, -including attempts polling for certificates on C<waiting> PKIStatus. -Default is 0 (infinite). +Maximum total number of seconds a transaction may take, +including polling etc. +A value <= 0 means no limitation (waiting indefinitely). +Default is 0. =back diff --git a/doc/man3/OSSL_CMP_CTX_new.pod b/doc/man3/OSSL_CMP_CTX_new.pod index fd4998f2df..9a5932019f 100644 --- a/doc/man3/OSSL_CMP_CTX_new.pod +++ b/doc/man3/OSSL_CMP_CTX_new.pod @@ -208,14 +208,17 @@ The following options can be set: =item B<OSSL_CMP_OPT_MSG_TIMEOUT> - Number of seconds (or 0 for infinite) a CMP message round trip is - allowed to take before a timeout error is returned. - Default is to use the B<OSSL_CMP_OPT_MSG_TIMEOUT> setting. + Number of seconds a CMP request-response message round trip + is allowed to take before a timeout error is returned. + A value <= 0 means no limitation (waiting indefinitely). + Default is to use the B<OSSL_CMP_OPT_TOTAL_TIMEOUT> setting. =item B<OSSL_CMP_OPT_TOTAL_TIMEOUT> - Maximum total number of seconds an enrollment (including polling) - may take. Default is 0 (infinite). + Maximum total number of seconds a transaction may take, + including polling etc. + A value <= 0 means no limitation (waiting indefinitely). + Default is 0. =item B<OSSL_CMP_OPT_VALIDITY_DAYS> |