aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDr. David von Oheimb <David.von.Oheimb@siemens.com>2021-06-23 14:47:57 +0200
committerDr. David von Oheimb <dev@ddvo.net>2021-06-25 07:44:50 +0200
commit991519aeb99b41e2239b20a254535436cad39553 (patch)
treee0872fbc32ce7e9767a01969159f6b0fe26b046f /doc
parentcfd854a55e45626dd094f5d3846fd56fb4ec3cbf (diff)
downloadopenssl-991519aeb99b41e2239b20a254535436cad39553.zip
openssl-991519aeb99b41e2239b20a254535436cad39553.tar.gz
openssl-991519aeb99b41e2239b20a254535436cad39553.tar.bz2
CMP: Improve reporting of error codes and related strings via 'error' msg
Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/15879)
Diffstat (limited to 'doc')
-rw-r--r--doc/internal/man3/ossl_cmp_certreq_new.pod9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/internal/man3/ossl_cmp_certreq_new.pod b/doc/internal/man3/ossl_cmp_certreq_new.pod
index ced9f01..05530da 100644
--- a/doc/internal/man3/ossl_cmp_certreq_new.pod
+++ b/doc/internal/man3/ossl_cmp_certreq_new.pod
@@ -38,7 +38,7 @@ ossl_cmp_error_new
OSSL_CMP_MSG *ossl_cmp_genm_new(OSSL_CMP_CTX *ctx);
OSSL_CMP_MSG *ossl_cmp_genp_new(OSSL_CMP_CTX *ctx);
OSSL_CMP_MSG *ossl_cmp_error_new(OSSL_CMP_CTX *ctx, const OSSL_CMP_PKISI *si,
- int errorCode, const char *details,
+ int64_t errorCode, const char *details,
int unprotected);
=head1 DESCRIPTION
@@ -141,8 +141,11 @@ ossl_cmp_genm_new() creates a new General Message with an empty ITAV stack.
ossl_cmp_genp_new() creates a new General Response with an empty ITAV stack.
ossl_cmp_error_new() creates a new Error Message with the given contents
-with the given I<si>, I<errorCode> (if nonnegative), and optional I<details>.
-It does not protect the message if I<unprotectedErrors> is nonzero.
+I<si>, I<errorCode>, and optional I<details>.
+If I<errorCode> is positive and in the range of an OpenSSL error code,
+the library and reason strings are included in the B<errorDetails> field.
+If given, the I<details> are added to the contents of the B<errorDetails> field.
+The function does not protect the message if I<unprotectedErrors> is nonzero.
=head1 NOTES