reactos/sdk/include/reactos/libs/mbedtls/entropy_poll.h

   1 /**
   2  * \file entropy_poll.h
   3  *
   4  * \brief Platform-specific and custom entropy polling functions
   5  *
   6  *  Copyright (C) 2006-2016, ARM Limited, All Rights Reserved
   7  *  SPDX-License-Identifier: GPL-2.0
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; either version 2 of the License, or
  12  *  (at your option) any later version.
  13  *
  14  *  This program is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *  GNU General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License along
  20  *  with this program; if not, write to the Free Software Foundation, Inc.,
  21  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22  *
  23  *  This file is part of mbed TLS (https://tls.mbed.org)
  24  */
  25 #ifndef MBEDTLS_ENTROPY_POLL_H
  26 #define MBEDTLS_ENTROPY_POLL_H
  27
  28 #if !defined(MBEDTLS_CONFIG_FILE)
  29 #include "config.h"
  30 #else
  31 #include MBEDTLS_CONFIG_FILE
  32 #endif
  33
  34 #include <stddef.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /*
  41  * Default thresholds for built-in sources, in bytes
  42  */
  43 #define MBEDTLS_ENTROPY_MIN_PLATFORM     32     /**< Minimum for platform source    */
  44 #define MBEDTLS_ENTROPY_MIN_HAVEGE       32     /**< Minimum for HAVEGE             */
  45 #define MBEDTLS_ENTROPY_MIN_HARDCLOCK     4     /**< Minimum for mbedtls_timing_hardclock()        */
  46 #if !defined(MBEDTLS_ENTROPY_MIN_HARDWARE)
  47 #define MBEDTLS_ENTROPY_MIN_HARDWARE     32     /**< Minimum for the hardware source */
  48 #endif
  49
  50 /**
  51  * \brief           Entropy poll callback that provides 0 entropy.
  52  */
  53 #if defined(MBEDTLS_TEST_NULL_ENTROPY)
  54     int mbedtls_null_entropy_poll( void *data,
  55                                 unsigned char *output, size_t len, size_t *olen );
  56 #endif
  57
  58 #if !defined(MBEDTLS_NO_PLATFORM_ENTROPY)
  59 /**
  60  * \brief           Platform-specific entropy poll callback
  61  */
  62 int mbedtls_platform_entropy_poll( void *data,
  63                            unsigned char *output, size_t len, size_t *olen );
  64 #endif
  65
  66 #if defined(MBEDTLS_HAVEGE_C)
  67 /**
  68  * \brief           HAVEGE based entropy poll callback
  69  *
  70  * Requires an HAVEGE state as its data pointer.
  71  */
  72 int mbedtls_havege_poll( void *data,
  73                  unsigned char *output, size_t len, size_t *olen );
  74 #endif
  75
  76 #if defined(MBEDTLS_TIMING_C)
  77 /**
  78  * \brief           mbedtls_timing_hardclock-based entropy poll callback
  79  */
  80 int mbedtls_hardclock_poll( void *data,
  81                     unsigned char *output, size_t len, size_t *olen );
  82 #endif
  83
  84 #if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
  85 /**
  86  * \brief           Entropy poll callback for a hardware source
  87  *
  88  * \warning         This is not provided by mbed TLS!
  89  *                  See \c MBEDTLS_ENTROPY_HARDWARE_ALT in config.h.
  90  *
  91  * \note            This must accept NULL as its first argument.
  92  */
  93 int mbedtls_hardware_poll( void *data,
  94                            unsigned char *output, size_t len, size_t *olen );
  95 #endif
  96
  97 #if defined(MBEDTLS_ENTROPY_NV_SEED)
  98 /**
  99  * \brief           Entropy poll callback for a non-volatile seed file
 100  *
 101  * \note            This must accept NULL as its first argument.
 102  */
 103 int mbedtls_nv_seed_poll( void *data,
 104                           unsigned char *output, size_t len, size_t *olen );
 105 #endif
 106
 107 #ifdef __cplusplus
 108 }
 109 #endif
 110
 111 #endif /* entropy_poll.h */