Commit 9e5aa174a6 for openssl.org
commit 9e5aa174a6fcb358f1aaf56ca20a65c42e3840fe
Author: Eugene Syromiatnikov <esyr@openssl.org>
Date: Wed Sep 23 03:18:49 2026 +0200
doc/man3/ASN1_STRING_length.pod: actually document ASN1_STRING_get_length()
It was mentioned in NAME and SYNOPSIS sections, but not in DESCRIPTION.
Rescind that omission.
Complements: 28179061bfcd "Prepare a now opaque ASN1_STRING for the size_t rapture."
Signed-off-by: Eugene Syromiatnikov <esyr@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.foundation>
Reviewed-by: Nikola Pajkovsky <nikolap@openssl.org>
Merge-date: Tue Nov 10 15:07:00 2026
Merged-from: https://github.com/openssl/openssl/pull/32937
diff --git a/doc/man3/ASN1_STRING_length.pod b/doc/man3/ASN1_STRING_length.pod
index be24b57357..9bce95060b 100644
--- a/doc/man3/ASN1_STRING_length.pod
+++ b/doc/man3/ASN1_STRING_length.pod
@@ -59,7 +59,13 @@ see L<openssl_user_macros(7)>:
These functions allow an B<ASN1_STRING> structure to be manipulated.
-ASN1_STRING_length() returns the length of the content of I<x>. I<x> B<MUST NOT> be NULL.
+ASN1_STRING_length() returns the length of the content of I<x>.
+I<x> B<MUST NOT> be NULL.
+
+ASN1_STRING_get_length() returns the length of the content of I<x>.
+I<x> B<MUST NOT> be NULL. If the current length of the content of I<x>
+cannot be represented by a value of type B<size_t> (for example, after
+an ASN1_STRING_length_set() call with a negative I<n> argument), 0 is returned.
ASN1_STRING_get0_data() returns an internal pointer to the data of I<x>.
Since this is an internal pointer it should B<not> be freed or
@@ -167,6 +173,9 @@ length and not rely on NUL termination.
ASN1_STRING_length() returns the length of the content of I<x>.
+ASN1_STRING_get_length() returns the length of the content of I<x> or 0,
+if it cannot be represented as a value of type B<size_t>.
+
ASN1_STRING_get0_data() returns an internal pointer to
the data of I<x>.