bitcoin/src/support/cleanse.h

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2019 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#ifndef BITCOIN_SUPPORT_CLEANSE_H
#define BITCOIN_SUPPORT_CLEANSE_H

#include <stdlib.h>

/** Secure overwrite a buffer (possibly containing secret data) with zero-bytes. The write
 * operation will not be optimized out by the compiler. */
void memory_cleanse(void *ptr, size_t len);

#endif // BITCOIN_SUPPORT_CLEANSE_H
openssl: abstract out OPENSSL_cleanse This makes it easier for us to replace it if desired, since it's now only in one spot. Also, it avoids the openssl include from allocators.h, which essentially forced openssl to be included from every compilation unit. 2015-01-20 21:23:25 -03:00			`// Copyright (c) 2009-2010 Satoshi Nakamoto`
scripted-diff: Bump copyright of files changed in 2019 -BEGIN VERIFY SCRIPT- ./contrib/devtools/copyright_header.py update ./ -END VERIFY SCRIPT- 2019-12-30 06:39:22 -03:00			`// Copyright (c) 2009-2019 The Bitcoin Core developers`
openssl: abstract out OPENSSL_cleanse This makes it easier for us to replace it if desired, since it's now only in one spot. Also, it avoids the openssl include from allocators.h, which essentially forced openssl to be included from every compilation unit. 2015-01-20 21:23:25 -03:00			`// Distributed under the MIT software license, see the accompanying`
			`// file COPYING or http://www.opensource.org/licenses/mit-license.php.`

			`#ifndef BITCOIN_SUPPORT_CLEANSE_H`
			`#define BITCOIN_SUPPORT_CLEANSE_H`

			`#include <stdlib.h>`

Improve documentation of memory_cleanse() So far, the documentation of memory_cleanse() is a verbatim copy of the commit message in BoringSSL, where this code was originally written. However, our code evolved since then, and the commit message is not particularly helpful in the code but is rather of historical interested in BoringSSL only. This commit improves improves the comments around memory_cleanse() and gives a better rationale for the method that we use. This commit touches only comments. 2019-06-05 16:44:04 -04:00			`/** Secure overwrite a buffer (possibly containing secret data) with zero-bytes. The write`
			`* operation will not be optimized out by the compiler. */`
openssl: abstract out OPENSSL_cleanse This makes it easier for us to replace it if desired, since it's now only in one spot. Also, it avoids the openssl include from allocators.h, which essentially forced openssl to be included from every compilation unit. 2015-01-20 21:23:25 -03:00			`void memory_cleanse(void *ptr, size_t len);`

			`#endif // BITCOIN_SUPPORT_CLEANSE_H`