From 6c86ad6dee6b6ead22bee41675b70e48b43b5ff6 Mon Sep 17 00:00:00 2001
From: Sean Parkinson <sean@wolfssl.com>
Date: Sat, 18 Jan 2025 04:07:54 +1000
Subject: [PATCH] Documentation: wolfSSL_BN_CTX_get() note

wolfSSL_BN_CTX_get() returns an object that must be freed.
This is different to BN_CTX_get() in OpenSSL.
---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index 2b6fdae5f0..9b4f1e9d65 100644
--- a/README.md
+++ b/README.md
@@ -74,6 +74,8 @@ macro `NO_OLD_SHA_NAMES`. These names get mapped to the OpenSSL API for a
 single call hash function. Instead the name `WC_SHA`, `WC_SHA256`, `WC_SHA384` and
 `WC_SHA512` should be used for the enum name.
 
+### Ntoe 4
+The function wolfSSL_BN_CTX_get() returns a new WOLFSSL_BIGNUM object. The object is not cached against the WOLFSSL_BN_CTX and must be freed by the application. This behavior is not consistent with BN_CTX_get() in OpenSSL.
 
 # wolfSSL Release 5.7.6 (Dec 31, 2024)