Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refer to (new) Hacl_HMAC_DRBG_free and fix duplicate documentation. #298

Merged
merged 4 commits into from
Dec 7, 2022
Merged

Refer to (new) Hacl_HMAC_DRBG_free and fix duplicate documentation. #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
38e9bb6
docs: Refer to `Hacl_HMAC_DRBG_free` in documentation.
duesee Dec 6, 2022
83af496
fix(docs): Rely on HACL DRBG documentation from hacl-star.
duesee Dec 6, 2022
255e1dc
fixup! docs: Refer to `Hacl_HMAC_DRBG_free` in documentation.
duesee Dec 6, 2022
eb05da7
Update `config/default_config.cmake`.
duesee Dec 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions config/default_config.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,17 +123,16 @@ set(INCLUDES
${PROJECT_SOURCE_DIR}/include/Hacl_Poly1305_32.h
${PROJECT_SOURCE_DIR}/include/Hacl_Curve25519_51.h
${PROJECT_SOURCE_DIR}/include/Hacl_Bignum25519_51.h
${PROJECT_SOURCE_DIR}/include/internal/Hacl_Krmllib.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_Krmllib.h
${PROJECT_SOURCE_DIR}/include/Hacl_HMAC_DRBG.h
${PROJECT_SOURCE_DIR}/include/Hacl_Spec.h
${PROJECT_SOURCE_DIR}/include/Hacl_HMAC.h
${PROJECT_SOURCE_DIR}/include/Hacl_Impl_Blake2_Constants.h
${PROJECT_SOURCE_DIR}/include/Hacl_Hash_SHA2.h
${PROJECT_SOURCE_DIR}/include/Hacl_Hash_SHA1.h
${PROJECT_SOURCE_DIR}/include/internal/Hacl_Ed25519.h
${PROJECT_SOURCE_DIR}/include/internal/Hacl_Hash_SHA2.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_Hash_SHA2.h
${PROJECT_SOURCE_DIR}/include/internal/Hacl_Streaming_SHA2.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_Streaming_SHA2.h
${PROJECT_SOURCE_DIR}/include/Hacl_SHA2_Generic.h
${PROJECT_SOURCE_DIR}/include/internal/Hacl_Curve25519_51.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_Curve25519_51.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_Ed25519.h
Expand Down Expand Up @@ -203,10 +202,11 @@ set(INCLUDES
${PROJECT_SOURCE_DIR}/include/Hacl_Impl_FFDHE_Constants.h
${PROJECT_SOURCE_DIR}/include/Hacl_SHA3.h
${PROJECT_SOURCE_DIR}/include/Hacl_Streaming_SHA3.h
${PROJECT_SOURCE_DIR}/include/Hacl_SHA2_Generic.h
${PROJECT_SOURCE_DIR}/include/internal/Hacl_Hash_SHA2.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_Hash_SHA2.h
${PROJECT_SOURCE_DIR}/include/Hacl_SHA2_Vec128.h
${PROJECT_SOURCE_DIR}/include/internal/Hacl_SHA2_Types.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_SHA2_Types.h
${PROJECT_SOURCE_DIR}/include/Hacl_SHA2_Vec128.h
${PROJECT_SOURCE_DIR}/include/Hacl_SHA2_Vec256.h
${PROJECT_SOURCE_DIR}/include/internal/Hacl_Hash_SHA1.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_Hash_SHA1.h
Expand Down Expand Up @@ -273,14 +273,14 @@ set(PUBLIC_INCLUDES
${PROJECT_SOURCE_DIR}/include/Hacl_Poly1305_32.h
${PROJECT_SOURCE_DIR}/include/Hacl_Curve25519_51.h
${PROJECT_SOURCE_DIR}/include/Hacl_Bignum25519_51.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_Krmllib.h
${PROJECT_SOURCE_DIR}/include/Hacl_HMAC_DRBG.h
${PROJECT_SOURCE_DIR}/include/Hacl_Spec.h
${PROJECT_SOURCE_DIR}/include/Hacl_HMAC.h
${PROJECT_SOURCE_DIR}/include/Hacl_Impl_Blake2_Constants.h
${PROJECT_SOURCE_DIR}/include/Hacl_Hash_SHA2.h
${PROJECT_SOURCE_DIR}/include/Hacl_Hash_SHA1.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_Hash_SHA2.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_Streaming_SHA2.h
${PROJECT_SOURCE_DIR}/include/Hacl_SHA2_Generic.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_Curve25519_51.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_Ed25519.h
${PROJECT_SOURCE_DIR}/include/Hacl_Streaming_SHA2.h
Expand Down Expand Up @@ -338,9 +338,9 @@ set(PUBLIC_INCLUDES
${PROJECT_SOURCE_DIR}/include/Hacl_Impl_FFDHE_Constants.h
${PROJECT_SOURCE_DIR}/include/Hacl_SHA3.h
${PROJECT_SOURCE_DIR}/include/Hacl_Streaming_SHA3.h
${PROJECT_SOURCE_DIR}/include/Hacl_SHA2_Generic.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_SHA2_Types.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_Hash_SHA2.h
${PROJECT_SOURCE_DIR}/include/Hacl_SHA2_Vec128.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_SHA2_Types.h
${PROJECT_SOURCE_DIR}/include/Hacl_SHA2_Vec256.h
${PROJECT_SOURCE_DIR}/include/internal/../Hacl_Hash_SHA1.h
${PROJECT_SOURCE_DIR}/include/Hacl_Streaming_SHA1.h
Expand Down Expand Up @@ -455,6 +455,7 @@ set(BENCHMARK_SOURCES
${PROJECT_SOURCE_DIR}/benchmarks/x25519.cc
${PROJECT_SOURCE_DIR}/benchmarks/ed25519.cc
${PROJECT_SOURCE_DIR}/benchmarks/p256.cc
${PROJECT_SOURCE_DIR}/benchmarks/sha2.cc
${PROJECT_SOURCE_DIR}/benchmarks/k256.cc
)
set(VALE_SOURCES_osx
Expand Down
67 changes: 1 addition & 66 deletions docs/reference/hacl/randomness/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,85 +42,20 @@ Deterministic Random Bit Generator (DRBG) (NIST, SP 800-90A).
```{doxygenfunction} Hacl_HMAC_DRBG_create_in
```

Create a DRBG state.

* `a` Hash algorithm to use. The possible instantiations are ...

* `Spec_Hash_Definitions_SHA2_256`,
* `Spec_Hash_Definitions_SHA2_384`,
* `Spec_Hash_Definitions_SHA2_512`, and
* `Spec_Hash_Definitions_SHA1`.

<!--
```{doxygenfunction} Hacl_HMAC_DRBG_uu___is_State
```
-->

```{doxygenfunction} Hacl_HMAC_DRBG_instantiate
```

Instantiate the DRBG.

* `a` Hash algorithm to use. (Value must match the value used in `Hacl_HMAC_DRBG_create_in`.)
* `st` Pointer to DRBG state.
* `entropy_input_len` Length of entropy input.
* `entropy_input` Pointer to `entropy_input_len` bytes of memory where entropy input is read from.
* `nonce_len` Length of nonce.
* `nonce` Pointer to `nonce_len` bytes of memory where nonce is read from.
* `personalization_string_len` length of personalization string.
* `personalization_string` Pointer to `personalization_string_len` bytes of memory where personalization string is read from.

```{doxygenfunction} Hacl_HMAC_DRBG_reseed
```

Reseed the DRBG.

* `a` Hash algorithm to use. (Value must match the value used in `Hacl_HMAC_DRBG_create_in`.)
* `st` Pointer to DRBG state.
* `entropy_input_len` Length of entropy input.
* `entropy_input` Pointer to `entropy_input_len` bytes of memory where entropy input is read from.
* `additional_input_input_len` Length of additional input.
* `additional_input_input` Pointer to `additional_input_input_len` bytes of memory where additional input is read from.

```{doxygenfunction} Hacl_HMAC_DRBG_generate
```

Generate output.

* `a` Hash algorithm to use. (Value must match the value used in `Hacl_HMAC_DRBG_create_in`.)
* `output` Pointer to `n` bytes of memory where random output is written to.
* `st` Pointer to DRBG state.
* `n` Length of desired output.
* `additional_input_input_len` Length of additional input.
* `additional_input_input` Pointer to `additional_input_input_len` bytes of memory where additional input is read from.

<!--
```{doxygenfunction} Hacl_HMAC_DRBG_free
```
-->

````{warning}
**Cleanup and free the DRBG state.**

Currently, there is no free function available. You can use ...

```C
void free_state(Hacl_HMAC_DRBG_state* state)
{
KRML_HOST_FREE(state->k);
KRML_HOST_FREE(state->reseed_counter);
KRML_HOST_FREE(state->v);
}
```

... to cleanup the state.

````
Free the DRBG state.

```{doxygenfunction} Hacl_HMAC_DRBG_min_length
```

Return the minimal entropy input length of the desired hash function.

* `a` Hash algorithm to use.

14 changes: 3 additions & 11 deletions tests/drbg.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,6 @@ class DrbgSuite : public ::testing::Test
}
};

void
free_state(Hacl_HMAC_DRBG_state* state)
{
KRML_HOST_FREE(state->k);
KRML_HOST_FREE(state->reseed_counter);
KRML_HOST_FREE(state->v);
}

TEST(DrbgSuite, SmokeTest)
{
bytes entropy = from_hex("AA");
Expand Down Expand Up @@ -137,7 +129,7 @@ TEST(DrbgSuite, SmokeTest)
count,
additional.size(),
additional.data());
free_state(&state);
Hacl_HMAC_DRBG_free(hash, state);
EXPECT_TRUE(res);
}
}
Expand Down Expand Up @@ -207,7 +199,7 @@ TEST_P(DrbgNRSuite, KAT)
additional.data());
EXPECT_TRUE(res);
}
free_state(&state);
Hacl_HMAC_DRBG_free(hash, state);

ASSERT_EQ(test.ReturnedBits, got_ReturnedBits);
}
Expand Down Expand Up @@ -263,7 +255,7 @@ TEST_P(DrbgPRFalseSuite, KAT)

EXPECT_TRUE(res);
}
free_state(&state);
Hacl_HMAC_DRBG_free(hash, state);

ASSERT_EQ(test.ReturnedBits, got_ReturnedBits);
}
Expand Down