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

Changes from 1 commit
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
Next Next commit
docs: Refer to Hacl_HMAC_DRBG_free in documentation.
  • Loading branch information
@duesee
duesee committed Dec 6, 2022
commit 38e9bb6e2663e528728557b0ed0504dc26d0a51f
20 changes: 1 addition & 19 deletions docs/reference/hacl/randomness/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,28 +94,10 @@ Generate 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
```
Expand Down