OPENSSL_SECURE_MALLOC(3ossl)
π OPENSSL_SECURE_MALLOC π
okay so bestie, welcome to OPENSSL_SECURE_MALLOC(3ossl) β the page about secure heap storage and honestly? it's giving VIP lounge energy πβ¨
the whole squad on this page is: CRYPTO_secure_malloc_init, CRYPTO_secure_malloc_initialized, CRYPTO_secure_malloc_done, OPENSSL_secure_malloc, CRYPTO_secure_malloc, OPENSSL_secure_zalloc, CRYPTO_secure_zalloc, OPENSSL_secure_free, CRYPTO_secure_free, OPENSSL_secure_clear_free, CRYPTO_secure_clear_free, OPENSSL_secure_actual_size, CRYPTO_secure_allocated, CRYPTO_secure_used. yeah that's a lot of besties, we'll get to all of them π
πΈ SYNOPSIS πΈ
#include <openssl/crypto.h>
int CRYPTO_secure_malloc_init(size_t size, size_t minsize);
int CRYPTO_secure_malloc_initialized();
int CRYPTO_secure_malloc_done();
void *OPENSSL_secure_malloc(size_t num);
void *CRYPTO_secure_malloc(size_t num, const char *file, int line);
void *OPENSSL_secure_zalloc(size_t num);
void *CRYPTO_secure_zalloc(size_t num, const char *file, int line);
void OPENSSL_secure_free(void* ptr);
void CRYPTO_secure_free(void *ptr, const char *, int);
void OPENSSL_secure_clear_free(void* ptr, size_t num);
void CRYPTO_secure_clear_free(void *ptr, size_t num, const char *, int);
size_t OPENSSL_secure_actual_size(const void *ptr);
int CRYPTO_secure_allocated(const void *ptr);
size_t CRYPTO_secure_used();
π¦ DESCRIPTION π¦
so like, the whole point here? protecting applications (especially long-running servers, the ones that just never sleep π) from pointer overruns or underruns β you know, the kind of chaos that could hand back arbitrary data from the program's dynamic memory area, which is exactly where keys and other sensitive info might be chillin'. OpenSSL supports the concept of a "secure heap." π
ngl though, the level and type of security guarantees depend on the operating system. so it's a genuinely good idea to review the code and see if it actually addresses your threat model and concerns. do your research bestie, no cap π
also, real talk: the secure heap uses a single read/write lock, which means any operations that involve allocation or freeing of secure heap memory are serialised, and that blocks other threads. with that in mind, highly concurrent applications should enable the secure heap with caution and be aware of the performance implications for multi-threaded code. π
if a secure heap is used, then private key BIGNUM values are stored there. that protects long-term storage of private keys, but it will not necessarily put all intermediate values and computations there. important distinction, don't skip it π«Ά
CRYPTO_secure_malloc_init()β creates the secure heap, with the specifiedsizein bytes. theminsizeparameter is the minimum size to allocate from the heap, or zero to use a reasonable default value. bothsizeand, if specified,minsizemust be a power of two, andminsizeshould generally be small β for example16or32. andminsizemust be less than a quarter ofsizein any case. rules are rules πCRYPTO_secure_malloc_initialized()β indicates whether or not the secure heap has been initialized and is available. vibe check for the heap β¨CRYPTO_secure_malloc_done()β releases the heap and makes the memory unavailable to the process if all secure memory has been freed. heads up: it can take noticeably long to complete. like, go make a snack long πOPENSSL_secure_malloc()β allocatesnumbytes from the heap. ifCRYPTO_secure_malloc_init()is not called, this is equivalent to callingOPENSSL_malloc(). it's a macro that expands toCRYPTO_secure_malloc()and adds the__FILE__and__LINE__parameters. sneaky but iconic πOPENSSL_secure_zalloc()andCRYPTO_secure_zalloc()β likeOPENSSL_secure_malloc()andCRYPTO_secure_malloc(), respectively, except that they callmemset()to zero the memory before returning. clean slate behavior π§OPENSSL_secure_free()β releases the memory atptrback to the heap. it must be called with a value previously obtained fromOPENSSL_secure_malloc(). ifCRYPTO_secure_malloc_init()is not called, this is equivalent to callingOPENSSL_free(). it exists for consistency withOPENSSL_secure_malloc(), and is a macro that expands toCRYPTO_secure_free()and adds the__FILE__and__LINE__parameters. if the argument toOPENSSL_secure_free()isNULL, nothing is done. no drama, no crash πOPENSSL_secure_clear_free()β similar toOPENSSL_secure_free()except that it has an additionalnumparameter which is used to clear the memory if it was not allocated from the secure heap. ifCRYPTO_secure_malloc_init()is not called, this is equivalent to callingOPENSSL_clear_free(). if the argument toOPENSSL_secure_clear_free()isNULL, nothing is done. bye bye data, securely πOPENSSL_secure_actual_size()β tells the actual size allocated to the pointer. implementations may allocate more space than initially requested, in order to "round up" and reduce secure heap fragmentation. it's not lying to you, it's just rounding up for the aesthetic πOPENSSL_secure_allocated()β tells if a pointer is allocated in the secure heap. yes/no, in or out ποΈCRYPTO_secure_used()β returns the number of bytes allocated in the secure heap. the receipt π§Ύ
β¨ RETURN VALUES β¨
CRYPTO_secure_malloc_init()returns0on failure,1if successful, and2if successful but the heap could not be protected by memory mapping. yeah, three possible outcomes, keep up πCRYPTO_secure_malloc_initialized()returns1if the secure heap is available (that is, ifCRYPTO_secure_malloc_init()has been called, butCRYPTO_secure_malloc_done()has not been called or failed) or0if not.OPENSSL_secure_malloc()andOPENSSL_secure_zalloc()return a pointer into the secure heap of the requested size, orNULLif memory could not be allocated.CRYPTO_secure_allocated()returns1if the pointer is in the secure heap, or0if not.CRYPTO_secure_malloc_done()returns1if the secure memory area is released, or0if not.OPENSSL_secure_free()andOPENSSL_secure_clear_free()return no values. they just do the thing π
π SEE ALSO π
π HISTORY π
- The
OPENSSL_secure_clear_free()function was added in OpenSSL 1.1.0g. throwback π - The second argument to
CRYPTO_secure_malloc_init()was changed from anintto asize_tin OpenSSL 3.0. glow up β¨
π COPYRIGHT π
Copyright 2015-2025 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.
and that's the whole page bestie, we ate and left no crumbs π½οΈπ this was version 3.5.9, dated 2026-09-29 β go forth and secure-heap responsibly, mwah π
π¦ where this page comes from
- fedora 43: openssl-devel 1:3.5.9-1.fc43 Β· Apache-2.0
- fedora 43: openssl-devel 1:3.5.9-1.fc43 Β· Apache-2.0
- fedora 44: openssl-devel 1:3.5.9-1.fc44 Β· Apache-2.0
- fedora 44: openssl-devel 1:3.5.9-1.fc44 Β· Apache-2.0
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms