Add Readme.md

This commit is contained in:
2023-08-08 14:14:09 +02:00
parent 060d52b1d8
commit c20a2843a3
2 changed files with 19 additions and 2 deletions

19
Readme.md Normal file
View File

@@ -0,0 +1,19 @@
# SP800-90B_EntropyAssessment
This repo is an attempt at binding the C++ NIST implementation to be used in Rust code.
## Disclaimer
This software is a repackaged and slightly modified version of a NIST-developed project [(that can be found here: https://github.com/usnistgov/SP800-90B_EntropyAssessment)](https://github.com/usnistgov/SP800-90B_EntropyAssessment).
The new C++ headers are modified version of those found in this python bindings [repository](https://github.com/hnj2/sp800_90b).
### Original NIST Disclaimer
NIST-developed software is provided by NIST as a public service. You may use, copy and distribute copies of the software in any medium, provided that you keep intact this entire notice. You may improve, modify and create derivative works of the software or any portion of the software, and you may distribute such modifications or works. Modified works should carry a notice stating that you changed the software and should note the date and nature of any such change. Please explicitly acknowledge the National Institute of Standards and Technology as the source of the software.
### Modifications
The modifications that were made were are:
- Adding a header file and some helper functions to wrap the provided nist code inside an object file that can be linked to other components ([`src/cpp/nist.hpp`](src/cpp/nist.hpp)).
- Writing a class that provides the functionality of the nist code as a class interface ([`src/cpp/data.hpp`](src/cpp/data.hpp)).

View File

@@ -1,8 +1,6 @@
use SP800_90B_rs::generate_data;
use rand::Rng;
fn main() {
// println!("Hello, world!");