Skip to content
This repository was archived by the owner on Jan 8, 2025. It is now read-only.

Commit 94df6b1

Browse files
authored
Code point documentation update (#458)
* update ID information to point to oqs-provider [skip ci] * update ID information to point to oqs-provider [skip ci] * persist KEM/SIG code point doc warning across generate runs [skip ci] * correct newline [skip ci]
1 parent 70d83ca commit 94df6b1

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed

oqs-template/generate_oid_nid_table.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ def gen_sig_table(oqslibdocdir):
6868
hybrid['oid']])
6969

7070
with open(os.path.join('oqs-template', 'oqs-sig-info.md'), mode='w', encoding='utf-8') as f:
71+
f.write("## Note: As oqs-openssl111 is phased out, please rely on the new iteration of this information at https://github.com/open-quantum-safe/oqs-provider/blob/main/oqs-template/oqs-sig-info.md\n\n")
7172
f.write(tabulate(table, tablefmt="pipe", headers="firstrow"))
7273
print("Written oqs-sig-info.md")
7374

@@ -142,6 +143,7 @@ def gen_kem_table(oqslibdocdir):
142143
table = [table_header] + table
143144

144145
with open(os.path.join('oqs-template', 'oqs-kem-info.md'), mode='w', encoding='utf-8') as f:
146+
f.write("## Note: As oqs-openssl111 is phased out, please rely on the new iteration of this information at https://github.com/open-quantum-safe/oqs-provider/blob/main/oqs-template/oqs-kem-info.md\n\n")
145147
f.write(tabulate(table, tablefmt="pipe", headers="firstrow"))
146148
f.write("\n")
147149
print("Written oqs-kem-info.md")

oqs-template/oqs-kem-info.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
## Note: As oqs-openssl111 is phased out, please rely on the new iteration of this information at https://github.com/open-quantum-safe/oqs-provider/blob/main/oqs-template/oqs-kem-info.md
2+
13
| Family | Implementation Version | Variant | NIST round | Claimed NIST Level | Code Point | Hybrid Elliptic Curve (if any) |
24
|:---------------|:-------------------------|:---------------|-------------:|---------------------:|:-------------|:---------------------------------|
35
| BIKE | 5.1 | bikel1 | 4 | 1 | 0x0241 | |

oqs-template/oqs-sig-info.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
## Note: As oqs-openssl111 is phased out, please rely on the new iteration of this information at https://github.com/open-quantum-safe/oqs-provider/blob/main/oqs-template/oqs-sig-info.md
2+
13
| Algorithm | Implementation Version | NIST round | Claimed NIST Level | Code Point | OID |
24
|:-----------------------------------------------|:----------------------------------------------|-------------:|---------------------:|:-------------|:------------------------|
35
| dilithium2 | 3.1 | 3 | 2 | 0xfea0 | 1.3.6.1.4.1.2.267.7.4.4 |
@@ -39,4 +41,4 @@
3941
| sphincsshake256fsimple | NIST Round 3 submission, v3.1 (June 10, 2022) | 3 | 5 | 0xfecc | 1.3.9999.6.9.10 |
4042
| sphincsshake256fsimple **hybrid with** p521 | NIST Round 3 submission, v3.1 (June 10, 2022) | 3 | 5 | 0xfecd | 1.3.9999.6.9.11 |
4143
| sphincsshake256ssimple | NIST Round 3 submission, v3.1 (June 10, 2022) | 3 | 5 | 0xfece | 1.3.9999.6.9.12 |
42-
| sphincsshake256ssimple **hybrid with** p521 | NIST Round 3 submission, v3.1 (June 10, 2022) | 3 | 5 | 0xfecf | 1.3.9999.6.9.13 |
44+
| sphincsshake256ssimple **hybrid with** p521 | NIST Round 3 submission, v3.1 (June 10, 2022) | 3 | 5 | 0xfecf | 1.3.9999.6.9.13 |

0 commit comments

Comments
 (0)