Hannes Tschofenig / Mbed 2 deprecated aes-gcm-test-program

Example program to test AES-GCM functionality. Used for a workshop

Dependencies:   mbed

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  ctr_drbg_context
 CTR_DRBG context structure. More...

Functions

int ctr_drbg_init (ctr_drbg_context *ctx, int(*f_entropy)(void *, unsigned char *, size_t), void *p_entropy, const unsigned char *custom, size_t len)
 CTR_DRBG initialization.
void ctr_drbg_set_prediction_resistance (ctr_drbg_context *ctx, int resistance)
 Enable / disable prediction resistance (Default: Off)
void ctr_drbg_set_entropy_len (ctr_drbg_context *ctx, size_t len)
 Set the amount of entropy grabbed on each (re)seed (Default: CTR_DRBG_ENTROPY_LEN)
void ctr_drbg_set_reseed_interval (ctr_drbg_context *ctx, int interval)
 Set the reseed interval (Default: CTR_DRBG_RESEED_INTERVAL)
int ctr_drbg_reseed (ctr_drbg_context *ctx, const unsigned char *additional, size_t len)
 CTR_DRBG reseeding (extracts data from entropy source)
void ctr_drbg_update (ctr_drbg_context *ctx, const unsigned char *additional, size_t add_len)
 CTR_DRBG update state.
int 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 ctr_drbg_random (void *p_rng, unsigned char *output, size_t output_len)
 CTR_DRBG generate random.
int ctr_drbg_write_seed_file (ctr_drbg_context *ctx, const char *path)
 Write a seed file.
int ctr_drbg_update_seed_file (ctr_drbg_context *ctx, const char *path)
 Read and update a seed file.
int ctr_drbg_self_test (int verbose)
 Checkup routine.

Detailed Description

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

Copyright (C) 2006-2014, Brainspark B.V.

This file is part of PolarSSL (http://www.polarssl.org) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>

All rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Definition in file ctr_drbg.h.

Function Documentation

int ctr_drbg_init ( ctr_drbg_context *  ctx,
int(*)(void *, unsigned char *, size_t)  f_entropy,
void *  p_entropy,
const unsigned char *  custom,
size_t  len 
)

CTR_DRBG initialization.

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 initialized
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 POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED

Definition at line 86 of file ctr_drbg.c.

int 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 POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED, or POLARSSL_ERR_CTR_DRBG_REQUEST_TOO_BIG

Definition at line 356 of file ctr_drbg.c.

int 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 POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED, or POLARSSL_ERR_CTR_DRBG_REQUEST_TOO_BIG

Definition at line 290 of file ctr_drbg.c.

int ctr_drbg_reseed ( 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 POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED

Definition at line 245 of file ctr_drbg.c.

int ctr_drbg_self_test ( int  verbose )

Checkup routine.

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

Definition at line 484 of file ctr_drbg.c.

void ctr_drbg_set_entropy_len ( ctr_drbg_context *  ctx,
size_t  len 
)

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

Parameters:
ctxCTR_DRBG context
lenAmount of entropy to grab

Definition at line 101 of file ctr_drbg.c.

void ctr_drbg_set_prediction_resistance ( 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
resistanceCTR_DRBG_PR_ON or CTR_DRBG_PR_OFF

Definition at line 96 of file ctr_drbg.c.

void ctr_drbg_set_reseed_interval ( ctr_drbg_context *  ctx,
int  interval 
)

Set the reseed interval (Default: CTR_DRBG_RESEED_INTERVAL)

Parameters:
ctxCTR_DRBG context
intervalReseed interval

Definition at line 106 of file ctr_drbg.c.

void ctr_drbg_update ( 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

Definition at line 233 of file ctr_drbg.c.

int ctr_drbg_update_seed_file ( 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, POLARSSL_ERR_CTR_DRBG_FILE_IO_ERROR on file error, POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or POLARSSL_ERR_CTR_DRBG_INPUT_TOO_BIG

Definition at line 387 of file ctr_drbg.c.

int ctr_drbg_write_seed_file ( ctr_drbg_context *  ctx,
const char *  path 
)

Write a seed file.

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

Definition at line 362 of file ctr_drbg.c.

Generated on Tue Jul 12 2022 19:40:22 by  doxygen 1.7.2