Skip to content

Commit d1e94d6

Browse files
committed
docs: add quick high-level getting started
1 parent 9dc8227 commit d1e94d6

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,25 @@ Test vectors are maintained as JSON test vector data, with accompanying
99
[JSON schema](https://json-schema.org/docs) files that document the structure
1010
of the test vector data.
1111

12+
## Getting started
13+
14+
1. Clone this repository. You may also want to integrate Wycheproof as a Git
15+
submodule or otherwise set up automation to keep track of changes over time.
16+
2. Write (_or generate from the JSON schema files_) code to load the vector data
17+
as appropriate for your implementation language/project.
18+
3. For each algorithm of interest, identify the inputs to your cryptography
19+
APIs, and the produced outputs, mapping back to what the test vectors
20+
provide.
21+
4. Iterate through applicable test vectors, ensuring that the results
22+
produced by your API when given the relevant input data matches the test
23+
vector expected results.
24+
5. For best results, integrate this process into your continuous integration
25+
(CI) process so tests are run for all new contributions/changes.
26+
27+
You may find it helpful to examine how other projects like
28+
[pyca/cryptography](https://github.com/pyca/cryptography) have
29+
[integrated Wycheproof's test vectors](https://github.com/pyca/cryptography/tree/ec689a96c98037fc9929e830f551a85cac3973d3/tests/wycheproof).
30+
1231
## Coverage
1332

1433
Project Wycheproof has test vectors for the most popular crypto algorithms,

0 commit comments

Comments
 (0)