1 /* 2 * Copyright (c) 2019, The OpenThread Authors. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the copyright holder nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /** 30 * @file 31 * @brief 32 * This file defines the OpenThread cryptographic random number generator API. 33 */ 34 35 #ifndef OPENTHREAD_RANDOM_CRYPTO_H_ 36 #define OPENTHREAD_RANDOM_CRYPTO_H_ 37 38 #include <stdint.h> 39 40 #include <mbedtls/ctr_drbg.h> 41 #include <openthread/error.h> 42 43 #ifdef __cplusplus 44 extern "C" { 45 #endif 46 47 /** 48 * @addtogroup api-random-crypto 49 * 50 * @brief 51 * This module includes functions that generates cryptographic random numbers. 52 * 53 * @{ 54 * 55 */ 56 57 /** 58 * This function fills a given buffer with cryptographically secure random bytes. 59 * 60 * @param[out] aBuffer A pointer to a buffer to fill with the random bytes. 61 * @param[in] aSize Size of buffer (number of bytes to fill). 62 * 63 */ 64 otError otRandomCryptoFillBuffer(uint8_t *aBuffer, uint16_t aSize); 65 66 /** 67 * This function returns initialized mbedtls_ctr_drbg_context. 68 * 69 * @returns A pointer to initialized mbedtls_ctr_drbg_context. 70 */ 71 mbedtls_ctr_drbg_context *otRandomCryptoMbedTlsContextGet(void); 72 73 /** 74 * @} 75 * 76 */ 77 78 #ifdef __cplusplus 79 } // extern "C" 80 #endif 81 82 #endif // OPENTHREAD_RANDOM_CRYPTO_H_ 83