ReactOS  0.4.15-dev-4857-g47842d7
hmac_drbg.h
Go to the documentation of this file.
1 
10 /*
11  * Copyright The Mbed TLS Contributors
12  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
13  *
14  * This file is provided under the Apache License 2.0, or the
15  * GNU General Public License v2.0 or later.
16  *
17  * **********
18  * Apache License 2.0:
19  *
20  * Licensed under the Apache License, Version 2.0 (the "License"); you may
21  * not use this file except in compliance with the License.
22  * You may obtain a copy of the License at
23  *
24  * http://www.apache.org/licenses/LICENSE-2.0
25  *
26  * Unless required by applicable law or agreed to in writing, software
27  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
28  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
29  * See the License for the specific language governing permissions and
30  * limitations under the License.
31  *
32  * **********
33  *
34  * **********
35  * GNU General Public License v2.0 or later:
36  *
37  * This program is free software; you can redistribute it and/or modify
38  * it under the terms of the GNU General Public License as published by
39  * the Free Software Foundation; either version 2 of the License, or
40  * (at your option) any later version.
41  *
42  * This program is distributed in the hope that it will be useful,
43  * but WITHOUT ANY WARRANTY; without even the implied warranty of
44  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
45  * GNU General Public License for more details.
46  *
47  * You should have received a copy of the GNU General Public License along
48  * with this program; if not, write to the Free Software Foundation, Inc.,
49  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
50  *
51  * **********
52  */
53 #ifndef MBEDTLS_HMAC_DRBG_H
54 #define MBEDTLS_HMAC_DRBG_H
55 
56 #if !defined(MBEDTLS_CONFIG_FILE)
57 #include "config.h"
58 #else
59 #include MBEDTLS_CONFIG_FILE
60 #endif
61 
62 #include "md.h"
63 
64 #if defined(MBEDTLS_THREADING_C)
65 #include "threading.h"
66 #endif
67 
68 /*
69  * Error codes
70  */
71 #define MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG -0x0003
72 #define MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG -0x0005
73 #define MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR -0x0007
74 #define MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED -0x0009
84 #if !defined(MBEDTLS_HMAC_DRBG_RESEED_INTERVAL)
85 #define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000
86 #endif
87 
88 #if !defined(MBEDTLS_HMAC_DRBG_MAX_INPUT)
89 #define MBEDTLS_HMAC_DRBG_MAX_INPUT 256
90 #endif
91 
92 #if !defined(MBEDTLS_HMAC_DRBG_MAX_REQUEST)
93 #define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024
94 #endif
95 
96 #if !defined(MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT)
97 #define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384
98 #endif
99 
100 /* \} name SECTION: Module settings */
101 
102 #define MBEDTLS_HMAC_DRBG_PR_OFF 0
103 #define MBEDTLS_HMAC_DRBG_PR_ON 1
105 #ifdef __cplusplus
106 extern "C" {
107 #endif
108 
113 {
114  /* Working state: the key K is not stored explicitly,
115  * but is implied by the HMAC context */
117  unsigned char V[MBEDTLS_MD_MAX_SIZE];
120  /* Administrative state */
121  size_t entropy_len;
126  /* Callbacks */
127  int (*f_entropy)(void *, unsigned char *, size_t);
128  void *p_entropy;
130 #if defined(MBEDTLS_THREADING_C)
131  /* Invariant: the mutex is initialized if and only if
132  * md_ctx->md_info != NULL. This means that the mutex is initialized
133  * during the initial seeding in mbedtls_hmac_drbg_seed() or
134  * mbedtls_hmac_drbg_seed_buf() and freed in mbedtls_ctr_drbg_free().
135  *
136  * Note that this invariant may change without notice. Do not rely on it
137  * and do not access the mutex directly in application code.
138  */
139  mbedtls_threading_mutex_t mutex;
140 #endif
142 
156 
189 #if defined(MBEDTLS_THREADING_C)
190 
197 #endif /* MBEDTLS_THREADING_C */
198 
226  const mbedtls_md_info_t * md_info,
227  int (*f_entropy)(void *, unsigned char *, size_t),
228  void *p_entropy,
229  const unsigned char *custom,
230  size_t len );
231 
238 #if defined(MBEDTLS_THREADING_C)
239 
246 #endif /* MBEDTLS_THREADING_C */
247 
261  const mbedtls_md_info_t * md_info,
262  const unsigned char *data, size_t data_len );
263 
278  int resistance );
279 
290  size_t len );
291 
305  int interval );
306 
325  const unsigned char *additional, size_t add_len );
326 
352  const unsigned char *additional, size_t len );
353 
385 int mbedtls_hmac_drbg_random_with_add( void *p_rng,
386  unsigned char *output, size_t output_len,
387  const unsigned char *additional,
388  size_t add_len );
389 
396 #if defined(MBEDTLS_THREADING_C)
397 
403 #endif /* MBEDTLS_THREADING_C */
404 
417 int mbedtls_hmac_drbg_random( void *p_rng, unsigned char *output, size_t out_len );
418 
426 
427 #if ! defined(MBEDTLS_DEPRECATED_REMOVED)
428 #if defined(MBEDTLS_DEPRECATED_WARNING)
429 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
430 #else
431 #define MBEDTLS_DEPRECATED
432 #endif
433 
447  const unsigned char *additional, size_t add_len );
448 #undef MBEDTLS_DEPRECATED
449 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
450 
451 #if defined(MBEDTLS_FS_IO)
452 
463 int mbedtls_hmac_drbg_write_seed_file( mbedtls_hmac_drbg_context *ctx, const char *path );
464 
479 int mbedtls_hmac_drbg_update_seed_file( mbedtls_hmac_drbg_context *ctx, const char *path );
480 #endif /* MBEDTLS_FS_IO */
481 
482 
483 #if defined(MBEDTLS_SELF_TEST)
484 
490 int mbedtls_hmac_drbg_self_test( int verbose );
491 #endif
492 
493 #ifdef __cplusplus
494 }
495 #endif
496 
497 #endif /* hmac_drbg.h */
int mbedtls_hmac_drbg_seed(mbedtls_hmac_drbg_context *ctx, const mbedtls_md_info_t *md_info, int(*f_entropy)(void *, unsigned char *, size_t), void *p_entropy, const unsigned char *custom, size_t len)
HMAC_DRBG initial seeding.
#define MBEDTLS_MD_MAX_SIZE
Definition: md.h:97
static UCHAR ULONG UCHAR ULONG UCHAR * output
Definition: bcrypt.c:29
int mbedtls_hmac_drbg_seed_buf(mbedtls_hmac_drbg_context *ctx, const mbedtls_md_info_t *md_info, const unsigned char *data, size_t data_len)
Initilisation of simpified HMAC_DRBG (never reseeds).
void mbedtls_hmac_drbg_set_reseed_interval(mbedtls_hmac_drbg_context *ctx, int interval)
Set the reseed interval.
void mbedtls_hmac_drbg_free(mbedtls_hmac_drbg_context *ctx)
This function resets HMAC_DRBG context to the state immediately after initial call of mbedtls_hmac_dr...
int mbedtls_hmac_drbg_random(void *p_rng, unsigned char *output, size_t out_len)
This function uses HMAC_DRBG to generate random data.
HANDLE mutex
Definition: loader.c:2140
#define verbose
Definition: rosglue.h:36
int(* f_entropy)(void *, unsigned char *, size_t)
Definition: hmac_drbg.h:127
Threading abstraction layer.
struct mbedtls_hmac_drbg_context mbedtls_hmac_drbg_context
#define MBEDTLS_DEPRECATED
Definition: hmac_drbg.h:431
__kernel_size_t size_t
Definition: linux.h:237
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: gl.h:1950
MBEDTLS_DEPRECATED void mbedtls_hmac_drbg_update(mbedtls_hmac_drbg_context *ctx, const unsigned char *additional, size_t add_len)
This function updates the state of the HMAC_DRBG context.
GLenum GLsizei len
Definition: glext.h:6722
This file contains the generic message-digest wrapper.
void mbedtls_hmac_drbg_init(mbedtls_hmac_drbg_context *ctx)
HMAC_DRBG context initialization.
int mbedtls_hmac_drbg_random_with_add(void *p_rng, unsigned char *output, size_t output_len, const unsigned char *additional, size_t add_len)
This function updates an HMAC_DRBG instance with additional data and uses it to generate random data.
int mbedtls_hmac_drbg_reseed(mbedtls_hmac_drbg_context *ctx, const unsigned char *additional, size_t len)
This function reseeds the HMAC_DRBG context, that is extracts data from the entropy source.
mbedtls_md_context_t md_ctx
Definition: hmac_drbg.h:116
int mbedtls_hmac_drbg_update_ret(mbedtls_hmac_drbg_context *ctx, const unsigned char *additional, size_t add_len)
This function updates the state of the HMAC_DRBG context.
void mbedtls_hmac_drbg_set_entropy_len(mbedtls_hmac_drbg_context *ctx, size_t len)
This function sets the amount of entropy grabbed on each seed or reseed.
void mbedtls_hmac_drbg_set_prediction_resistance(mbedtls_hmac_drbg_context *ctx, int resistance)
This function turns prediction resistance on or off. The default value is off.
unsigned int(__cdecl typeof(jpeg_read_scanlines))(struct jpeg_decompress_struct *
Definition: typeof.h:31