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.
wolfSSL · Jan 17, 2025 · 6c86ad6 · 6c86ad6
1 parent e76186f
commit 6c86ad6
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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)