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

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

Dependencies:   mbed

SSL/include/polarssl/ctr_drbg.h@0:796d0f61a05b, 2018-09-27 (annotated)

Committer:
HannesTschofenig
Date:
Thu Sep 27 06:34:22 2018 +0000
Revision:
0:796d0f61a05b
Example AES-GCM test program

Who changed what in which revision?

UserRevisionLine numberNew contents of line
HannesTschofenig 0:796d0f61a05b 1 /**
HannesTschofenig 0:796d0f61a05b 2 * \file ctr_drbg.h
HannesTschofenig 0:796d0f61a05b 3 *
HannesTschofenig 0:796d0f61a05b 4 * \brief CTR_DRBG based on AES-256 (NIST SP 800-90)
HannesTschofenig 0:796d0f61a05b 5 *
HannesTschofenig 0:796d0f61a05b 6 * Copyright (C) 2006-2014, Brainspark B.V.
HannesTschofenig 0:796d0f61a05b 7 *
HannesTschofenig 0:796d0f61a05b 8 * This file is part of PolarSSL (http://www.polarssl.org)
HannesTschofenig 0:796d0f61a05b 9 * Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
HannesTschofenig 0:796d0f61a05b 10 *
HannesTschofenig 0:796d0f61a05b 11 * All rights reserved.
HannesTschofenig 0:796d0f61a05b 12 *
HannesTschofenig 0:796d0f61a05b 13 * This program is free software; you can redistribute it and/or modify
HannesTschofenig 0:796d0f61a05b 14 * it under the terms of the GNU General Public License as published by
HannesTschofenig 0:796d0f61a05b 15 * the Free Software Foundation; either version 2 of the License, or
HannesTschofenig 0:796d0f61a05b 16 * (at your option) any later version.
HannesTschofenig 0:796d0f61a05b 17 *
HannesTschofenig 0:796d0f61a05b 18 * This program is distributed in the hope that it will be useful,
HannesTschofenig 0:796d0f61a05b 19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
HannesTschofenig 0:796d0f61a05b 20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
HannesTschofenig 0:796d0f61a05b 21 * GNU General Public License for more details.
HannesTschofenig 0:796d0f61a05b 22 *
HannesTschofenig 0:796d0f61a05b 23 * You should have received a copy of the GNU General Public License along
HannesTschofenig 0:796d0f61a05b 24 * with this program; if not, write to the Free Software Foundation, Inc.,
HannesTschofenig 0:796d0f61a05b 25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
HannesTschofenig 0:796d0f61a05b 26 */
HannesTschofenig 0:796d0f61a05b 27 #ifndef POLARSSL_CTR_DRBG_H
HannesTschofenig 0:796d0f61a05b 28 #define POLARSSL_CTR_DRBG_H
HannesTschofenig 0:796d0f61a05b 29
HannesTschofenig 0:796d0f61a05b 30 #include <string.h>
HannesTschofenig 0:796d0f61a05b 31
HannesTschofenig 0:796d0f61a05b 32 #include "aes.h"
HannesTschofenig 0:796d0f61a05b 33
HannesTschofenig 0:796d0f61a05b 34 #define POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED -0x0034 /**< The entropy source failed. */
HannesTschofenig 0:796d0f61a05b 35 #define POLARSSL_ERR_CTR_DRBG_REQUEST_TOO_BIG -0x0036 /**< Too many random requested in single call. */
HannesTschofenig 0:796d0f61a05b 36 #define POLARSSL_ERR_CTR_DRBG_INPUT_TOO_BIG -0x0038 /**< Input too large (Entropy + additional). */
HannesTschofenig 0:796d0f61a05b 37 #define POLARSSL_ERR_CTR_DRBG_FILE_IO_ERROR -0x003A /**< Read/write error in file. */
HannesTschofenig 0:796d0f61a05b 38
HannesTschofenig 0:796d0f61a05b 39 #define CTR_DRBG_BLOCKSIZE 16 /**< Block size used by the cipher */
HannesTschofenig 0:796d0f61a05b 40 #define CTR_DRBG_KEYSIZE 32 /**< Key size used by the cipher */
HannesTschofenig 0:796d0f61a05b 41 #define CTR_DRBG_KEYBITS ( CTR_DRBG_KEYSIZE * 8 )
HannesTschofenig 0:796d0f61a05b 42 #define CTR_DRBG_SEEDLEN ( CTR_DRBG_KEYSIZE + CTR_DRBG_BLOCKSIZE )
HannesTschofenig 0:796d0f61a05b 43 /**< The seed length (counter + AES key) */
HannesTschofenig 0:796d0f61a05b 44
HannesTschofenig 0:796d0f61a05b 45 /**
HannesTschofenig 0:796d0f61a05b 46 * \name SECTION: Module settings
HannesTschofenig 0:796d0f61a05b 47 *
HannesTschofenig 0:796d0f61a05b 48 * The configuration options you can set for this module are in this section.
HannesTschofenig 0:796d0f61a05b 49 * Either change them in config.h or define them on the compiler command line.
HannesTschofenig 0:796d0f61a05b 50 * \{
HannesTschofenig 0:796d0f61a05b 51 */
HannesTschofenig 0:796d0f61a05b 52
HannesTschofenig 0:796d0f61a05b 53 #if !defined(CTR_DRBG_ENTROPY_LEN)
HannesTschofenig 0:796d0f61a05b 54 #if defined(POLARSSL_SHA512_C) && !defined(POLARSSL_ENTROPY_FORCE_SHA256)
HannesTschofenig 0:796d0f61a05b 55 #define CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
HannesTschofenig 0:796d0f61a05b 56 #else
HannesTschofenig 0:796d0f61a05b 57 #define CTR_DRBG_ENTROPY_LEN 32 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
HannesTschofenig 0:796d0f61a05b 58 #endif
HannesTschofenig 0:796d0f61a05b 59 #endif
HannesTschofenig 0:796d0f61a05b 60
HannesTschofenig 0:796d0f61a05b 61 #if !defined(CTR_DRBG_RESEED_INTERVAL)
HannesTschofenig 0:796d0f61a05b 62 #define CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
HannesTschofenig 0:796d0f61a05b 63 #endif
HannesTschofenig 0:796d0f61a05b 64
HannesTschofenig 0:796d0f61a05b 65 #if !defined(CTR_DRBG_MAX_INPUT)
HannesTschofenig 0:796d0f61a05b 66 #define CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
HannesTschofenig 0:796d0f61a05b 67 #endif
HannesTschofenig 0:796d0f61a05b 68
HannesTschofenig 0:796d0f61a05b 69 #if !defined(CTR_DRBG_MAX_REQUEST)
HannesTschofenig 0:796d0f61a05b 70 #define CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
HannesTschofenig 0:796d0f61a05b 71 #endif
HannesTschofenig 0:796d0f61a05b 72
HannesTschofenig 0:796d0f61a05b 73 #if !defined(CTR_DRBG_MAX_SEED_INPUT)
HannesTschofenig 0:796d0f61a05b 74 #define CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
HannesTschofenig 0:796d0f61a05b 75 #endif
HannesTschofenig 0:796d0f61a05b 76
HannesTschofenig 0:796d0f61a05b 77 /* \} name SECTION: Module settings */
HannesTschofenig 0:796d0f61a05b 78
HannesTschofenig 0:796d0f61a05b 79 #define CTR_DRBG_PR_OFF 0 /**< No prediction resistance */
HannesTschofenig 0:796d0f61a05b 80 #define CTR_DRBG_PR_ON 1 /**< Prediction resistance enabled */
HannesTschofenig 0:796d0f61a05b 81
HannesTschofenig 0:796d0f61a05b 82 #ifdef __cplusplus
HannesTschofenig 0:796d0f61a05b 83 extern "C" {
HannesTschofenig 0:796d0f61a05b 84 #endif
HannesTschofenig 0:796d0f61a05b 85
HannesTschofenig 0:796d0f61a05b 86 /**
HannesTschofenig 0:796d0f61a05b 87 * \brief CTR_DRBG context structure
HannesTschofenig 0:796d0f61a05b 88 */
HannesTschofenig 0:796d0f61a05b 89 typedef struct
HannesTschofenig 0:796d0f61a05b 90 {
HannesTschofenig 0:796d0f61a05b 91 unsigned char counter[16]; /*!< counter (V) */
HannesTschofenig 0:796d0f61a05b 92 int reseed_counter; /*!< reseed counter */
HannesTschofenig 0:796d0f61a05b 93 int prediction_resistance; /*!< enable prediction resistance (Automatic
HannesTschofenig 0:796d0f61a05b 94 reseed before every random generation) */
HannesTschofenig 0:796d0f61a05b 95 size_t entropy_len; /*!< amount of entropy grabbed on each
HannesTschofenig 0:796d0f61a05b 96 (re)seed */
HannesTschofenig 0:796d0f61a05b 97 int reseed_interval; /*!< reseed interval */
HannesTschofenig 0:796d0f61a05b 98
HannesTschofenig 0:796d0f61a05b 99 aes_context aes_ctx; /*!< AES context */
HannesTschofenig 0:796d0f61a05b 100
HannesTschofenig 0:796d0f61a05b 101 /*
HannesTschofenig 0:796d0f61a05b 102 * Callbacks (Entropy)
HannesTschofenig 0:796d0f61a05b 103 */
HannesTschofenig 0:796d0f61a05b 104 int (*f_entropy)(void *, unsigned char *, size_t);
HannesTschofenig 0:796d0f61a05b 105
HannesTschofenig 0:796d0f61a05b 106 void *p_entropy; /*!< context for the entropy function */
HannesTschofenig 0:796d0f61a05b 107 }
HannesTschofenig 0:796d0f61a05b 108 ctr_drbg_context;
HannesTschofenig 0:796d0f61a05b 109
HannesTschofenig 0:796d0f61a05b 110 /**
HannesTschofenig 0:796d0f61a05b 111 * \brief CTR_DRBG initialization
HannesTschofenig 0:796d0f61a05b 112 *
HannesTschofenig 0:796d0f61a05b 113 * Note: Personalization data can be provided in addition to the more generic
HannesTschofenig 0:796d0f61a05b 114 * entropy source to make this instantiation as unique as possible.
HannesTschofenig 0:796d0f61a05b 115 *
HannesTschofenig 0:796d0f61a05b 116 * \param ctx CTR_DRBG context to be initialized
HannesTschofenig 0:796d0f61a05b 117 * \param f_entropy Entropy callback (p_entropy, buffer to fill, buffer
HannesTschofenig 0:796d0f61a05b 118 * length)
HannesTschofenig 0:796d0f61a05b 119 * \param p_entropy Entropy context
HannesTschofenig 0:796d0f61a05b 120 * \param custom Personalization data (Device specific identifiers)
HannesTschofenig 0:796d0f61a05b 121 * (Can be NULL)
HannesTschofenig 0:796d0f61a05b 122 * \param len Length of personalization data
HannesTschofenig 0:796d0f61a05b 123 *
HannesTschofenig 0:796d0f61a05b 124 * \return 0 if successful, or
HannesTschofenig 0:796d0f61a05b 125 * POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED
HannesTschofenig 0:796d0f61a05b 126 */
HannesTschofenig 0:796d0f61a05b 127 int ctr_drbg_init( ctr_drbg_context *ctx,
HannesTschofenig 0:796d0f61a05b 128 int (*f_entropy)(void *, unsigned char *, size_t),
HannesTschofenig 0:796d0f61a05b 129 void *p_entropy,
HannesTschofenig 0:796d0f61a05b 130 const unsigned char *custom,
HannesTschofenig 0:796d0f61a05b 131 size_t len );
HannesTschofenig 0:796d0f61a05b 132
HannesTschofenig 0:796d0f61a05b 133 /**
HannesTschofenig 0:796d0f61a05b 134 * \brief Enable / disable prediction resistance (Default: Off)
HannesTschofenig 0:796d0f61a05b 135 *
HannesTschofenig 0:796d0f61a05b 136 * Note: If enabled, entropy is used for ctx->entropy_len before each call!
HannesTschofenig 0:796d0f61a05b 137 * Only use this if you have ample supply of good entropy!
HannesTschofenig 0:796d0f61a05b 138 *
HannesTschofenig 0:796d0f61a05b 139 * \param ctx CTR_DRBG context
HannesTschofenig 0:796d0f61a05b 140 * \param resistance CTR_DRBG_PR_ON or CTR_DRBG_PR_OFF
HannesTschofenig 0:796d0f61a05b 141 */
HannesTschofenig 0:796d0f61a05b 142 void ctr_drbg_set_prediction_resistance( ctr_drbg_context *ctx,
HannesTschofenig 0:796d0f61a05b 143 int resistance );
HannesTschofenig 0:796d0f61a05b 144
HannesTschofenig 0:796d0f61a05b 145 /**
HannesTschofenig 0:796d0f61a05b 146 * \brief Set the amount of entropy grabbed on each (re)seed
HannesTschofenig 0:796d0f61a05b 147 * (Default: CTR_DRBG_ENTROPY_LEN)
HannesTschofenig 0:796d0f61a05b 148 *
HannesTschofenig 0:796d0f61a05b 149 * \param ctx CTR_DRBG context
HannesTschofenig 0:796d0f61a05b 150 * \param len Amount of entropy to grab
HannesTschofenig 0:796d0f61a05b 151 */
HannesTschofenig 0:796d0f61a05b 152 void ctr_drbg_set_entropy_len( ctr_drbg_context *ctx,
HannesTschofenig 0:796d0f61a05b 153 size_t len );
HannesTschofenig 0:796d0f61a05b 154
HannesTschofenig 0:796d0f61a05b 155 /**
HannesTschofenig 0:796d0f61a05b 156 * \brief Set the reseed interval
HannesTschofenig 0:796d0f61a05b 157 * (Default: CTR_DRBG_RESEED_INTERVAL)
HannesTschofenig 0:796d0f61a05b 158 *
HannesTschofenig 0:796d0f61a05b 159 * \param ctx CTR_DRBG context
HannesTschofenig 0:796d0f61a05b 160 * \param interval Reseed interval
HannesTschofenig 0:796d0f61a05b 161 */
HannesTschofenig 0:796d0f61a05b 162 void ctr_drbg_set_reseed_interval( ctr_drbg_context *ctx,
HannesTschofenig 0:796d0f61a05b 163 int interval );
HannesTschofenig 0:796d0f61a05b 164
HannesTschofenig 0:796d0f61a05b 165 /**
HannesTschofenig 0:796d0f61a05b 166 * \brief CTR_DRBG reseeding (extracts data from entropy source)
HannesTschofenig 0:796d0f61a05b 167 *
HannesTschofenig 0:796d0f61a05b 168 * \param ctx CTR_DRBG context
HannesTschofenig 0:796d0f61a05b 169 * \param additional Additional data to add to state (Can be NULL)
HannesTschofenig 0:796d0f61a05b 170 * \param len Length of additional data
HannesTschofenig 0:796d0f61a05b 171 *
HannesTschofenig 0:796d0f61a05b 172 * \return 0 if successful, or
HannesTschofenig 0:796d0f61a05b 173 * POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED
HannesTschofenig 0:796d0f61a05b 174 */
HannesTschofenig 0:796d0f61a05b 175 int ctr_drbg_reseed( ctr_drbg_context *ctx,
HannesTschofenig 0:796d0f61a05b 176 const unsigned char *additional, size_t len );
HannesTschofenig 0:796d0f61a05b 177
HannesTschofenig 0:796d0f61a05b 178 /**
HannesTschofenig 0:796d0f61a05b 179 * \brief CTR_DRBG update state
HannesTschofenig 0:796d0f61a05b 180 *
HannesTschofenig 0:796d0f61a05b 181 * \param ctx CTR_DRBG context
HannesTschofenig 0:796d0f61a05b 182 * \param additional Additional data to update state with
HannesTschofenig 0:796d0f61a05b 183 * \param add_len Length of additional data
HannesTschofenig 0:796d0f61a05b 184 */
HannesTschofenig 0:796d0f61a05b 185 void ctr_drbg_update( ctr_drbg_context *ctx,
HannesTschofenig 0:796d0f61a05b 186 const unsigned char *additional, size_t add_len );
HannesTschofenig 0:796d0f61a05b 187
HannesTschofenig 0:796d0f61a05b 188 /**
HannesTschofenig 0:796d0f61a05b 189 * \brief CTR_DRBG generate random with additional update input
HannesTschofenig 0:796d0f61a05b 190 *
HannesTschofenig 0:796d0f61a05b 191 * Note: Automatically reseeds if reseed_counter is reached.
HannesTschofenig 0:796d0f61a05b 192 *
HannesTschofenig 0:796d0f61a05b 193 * \param p_rng CTR_DRBG context
HannesTschofenig 0:796d0f61a05b 194 * \param output Buffer to fill
HannesTschofenig 0:796d0f61a05b 195 * \param output_len Length of the buffer
HannesTschofenig 0:796d0f61a05b 196 * \param additional Additional data to update with (Can be NULL)
HannesTschofenig 0:796d0f61a05b 197 * \param add_len Length of additional data
HannesTschofenig 0:796d0f61a05b 198 *
HannesTschofenig 0:796d0f61a05b 199 * \return 0 if successful, or
HannesTschofenig 0:796d0f61a05b 200 * POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED, or
HannesTschofenig 0:796d0f61a05b 201 * POLARSSL_ERR_CTR_DRBG_REQUEST_TOO_BIG
HannesTschofenig 0:796d0f61a05b 202 */
HannesTschofenig 0:796d0f61a05b 203 int ctr_drbg_random_with_add( void *p_rng,
HannesTschofenig 0:796d0f61a05b 204 unsigned char *output, size_t output_len,
HannesTschofenig 0:796d0f61a05b 205 const unsigned char *additional, size_t add_len );
HannesTschofenig 0:796d0f61a05b 206
HannesTschofenig 0:796d0f61a05b 207 /**
HannesTschofenig 0:796d0f61a05b 208 * \brief CTR_DRBG generate random
HannesTschofenig 0:796d0f61a05b 209 *
HannesTschofenig 0:796d0f61a05b 210 * Note: Automatically reseeds if reseed_counter is reached.
HannesTschofenig 0:796d0f61a05b 211 *
HannesTschofenig 0:796d0f61a05b 212 * \param p_rng CTR_DRBG context
HannesTschofenig 0:796d0f61a05b 213 * \param output Buffer to fill
HannesTschofenig 0:796d0f61a05b 214 * \param output_len Length of the buffer
HannesTschofenig 0:796d0f61a05b 215 *
HannesTschofenig 0:796d0f61a05b 216 * \return 0 if successful, or
HannesTschofenig 0:796d0f61a05b 217 * POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED, or
HannesTschofenig 0:796d0f61a05b 218 * POLARSSL_ERR_CTR_DRBG_REQUEST_TOO_BIG
HannesTschofenig 0:796d0f61a05b 219 */
HannesTschofenig 0:796d0f61a05b 220 int ctr_drbg_random( void *p_rng,
HannesTschofenig 0:796d0f61a05b 221 unsigned char *output, size_t output_len );
HannesTschofenig 0:796d0f61a05b 222
HannesTschofenig 0:796d0f61a05b 223 #if defined(POLARSSL_FS_IO)
HannesTschofenig 0:796d0f61a05b 224 /**
HannesTschofenig 0:796d0f61a05b 225 * \brief Write a seed file
HannesTschofenig 0:796d0f61a05b 226 *
HannesTschofenig 0:796d0f61a05b 227 * \param ctx CTR_DRBG context
HannesTschofenig 0:796d0f61a05b 228 * \param path Name of the file
HannesTschofenig 0:796d0f61a05b 229 *
HannesTschofenig 0:796d0f61a05b 230 * \return 0 if successful,
HannesTschofenig 0:796d0f61a05b 231 * POLARSSL_ERR_CTR_DRBG_FILE_IO_ERROR on file error, or
HannesTschofenig 0:796d0f61a05b 232 * POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED
HannesTschofenig 0:796d0f61a05b 233 */
HannesTschofenig 0:796d0f61a05b 234 int ctr_drbg_write_seed_file( ctr_drbg_context *ctx, const char *path );
HannesTschofenig 0:796d0f61a05b 235
HannesTschofenig 0:796d0f61a05b 236 /**
HannesTschofenig 0:796d0f61a05b 237 * \brief Read and update a seed file. Seed is added to this
HannesTschofenig 0:796d0f61a05b 238 * instance
HannesTschofenig 0:796d0f61a05b 239 *
HannesTschofenig 0:796d0f61a05b 240 * \param ctx CTR_DRBG context
HannesTschofenig 0:796d0f61a05b 241 * \param path Name of the file
HannesTschofenig 0:796d0f61a05b 242 *
HannesTschofenig 0:796d0f61a05b 243 * \return 0 if successful,
HannesTschofenig 0:796d0f61a05b 244 * POLARSSL_ERR_CTR_DRBG_FILE_IO_ERROR on file error,
HannesTschofenig 0:796d0f61a05b 245 * POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
HannesTschofenig 0:796d0f61a05b 246 * POLARSSL_ERR_CTR_DRBG_INPUT_TOO_BIG
HannesTschofenig 0:796d0f61a05b 247 */
HannesTschofenig 0:796d0f61a05b 248 int ctr_drbg_update_seed_file( ctr_drbg_context *ctx, const char *path );
HannesTschofenig 0:796d0f61a05b 249 #endif /* POLARSSL_FS_IO */
HannesTschofenig 0:796d0f61a05b 250
HannesTschofenig 0:796d0f61a05b 251 /**
HannesTschofenig 0:796d0f61a05b 252 * \brief Checkup routine
HannesTschofenig 0:796d0f61a05b 253 *
HannesTschofenig 0:796d0f61a05b 254 * \return 0 if successful, or 1 if the test failed
HannesTschofenig 0:796d0f61a05b 255 */
HannesTschofenig 0:796d0f61a05b 256 int ctr_drbg_self_test( int verbose );
HannesTschofenig 0:796d0f61a05b 257
HannesTschofenig 0:796d0f61a05b 258 /* Internal functions (do not call directly) */
HannesTschofenig 0:796d0f61a05b 259 int ctr_drbg_init_entropy_len( ctr_drbg_context *,
HannesTschofenig 0:796d0f61a05b 260 int (*)(void *, unsigned char *, size_t), void *,
HannesTschofenig 0:796d0f61a05b 261 const unsigned char *, size_t, size_t );
HannesTschofenig 0:796d0f61a05b 262
HannesTschofenig 0:796d0f61a05b 263 #ifdef __cplusplus
HannesTschofenig 0:796d0f61a05b 264 }
HannesTschofenig 0:796d0f61a05b 265 #endif
HannesTschofenig 0:796d0f61a05b 266
HannesTschofenig 0:796d0f61a05b 267 #endif /* ctr_drbg.h */
HannesTschofenig 0:796d0f61a05b 268
HannesTschofenig 0:796d0f61a05b 269