This file contains the CRYS APIs used for random number generation. The random-number generation module implements referenced standard [SP800-90].
More...
|
#define | CRYS_RND_MAX_RESEED_COUNTER (0xFFFFFFFF - 0xF) |
|
#define | CRYS_RND_REQUESTED_SIZE_COUNTER 0x3FFFF |
|
#define | CRYS_RND_AES_BLOCK_SIZE_IN_WORDS SASI_AES_BLOCK_SIZE_IN_WORDS |
|
#define | CRYS_RND_SEED_MAX_SIZE_WORDS 12 |
|
#define | CRYS_RND_ADDITINAL_INPUT_MAX_SIZE_WORDS CRYS_RND_SEED_MAX_SIZE_WORDS |
|
#define | CRYS_RND_MAX_GEN_VECTOR_SIZE_BYTES 0xFFFF |
|
#define | CRYS_RND_AES_KEY_128_SIZE_WORDS 4 |
|
#define | CRYS_RND_AES_KEY_192_SIZE_WORDS 6 |
|
#define | CRYS_RND_AES_KEY_256_SIZE_WORDS 8 |
|
#define | CRYS_RND_WORK_BUFFER_SIZE_WORDS 1528 |
|
#define | CRYS_RND_EntropyEstimatData_t CRYS_RND_WorkBuff_t |
|
#define | crysRndEntrIntBuff crysRndWorkBuff |
|
#define | CRYS_RND_TRNG_SRC_INNER_OFFSET_WORDS 2 |
|
#define | CRYS_RND_MAX_SIZE_OF_OUTPUT_BYTES 3*1024 |
|
#define | CRYS_PRNG_FIPS_KAT_OUT_DATA_SIZE 64 |
|
|
enum | CRYS_RND_mode_t {
CRYS_RND_Fast = 0,
CRYS_RND_Slow = 1,
CRYS_RND_ModeLast = 0x7FFFFFFF
} |
|
|
CRYSError_t | CRYS_RND_Instantiation (CRYS_RND_Context_t *rndContext_ptr, CRYS_RND_WorkBuff_t *rndWorkBuff_ptr) |
| This function initializes the RND context. It must be called at least once prior to using this context with any API that requires it as a parameter (e.g., other RND APIs, asymmetric cryptography key generation and signatures). It is called as part of ARM TrustZone CryptoCell library initialization, which initializes and returns the primary RND context. This primary context can be used as a single global context for all RND needs. Alternatively, other contexts may be initialized and used with a more limited scope (for specific applications or specific threads). The call to this function must be followed by a call to CRYS_RND_SetGenerateVectorFunc API to set the generate vector function. It implements referenced standard [SP800-90] - 10.2.1.3.2 - CTR-DRBG Instantiate algorithm using AES (FIPS-PUB 197) and Derivation Function (DF). More...
|
|
CRYSError_t | CRYS_RND_UnInstantiation (CRYS_RND_Context_t *rndContext_ptr) |
| Clears existing RNG instantiation state. More...
|
|
CRYSError_t | CRYS_RND_Reseeding (CRYS_RND_Context_t *rndContext_ptr, CRYS_RND_WorkBuff_t *rndWorkBuff_ptr) |
| This function is used for reseeding the RNG with additional entropy and additional user-provided input. (additional data should be provided by calling CRYS_RND_AddAdditionalInput prior to using this API). It implements referenced standard [SP800-90] - 10.2.1.4.2 - CTR-DRBG Reseeding algorithm, using AES (FIPS-PUB 197) and Derivation Function (DF). More...
|
|
CRYSError_t | CRYS_RND_GenerateVector (CRYS_RND_State_t *rndState_ptr, uint16_t outSizeBytes, uint8_t *out_ptr) |
| Generates a random vector according to the algorithm defined in referenced standard [SP800-90] - 10.2.1.5.2 - CTR-DRBG. The generation algorithm uses AES (FIPS-PUB 197) and Derivation Function (DF). More...
|
|
CRYSError_t | CRYS_RND_SetGenerateVectorFunc (CRYS_RND_Context_t *rndContext_ptr, SaSiRndGenerateVectWorkFunc_t rndGenerateVectFunc) |
| This function sets the RND vector generation function into the RND context. More...
|
|
CRYSError_t | CRYS_RND_GenerateVectorInRange (CRYS_RND_Context_t *rndContext_ptr, uint32_t rndSizeInBits, uint8_t *maxVect_ptr, uint8_t *rndVect_ptr) |
| Generates a random vector with specific limitations by testing candidates (described and used in FIPS 186-4: B.1.2, B.4.2 etc.). More...
|
|
CRYSError_t | CRYS_RND_AddAdditionalInput (CRYS_RND_Context_t *rndContext_ptr, uint8_t *additonalInput_ptr, uint16_t additonalInputSize) |
| Used for adding additional input/personalization data provided by the user, to be later used by the CRYS_RND_Instantiation/CRYS_RND_Reseeding/CRYS_RND_GenerateVector functions. More...
|
|
CRYSError_t | CRYS_RND_EnterKatMode (CRYS_RND_Context_t *rndContext_ptr, uint8_t *entrData_ptr, uint32_t entrSize, uint8_t *nonce_ptr, uint32_t nonceSize, CRYS_RND_WorkBuff_t *workBuff_ptr) |
| The CRYS_RND_EnterKatMode function sets KAT mode bit into StateFlag of global CRYS_RND_WorkingState structure. More...
|
|
void | CRYS_RND_DisableKatMode (CRYS_RND_Context_t *rndContext_ptr) |
| The CRYS_RND_DisableKatMode function disables KAT mode bit into StateFlag of global CRYS_RND_WorkingState structure. More...
|
|
This file contains the CRYS APIs used for random number generation. The random-number generation module implements referenced standard [SP800-90].
AES output block size in words.
#define CRYS_RND_MAX_RESEED_COUNTER (0xFFFFFFFF - 0xF) |
Maximal reseed counter - indicates maximal number of requests allowed between reseeds; according to NIST 800-90 it is (2^48 - 1), our restriction is : (0xFFFFFFFF - 0xF).
typedef uint32_t(* SaSiRndGenerateVectWorkFunc_t)(CRYS_RND_State_t *rndState_ptr,uint16_t outSizeBytes,uint8_t *out_ptr) |
The RND Generate vector function pointer type definition. The prototype intendent for External and CRYS internal RND functions pointers definitions. Full description can be found in CRYS_RND_GenerateVector function API.
Used for adding additional input/personalization data provided by the user, to be later used by the CRYS_RND_Instantiation/CRYS_RND_Reseeding/CRYS_RND_GenerateVector functions.
- Returns
- CRYS_OK on success.
-
A non-zero value from crys_rnd_error.h on failure.
- Parameters
-
[in,out] | rndContext_ptr | Pointer to the RND context buffer. |
[in] | additonalInput_ptr | The Additional Input buffer. |
[in] | additonalInputSize | The size of the Additional Input buffer. Must be <= 48, and a multiple of 4. |
The CRYS_RND_DisableKatMode function disables KAT mode bit into StateFlag of global CRYS_RND_WorkingState structure.
The user must call this function after KAT tests before actual using RND module (Instantiation etc.).
- Returns
- CRYS_OK on success.
-
A non-zero value from crys_rnd_error.h on failure.
- Parameters
-
[in,out] | rndContext_ptr | Pointer to the RND context buffer. |
The CRYS_RND_EnterKatMode function sets KAT mode bit into StateFlag of global CRYS_RND_WorkingState structure.
The user must call this function before calling functions performing KAT tests.
- Note
- Total size of entropy and nonce must be not great than: CRYS_RND_MAX_KAT_ENTROPY_AND_NONCE_SIZE, defined.
- Returns
- CRYS_OK on success.
-
A non-zero value from crys_rnd_error.h on failure.
- Parameters
-
[in,out] | rndContext_ptr | Pointer to the RND context buffer. |
[in] | entrData_ptr | Entropy data. |
[in] | entrSize | Entropy size in bytes. |
[in] | nonce_ptr | Nonce. |
[in] | nonceSize | Entropy size in bytes. |
[out] | workBuff_ptr | RND working buffer, must be the same buffer, which should be passed into Instantiation/Reseeding functions. |
Generates a random vector according to the algorithm defined in referenced standard [SP800-90] - 10.2.1.5.2 - CTR-DRBG. The generation algorithm uses AES (FIPS-PUB 197) and Derivation Function (DF).
- Note
-
The RND module must be instantiated prior to invocation of this API.
-
In the following cases, Reseeding operation must be performed prior to vector generation:
-
Prediction resistance is required.
-
The function returns CRYS_RND_RESEED_COUNTER_OVERFLOW_ERROR, stating that the Reseed Counter has passed its upper-limit (2^32-2).
- Returns
- CRYS_OK on success.
-
A non-zero value from crys_rnd_error.h on failure.
- Parameters
-
[in,out] | rndState_ptr | Pointer to the RND state structure, which is part of the RND context structure. Use rndContext->rndState field of the context for this parameter. |
[in] | outSizeBytes | The size in bytes of the random vector required. The maximal size is 2^16 -1 bytes. |
[out] | out_ptr | The pointer to output buffer. |
CRYSError_t CRYS_RND_GenerateVectorInRange |
( |
CRYS_RND_Context_t * |
rndContext_ptr, |
|
|
uint32_t |
rndSizeInBits, |
|
|
uint8_t * |
maxVect_ptr, |
|
|
uint8_t * |
rndVect_ptr |
|
) |
| |
Generates a random vector with specific limitations by testing candidates (described and used in FIPS 186-4: B.1.2, B.4.2 etc.).
This function will draw a random vector, compare it to the range limits, and if within range - return it in rndVect_ptr. If outside the range, the function will continue retrying until a conforming vector is found, or the maximal retries limit is exceeded. If maxVect_ptr is provided, rndSizeInBits specifies its size, and the output vector must conform to the range [1 < rndVect < maxVect_ptr]. If maxVect_ptr is NULL, rndSizeInBits specifies the exact required vector size, and the output vector must be the exact same bit size (with its most significant bit = 1).
- Note
- The RND module must be instantiated prior to invocation of this API.
- Returns
- CRYS_OK on success.
-
A non-zero value from crys_rnd_error.h on failure.
- Parameters
-
[in,out] | rndContext_ptr | Pointer to the RND context buffer. |
[in] | rndSizeInBits | The size in bits of the random vector required. The allowed size in range 2 <= rndSizeInBits < 2^19-1, bits. |
[in] | maxVect_ptr | Pointer to the vector defining the upper limit for the random vector output, Given as little-endian byte array. If not NULL, its actual size is treated as [(rndSizeInBits+7)/8] bytes. |
[in,out] | rndVect_ptr | Pointer to the output buffer for the random vector. Must be at least [(rndSizeInBits+7)/8] bytes. Treated as little-endian byte array. |
This function initializes the RND context. It must be called at least once prior to using this context with any API that requires it as a parameter (e.g., other RND APIs, asymmetric cryptography key generation and signatures). It is called as part of ARM TrustZone CryptoCell library initialization, which initializes and returns the primary RND context. This primary context can be used as a single global context for all RND needs. Alternatively, other contexts may be initialized and used with a more limited scope (for specific applications or specific threads). The call to this function must be followed by a call to CRYS_RND_SetGenerateVectorFunc API to set the generate vector function. It implements referenced standard [SP800-90] - 10.2.1.3.2 - CTR-DRBG Instantiate algorithm using AES (FIPS-PUB 197) and Derivation Function (DF).
- Note
- Additional data can be mixed with the random seed (personalization data or nonce). If required, this data should be provided by calling CRYS_RND_AddAdditionalInput prior to using this API.
- Returns
- CRYS_OK on success.
-
A non-zero value from crys_rnd_error.h on failure.
- Parameters
-
[in,out] | rndContext_ptr | Pointer to the RND context buffer allocated by the user, which is used to maintain the RND state, as well as pointers to the functions used for random vector generation. This context must be saved and provided as a parameter to any API that uses the RND module. |
- Note
- the context must be cleared before sent to the function.
- Parameters
-
[in,out] | rndWorkBuff_ptr | Scratchpad for the RND module's work. |
This function is used for reseeding the RNG with additional entropy and additional user-provided input. (additional data should be provided by calling CRYS_RND_AddAdditionalInput prior to using this API). It implements referenced standard [SP800-90] - 10.2.1.4.2 - CTR-DRBG Reseeding algorithm, using AES (FIPS-PUB 197) and Derivation Function (DF).
- Returns
- CRYS_OK on success.
-
A non-zero value from crys_rnd_error.h on failure.
- Parameters
-
[in,out] | rndContext_ptr | Pointer to the RND context buffer. |
[in,out] | rndWorkBuff_ptr | Scratchpad for the RND module's work. |
This function sets the RND vector generation function into the RND context.
It must be called after CRYS_RND_Instantiation, and prior to any other API that requires the RND context as parameter. It is called as part of ARM TrustZone CryptoCell library initialization, to set the RND vector generation function into the primary RND context, after CRYS_RND_Instantiation is called.
- Returns
- CRYS_OK on success.
-
A non-zero value from crys_rnd_error.h on failure.
- Parameters
-
[in,out] | rndContext_ptr | Pointer to the RND context buffer allocated by the user, which is used to maintain the RND state as well as pointers to the functions used for random vector generation. |
[in] | rndGenerateVectFunc | Pointer to the random vector generation function. The pointer should point to the CRYS_RND_GenerateVector function. |
Clears existing RNG instantiation state.
- Returns
- CRYS_OK on success.
-
A non-zero value from crys_rnd_error.h on failure.
- Parameters
-
[in,out] | rndContext_ptr | Pointer to the RND context buffer. |