diff --git a/README.md b/README.md index 39919c2645..28b4620b1d 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ The list below indicates all algorithms supported by liboqs, but not all those a - **FrodoKEM**: FrodoKEM-640-AES, FrodoKEM-640-SHAKE, FrodoKEM-976-AES, FrodoKEM-976-SHAKE, FrodoKEM-1344-AES, FrodoKEM-1344-SHAKE - **HQC**: HQC-128, HQC-192, HQC-256 - **Kyber**: Kyber512, Kyber768, Kyber1024 -- **ML-KEM**: ML-KEM-512-ipd, ML-KEM-768-ipd, ML-KEM-1024-ipd +- **ML-KEM**: ML-KEM-512-ipd (alias: ML-KEM-512), ML-KEM-768-ipd (alias: ML-KEM-768), ML-KEM-1024-ipd (alias: ML-KEM-1024) - **NTRU-Prime**: sntrup761 @@ -55,7 +55,7 @@ The list below indicates all algorithms supported by liboqs, but not all those a - **CRYSTALS-Dilithium**: Dilithium2, Dilithium3, Dilithium5 - **Falcon**: Falcon-512, Falcon-1024 -- **ML-DSA**: ML-DSA-44-ipd, ML-DSA-65-ipd, ML-DSA-87-ipd +- **ML-DSA**: ML-DSA-44-ipd (alias: ML-DSA-44), ML-DSA-65-ipd (alias: ML-DSA-65), ML-DSA-87-ipd (alias: ML-DSA-87) - **SPHINCS+-SHA2**: SPHINCS+-SHA2-128f-simple, SPHINCS+-SHA2-128s-simple, SPHINCS+-SHA2-192f-simple, SPHINCS+-SHA2-192s-simple, SPHINCS+-SHA2-256f-simple, SPHINCS+-SHA2-256s-simple - **SPHINCS+-SHAKE**: SPHINCS+-SHAKE-128f-simple, SPHINCS+-SHAKE-128s-simple, SPHINCS+-SHAKE-192f-simple, SPHINCS+-SHAKE-192s-simple, SPHINCS+-SHAKE-256f-simple, SPHINCS+-SHAKE-256s-simple diff --git a/scripts/update_docs_from_yaml.py b/scripts/update_docs_from_yaml.py index 478ba8ddeb..ef152d376a 100644 --- a/scripts/update_docs_from_yaml.py +++ b/scripts/update_docs_from_yaml.py @@ -295,13 +295,21 @@ def do_it(liboqs_root): parameter_sets = kem_yaml['parameter-sets'] if any(impl['large-stack-usage'] for impl in parameter_sets[0]['implementations']): readme.write('- **{}**: {}†'.format(kem_yaml['name'], parameter_sets[0]['name'])) + if 'alias' in parameter_sets[0]: + readme.write(' (alias: {})'.format(parameter_sets[0]['alias'])) else: readme.write('- **{}**: {}'.format(kem_yaml['name'], parameter_sets[0]['name'])) + if 'alias' in parameter_sets[0]: + readme.write(' (alias: {})'.format(parameter_sets[0]['alias'])) for parameter_set in parameter_sets[1:]: if any(impl['large-stack-usage'] for impl in parameter_set['implementations']): readme.write(', {}†'.format(parameter_set['name'])) + if 'alias' in parameter_set: + readme.write(' (alias: {})'.format(parameter_set['alias'])) else: readme.write(', {}'.format(parameter_set['name'])) + if 'alias' in parameter_set: + readme.write(' (alias: {})'.format(parameter_set['alias'])) readme.write('\n') readme.write(postamble) @@ -322,13 +330,21 @@ def do_it(liboqs_root): parameter_sets = sig_yaml['parameter-sets'] if any(impl['large-stack-usage'] for impl in parameter_sets[0]['implementations']): readme.write('- **{}**: {}†'.format(sig_yaml['name'], parameter_sets[0]['name'].replace('_','\_'))) + if 'alias' in parameter_sets[0]: + readme.write(' (alias: {})'.format(parameter_sets[0]['alias']).replace('_','\_')) else: readme.write('- **{}**: {}'.format(sig_yaml['name'], parameter_sets[0]['name'].replace('_','\_'))) + if 'alias' in parameter_sets[0]: + readme.write(' (alias: {})'.format(parameter_sets[0]['alias']).replace('_','\_')) for parameter_set in parameter_sets[1:]: if any(impl['large-stack-usage'] for impl in parameter_set['implementations']): readme.write(', {}†'.format(parameter_set['name'].replace('_', '\_'))) + if 'alias' in parameter_set: + readme.write(' (alias: {})'.format(parameter_set['alias']).replace('_','\_')) else: readme.write(', {}'.format(parameter_set['name'].replace('_', '\_'))) + if 'alias' in parameter_set: + readme.write(' (alias: {})'.format(parameter_set['alias']).replace('_','\_')) readme.write('\n') sphincs_yml = sig_yamls[-1]