summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorPauli <paul.dale@oracle.com>2020-02-05 15:13:49 +1000
committerPauli <paul.dale@oracle.com>2020-02-06 16:22:00 +1000
commit8b6ffd40401bd3b78538cb8d496db0c6926185b0 (patch)
tree6329353eb7e6c01592b28898974ae2b8f2faaf9b /doc
parentb744f915ca8bb37631909728dd2529289bda8438 (diff)
Params: change UTF8 construct calls to avoid explicit strlen(3) calls.
It is better, safer and smaller to let the library routine handle the strlen(3) call. Added a note to the documentation suggesting this. Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/11019)
Diffstat (limited to 'doc')
-rw-r--r--doc/man3/OSSL_PARAM_int.pod4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/man3/OSSL_PARAM_int.pod b/doc/man3/OSSL_PARAM_int.pod
index 8d4aa90c6d..99e4fcf088 100644
--- a/doc/man3/OSSL_PARAM_int.pod
+++ b/doc/man3/OSSL_PARAM_int.pod
@@ -167,7 +167,9 @@ size B<rsize> is created.
OSSL_PARAM_construct_utf8_string() is a function that constructs a UTF8
string OSSL_PARAM structure.
A parameter with name B<key>, storage B<buf> and size B<bsize> is created.
-If B<bsize> is zero, the string length is determined using strlen(3).
+If B<bsize> is zero, the string length is determined using strlen(3) + 1 for the
+null termination byte.
+Generally pass zero for B<bsize> instead of calling strlen(3) yourself.
OSSL_PARAM_construct_octet_string() is a function that constructs an OCTET
string OSSL_PARAM structure.