sandbox / mbedtls

mbedtls ported to mbed-classic

Fork of mbedtls by Christopher Haster

Embed: (wiki syntax)

« Back to documentation index

ctr_drbg.h File Reference
Data Structures | Functions

ctr_drbg.h File Reference

CTR_DRBG based on AES-256 (NIST SP 800-90) More...

Go to the source code of this file.

Data Structures

struct  mbedtls_ctr_drbg_context
 CTR_DRBG context structure. More...

Functions

void mbedtls_ctr_drbg_init (mbedtls_ctr_drbg_context *ctx)
 CTR_DRBG context initialization Makes the context ready for mbedtls_ctr_drbg_seed() or mbedtls_ctr_drbg_free().
int mbedtls_ctr_drbg_seed (mbedtls_ctr_drbg_context *ctx, int(*f_entropy)(void *, unsigned char *, size_t), void *p_entropy, const unsigned char *custom, size_t len)
 CTR_DRBG initial seeding Seed and setup entropy source for future reseeds.
void mbedtls_ctr_drbg_free (mbedtls_ctr_drbg_context *ctx)
 Clear CTR_CRBG context data.
void mbedtls_ctr_drbg_set_prediction_resistance (mbedtls_ctr_drbg_context *ctx, int resistance)
 Enable / disable prediction resistance (Default: Off)
void mbedtls_ctr_drbg_set_entropy_len (mbedtls_ctr_drbg_context *ctx, size_t len)
 Set the amount of entropy grabbed on each (re)seed (Default: MBEDTLS_CTR_DRBG_ENTROPY_LEN)
void mbedtls_ctr_drbg_set_reseed_interval (mbedtls_ctr_drbg_context *ctx, int interval)
 Set the reseed interval (Default: MBEDTLS_CTR_DRBG_RESEED_INTERVAL)
int mbedtls_ctr_drbg_reseed (mbedtls_ctr_drbg_context *ctx, const unsigned char *additional, size_t len)
 CTR_DRBG reseeding (extracts data from entropy source)
void mbedtls_ctr_drbg_update (mbedtls_ctr_drbg_context *ctx, const unsigned char *additional, size_t add_len)
 CTR_DRBG update state.
int mbedtls_ctr_drbg_random_with_add (void *p_rng, unsigned char *output, size_t output_len, const unsigned char *additional, size_t add_len)
 CTR_DRBG generate random with additional update input.
int mbedtls_ctr_drbg_random (void *p_rng, unsigned char *output, size_t output_len)
 CTR_DRBG generate random.
int mbedtls_ctr_drbg_write_seed_file (mbedtls_ctr_drbg_context *ctx, const char *path)
 Write a seed file.
int mbedtls_ctr_drbg_update_seed_file (mbedtls_ctr_drbg_context *ctx, const char *path)
 Read and update a seed file.
int mbedtls_ctr_drbg_self_test (int verbose)
 Checkup routine.

Detailed Description

CTR_DRBG based on AES-256 (NIST SP 800-90)

Copyright (C) 2006-2015, ARM Limited, All Rights Reserved SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

This file is part of mbed TLS (https://tls.mbed.org)

Definition in file ctr_drbg.h.

Function Documentation

void mbedtls_ctr_drbg_free ( mbedtls_ctr_drbg_context *  ctx )

Clear CTR_CRBG context data.

Parameters:
ctxCTR_DRBG context to clear

Definition at line 115 of file ctr_drbg.c.

void mbedtls_ctr_drbg_init ( mbedtls_ctr_drbg_context *  ctx )

CTR_DRBG context initialization Makes the context ready for mbedtls_ctr_drbg_seed() or mbedtls_ctr_drbg_free().

Parameters:
ctxCTR_DRBG context to be initialized

Definition at line 60 of file ctr_drbg.c.

int mbedtls_ctr_drbg_random ( void *  p_rng,
unsigned char *  output,
size_t  output_len 
)

CTR_DRBG generate random.

Note: Automatically reseeds if reseed_counter is reached.

Parameters:
p_rngCTR_DRBG context
outputBuffer to fill
output_lenLength of the buffer
Returns:
0 if successful, or MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED, or MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG

Definition at line 398 of file ctr_drbg.c.

int mbedtls_ctr_drbg_random_with_add ( void *  p_rng,
unsigned char *  output,
size_t  output_len,
const unsigned char *  additional,
size_t  add_len 
)

CTR_DRBG generate random with additional update input.

Note: Automatically reseeds if reseed_counter is reached.

Parameters:
p_rngCTR_DRBG context
outputBuffer to fill
output_lenLength of the buffer
additionalAdditional data to update with (Can be NULL)
add_lenLength of additional data
Returns:
0 if successful, or MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED, or MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG

Definition at line 332 of file ctr_drbg.c.

int mbedtls_ctr_drbg_reseed ( mbedtls_ctr_drbg_context *  ctx,
const unsigned char *  additional,
size_t  len 
)

CTR_DRBG reseeding (extracts data from entropy source)

Parameters:
ctxCTR_DRBG context
additionalAdditional data to add to state (Can be NULL)
lenLength of additional data
Returns:
0 if successful, or MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED

Definition at line 287 of file ctr_drbg.c.

int mbedtls_ctr_drbg_seed ( mbedtls_ctr_drbg_context *  ctx,
int(*)(void *, unsigned char *, size_t)  f_entropy,
void *  p_entropy,
const unsigned char *  custom,
size_t  len 
)

CTR_DRBG initial seeding Seed and setup entropy source for future reseeds.

Note: Personalization data can be provided in addition to the more generic entropy source to make this instantiation as unique as possible.

Parameters:
ctxCTR_DRBG context to be seeded
f_entropyEntropy callback (p_entropy, buffer to fill, buffer length)
p_entropyEntropy context
customPersonalization data (Device specific identifiers) (Can be NULL)
lenLength of personalization data
Returns:
0 if successful, or MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED

Definition at line 105 of file ctr_drbg.c.

int mbedtls_ctr_drbg_self_test ( int  verbose )

Checkup routine.

Returns:
0 if successful, or 1 if the test failed

Definition at line 539 of file ctr_drbg.c.

void mbedtls_ctr_drbg_set_entropy_len ( mbedtls_ctr_drbg_context *  ctx,
size_t  len 
)

Set the amount of entropy grabbed on each (re)seed (Default: MBEDTLS_CTR_DRBG_ENTROPY_LEN)

Parameters:
ctxCTR_DRBG context
lenAmount of entropy to grab

Definition at line 132 of file ctr_drbg.c.

void mbedtls_ctr_drbg_set_prediction_resistance ( mbedtls_ctr_drbg_context *  ctx,
int  resistance 
)

Enable / disable prediction resistance (Default: Off)

Note: If enabled, entropy is used for ctx->entropy_len before each call! Only use this if you have ample supply of good entropy!

Parameters:
ctxCTR_DRBG context
resistanceMBEDTLS_CTR_DRBG_PR_ON or MBEDTLS_CTR_DRBG_PR_OFF

Definition at line 127 of file ctr_drbg.c.

void mbedtls_ctr_drbg_set_reseed_interval ( mbedtls_ctr_drbg_context *  ctx,
int  interval 
)

Set the reseed interval (Default: MBEDTLS_CTR_DRBG_RESEED_INTERVAL)

Parameters:
ctxCTR_DRBG context
intervalReseed interval

Definition at line 137 of file ctr_drbg.c.

void mbedtls_ctr_drbg_update ( mbedtls_ctr_drbg_context *  ctx,
const unsigned char *  additional,
size_t  add_len 
)

CTR_DRBG update state.

Parameters:
ctxCTR_DRBG context
additionalAdditional data to update state with
add_lenLength of additional data
Note:
If add_len is greater than MBEDTLS_CTR_DRBG_MAX_SEED_INPUT, only the first MBEDTLS_CTR_DRBG_MAX_SEED_INPUT bytes are used, the remaining ones are silently discarded.

Definition at line 270 of file ctr_drbg.c.

int mbedtls_ctr_drbg_update_seed_file ( mbedtls_ctr_drbg_context *  ctx,
const char *  path 
)

Read and update a seed file.

Seed is added to this instance

Parameters:
ctxCTR_DRBG context
pathName of the file
Returns:
0 if successful, MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error, MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG

Definition at line 444 of file ctr_drbg.c.

int mbedtls_ctr_drbg_write_seed_file ( mbedtls_ctr_drbg_context *  ctx,
const char *  path 
)

Write a seed file.

Parameters:
ctxCTR_DRBG context
pathName of the file
Returns:
0 if successful, MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error, or MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED

Definition at line 419 of file ctr_drbg.c.

Generated on Tue Jul 12 2022 12:52:51 by  doxygen 1.7.2