From dc9e48cd10f930676f49217448d5280a6ea0ee28 Mon Sep 17 00:00:00 2001 From: Mike Ounsworth Date: Sun, 21 Jul 2024 14:37:44 -0500 Subject: [PATCH] Update readme.md --- readme.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/readme.md b/readme.md index 4c4cc000..82e487c7 100644 --- a/readme.md +++ b/readme.md @@ -1,21 +1,13 @@ - # IETF Hackathon - PQC Certificates This project provides a set of data repositories for X.509 data structures that make use of post-quantum and composite algorithms (classic with PQC). -This repo represents work done between IETF 115 - 119. +This repo represents work done between IETF 115 - 120. -A summary table of the ongoing certificate interoperability testing can be found here: -https://ietf-hackathon.github.io/pqc-certificates/pqc_hackathon_results_certs_r3.html - -A summary table of the ongoing CMS interoperability testing can be found here: -https://ietf-hackathon.github.io/pqc-certificates/pqc_hackathon_results_cms_v1.html - - -An older version showing more (now obsolete) algorithms can be found here instead: -https://ietf-hackathon.github.io/pqc-certificates/pqc_hackathon_results.html +The various output compatibility tables produced by this project can be viewed here: +https://ietf-hackathon.github.io/pqc-certificates/ ## Goals - Adding PQ algorithm support into existing X.509 structures (keys, signatures, certificates and protocols) @@ -24,6 +16,11 @@ https://ietf-hackathon.github.io/pqc-certificates/pqc_hackathon_results.html - Provide a comprehensive compatibility matrix to show results - Provide feedback to the standards groups about practical usage +## Contributing and testing your artifacts +Simply upload your artifacts zip files into your own directory under `providers/`, and uploads test results CSV files into the `compatMatrices/` directory of your provider, and the github automation will: +* Validate your artifacts against the OpenQuantumSafe docker image. +* Re-build and update the results HTML pages using both the automated results, and any results CSV files that you included. + ## Folder structure of this repo The project's directory structure is as follows: