blob: 4f7b55cf7b8468631bc9f3c39c624027418ecf39 [file] [log] [blame]
Ronald Cronb7eb67f2020-06-09 16:57:42 +02001/**
2 * \file random.h
3 *
4 * \brief This file contains the prototypes of helper functions to generate
5 * random numbers for the purpose of testing.
6 */
7
Bence Szépkúti86974652020-06-15 11:59:37 +02008/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02009 * Copyright The Mbed TLS Contributors
Ronald Cronb7eb67f2020-06-09 16:57:42 +020010 * SPDX-License-Identifier: Apache-2.0
11 *
12 * Licensed under the Apache License, Version 2.0 (the "License"); you may
13 * not use this file except in compliance with the License.
14 * You may obtain a copy of the License at
15 *
16 * http://www.apache.org/licenses/LICENSE-2.0
17 *
18 * Unless required by applicable law or agreed to in writing, software
19 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
20 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 * See the License for the specific language governing permissions and
22 * limitations under the License.
Ronald Cronb7eb67f2020-06-09 16:57:42 +020023 */
24
25#ifndef TEST_RANDOM_H
26#define TEST_RANDOM_H
27
28#if !defined(MBEDTLS_CONFIG_FILE)
29#include "mbedtls/config.h"
30#else
31#include MBEDTLS_CONFIG_FILE
32#endif
33
Ronald Cron2058d562020-06-09 17:11:47 +020034#include <stddef.h>
35#include <stdint.h>
36
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010037typedef struct {
Gilles Peskinebef30192021-03-24 00:48:57 +010038 unsigned char *buf; /* Pointer to a buffer of length bytes. */
Ronald Cron2058d562020-06-09 17:11:47 +020039 size_t length;
Gilles Peskinebef30192021-03-24 00:48:57 +010040 /* If fallback_f_rng is NULL, fail after delivering length bytes. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010041 int (*fallback_f_rng)(void *, unsigned char *, size_t);
Gilles Peskinebef30192021-03-24 00:48:57 +010042 void *fallback_p_rng;
Ronald Cron351f0ee2020-06-10 12:12:18 +020043} mbedtls_test_rnd_buf_info;
Ronald Cron2058d562020-06-09 17:11:47 +020044
45/**
46 * Info structure for the pseudo random function
47 *
48 * Key should be set at the start to a test-unique value.
49 * Do not forget endianness!
50 * State( v0, v1 ) should be set to zero.
51 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010052typedef struct {
Ronald Cron2058d562020-06-09 17:11:47 +020053 uint32_t key[16];
54 uint32_t v0, v1;
Ronald Cron351f0ee2020-06-10 12:12:18 +020055} mbedtls_test_rnd_pseudo_info;
Ronald Cron2058d562020-06-09 17:11:47 +020056
57/**
58 * This function just returns data from rand().
59 * Although predictable and often similar on multiple
60 * runs, this does not result in identical random on
61 * each run. So do not use this if the results of a
62 * test depend on the random data that is generated.
63 *
64 * rng_state shall be NULL.
65 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010066int mbedtls_test_rnd_std_rand(void *rng_state,
67 unsigned char *output,
68 size_t len);
Ronald Cron2058d562020-06-09 17:11:47 +020069
70/**
Gilles Peskineebf3a4b2021-03-24 00:14:53 +010071 * This function only returns zeros.
Ronald Cron2058d562020-06-09 17:11:47 +020072 *
Gilles Peskineebf3a4b2021-03-24 00:14:53 +010073 * \p rng_state shall be \c NULL.
Ronald Cron2058d562020-06-09 17:11:47 +020074 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010075int mbedtls_test_rnd_zero_rand(void *rng_state,
76 unsigned char *output,
77 size_t len);
Ronald Cron2058d562020-06-09 17:11:47 +020078
79/**
Gilles Peskineebf3a4b2021-03-24 00:14:53 +010080 * This function returns random data based on a buffer it receives.
Ronald Cron2058d562020-06-09 17:11:47 +020081 *
Gilles Peskineebf3a4b2021-03-24 00:14:53 +010082 * \p rng_state shall be a pointer to a #mbedtls_test_rnd_buf_info structure.
Ronald Cron2058d562020-06-09 17:11:47 +020083 *
84 * The number of bytes released from the buffer on each call to
Gilles Peskineb72b7e62021-06-02 21:17:36 +020085 * the random function is specified by \p len.
Ronald Cron2058d562020-06-09 17:11:47 +020086 *
Gilles Peskinebef30192021-03-24 00:48:57 +010087 * After the buffer is empty, this function will call the fallback RNG in the
88 * #mbedtls_test_rnd_buf_info structure if there is one, and
89 * will return #MBEDTLS_ERR_ENTROPY_SOURCE_FAILED otherwise.
Ronald Cron2058d562020-06-09 17:11:47 +020090 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010091int mbedtls_test_rnd_buffer_rand(void *rng_state,
92 unsigned char *output,
93 size_t len);
Ronald Cron2058d562020-06-09 17:11:47 +020094
95/**
96 * This function returns random based on a pseudo random function.
97 * This means the results should be identical on all systems.
98 * Pseudo random is based on the XTEA encryption algorithm to
99 * generate pseudorandom.
100 *
Gilles Peskineebf3a4b2021-03-24 00:14:53 +0100101 * \p rng_state shall be a pointer to a #mbedtls_test_rnd_pseudo_info structure.
Ronald Cron2058d562020-06-09 17:11:47 +0200102 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100103int mbedtls_test_rnd_pseudo_rand(void *rng_state,
104 unsigned char *output,
105 size_t len);
Ronald Cron2058d562020-06-09 17:11:47 +0200106
Ronald Cronb7eb67f2020-06-09 16:57:42 +0200107#endif /* TEST_RANDOM_H */