Make BUF_strndup() read-safe on arbitrary inputs

[openssl.git] / include / openssl / buffer.h

diff --git a/include/openssl/buffer.h b/include/openssl/buffer.h
index af30a90b865a78d9d92b0eb2fb703f6457a921d3..61cff9ca36e09a75101729a0489fd3f38efae739 100644 (file)
--- a/include/openssl/buffer.h
+++ b/include/openssl/buffer.h
@@ -90,7 +90,13 @@ size_t BUF_MEM_grow(BUF_MEM *str, size_t len);
 size_t BUF_MEM_grow_clean(BUF_MEM *str, size_t len);
 size_t BUF_strnlen(const char *str, size_t maxlen);
 char *BUF_strdup(const char *str);
+
+/*
+ * Returns a pointer to a new string which is a duplicate of the string |str|,
+ * but guarantees to never read past the first |siz| bytes of |str|.
+ */
 char *BUF_strndup(const char *str, size_t siz);
+
 void *BUF_memdup(const void *data, size_t siz);
 void BUF_reverse(unsigned char *out, unsigned char *in, size_t siz);