blob: 75ab3cb9637fba247399fa7dd629476565acda04 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file havege.h
Paul Bakkere0ccd0a2009-01-04 16:27:10 +00003 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00004 * \brief HAVEGE: HArdware Volatile Entropy Gathering and Expansion
Darryl Greena40a1012018-01-05 15:33:17 +00005 */
6/*
Manuel Pégourié-Gonnard6fb81872015-07-27 11:11:48 +02007 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
Bence Szépkútif744bd72020-06-05 13:02:18 +02008 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9 *
10 * This file is provided under the Apache License 2.0, or the
11 * GNU General Public License v2.0 or later.
12 *
13 * **********
14 * Apache License 2.0:
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020015 *
16 * Licensed under the Apache License, Version 2.0 (the "License"); you may
17 * not use this file except in compliance with the License.
18 * You may obtain a copy of the License at
19 *
20 * http://www.apache.org/licenses/LICENSE-2.0
21 *
22 * Unless required by applicable law or agreed to in writing, software
23 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25 * See the License for the specific language governing permissions and
26 * limitations under the License.
Paul Bakkerb96f1542010-07-18 20:36:00 +000027 *
Bence Szépkútif744bd72020-06-05 13:02:18 +020028 * **********
29 *
30 * **********
31 * GNU General Public License v2.0 or later:
32 *
33 * This program is free software; you can redistribute it and/or modify
34 * it under the terms of the GNU General Public License as published by
35 * the Free Software Foundation; either version 2 of the License, or
36 * (at your option) any later version.
37 *
38 * This program is distributed in the hope that it will be useful,
39 * but WITHOUT ANY WARRANTY; without even the implied warranty of
40 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41 * GNU General Public License for more details.
42 *
43 * You should have received a copy of the GNU General Public License along
44 * with this program; if not, write to the Free Software Foundation, Inc.,
45 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
46 *
47 * **********
48 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000049 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker5121ce52009-01-03 21:22:43 +000050 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020051#ifndef MBEDTLS_HAVEGE_H
52#define MBEDTLS_HAVEGE_H
Paul Bakker5121ce52009-01-03 21:22:43 +000053
Ron Eldor9cbd1b22018-12-16 12:14:37 +020054#if !defined(MBEDTLS_CONFIG_FILE)
55#include "config.h"
56#else
57#include MBEDTLS_CONFIG_FILE
58#endif
59
Rich Evans00ab4702015-02-06 13:43:58 +000060#include <stddef.h>
Paul Bakkera3d195c2011-11-27 21:07:34 +000061
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020062#define MBEDTLS_HAVEGE_COLLECT_SIZE 1024
Paul Bakker5121ce52009-01-03 21:22:43 +000063
Paul Bakker407a0da2013-06-27 14:29:21 +020064#ifdef __cplusplus
65extern "C" {
66#endif
67
Paul Bakker5121ce52009-01-03 21:22:43 +000068/**
69 * \brief HAVEGE state structure
70 */
Dawid Drozd428cc522018-07-24 10:02:47 +020071typedef struct mbedtls_havege_state
Paul Bakker5121ce52009-01-03 21:22:43 +000072{
73 int PT1, PT2, offset[2];
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020074 int pool[MBEDTLS_HAVEGE_COLLECT_SIZE];
Paul Bakker5121ce52009-01-03 21:22:43 +000075 int WALK[8192];
76}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020077mbedtls_havege_state;
Paul Bakker5121ce52009-01-03 21:22:43 +000078
Paul Bakker5121ce52009-01-03 21:22:43 +000079/**
80 * \brief HAVEGE initialization
81 *
82 * \param hs HAVEGE state to be initialized
83 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020084void mbedtls_havege_init( mbedtls_havege_state *hs );
Paul Bakker5121ce52009-01-03 21:22:43 +000085
86/**
Paul Bakkera317a982014-06-18 16:44:11 +020087 * \brief Clear HAVEGE state
88 *
89 * \param hs HAVEGE state to be cleared
90 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020091void mbedtls_havege_free( mbedtls_havege_state *hs );
Paul Bakkera317a982014-06-18 16:44:11 +020092
93/**
Paul Bakker5121ce52009-01-03 21:22:43 +000094 * \brief HAVEGE rand function
95 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +000096 * \param p_rng A HAVEGE state
Paul Bakkera3d195c2011-11-27 21:07:34 +000097 * \param output Buffer to fill
98 * \param len Length of buffer
Paul Bakker5121ce52009-01-03 21:22:43 +000099 *
Paul Bakkere708e5c2012-02-03 08:13:57 +0000100 * \return 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000101 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200102int mbedtls_havege_random( void *p_rng, unsigned char *output, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +0000103
104#ifdef __cplusplus
105}
106#endif
107
108#endif /* havege.h */