Skip to content

Commit

Permalink
MAYO naming convention update: - instead of _ [trigger downstream]
Browse files Browse the repository at this point in the history
Signed-off-by: Basil Hess <[email protected]>
  • Loading branch information
bhess committed Jul 11, 2024
1 parent ca5d956 commit 86efabc
Show file tree
Hide file tree
Showing 161 changed files with 111 additions and 99 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ All names other than `ML-KEM` and `ML-DSA` are subject to change. `liboqs` makes
<!--- OQS_TEMPLATE_FRAGMENT_LIST_SIGS_START -->
- **CRYSTALS-Dilithium**: Dilithium2, Dilithium3, Dilithium5
- **Falcon**: Falcon-512, Falcon-1024, Falcon-padded-512, Falcon-padded-1024
- **MAYO**: MAYO\_1, MAYO\_2, MAYO\_3, MAYO\_5
- **MAYO**: MAYO-1, MAYO-2, MAYO-3, MAYO-5
- **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
Expand Down
18 changes: 9 additions & 9 deletions docs/algorithms/sig/mayo.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@
- **Authors' website**: https://pqmayo.org
- **Specification version**: https://eprint.iacr.org/2023/1683.
- **Primary Source**<a name="primary-source"></a>:
- **Source**: https://github.com/PQCMayo/MAYO-C/commit/fc9079fb5ac5cd4af98e3e0f094a0a3cf2a01499 with copy_from_upstream patches
- **Source**: https://github.com/PQCMayo/MAYO-C/commit/cde2675ff404b0ae070e7dbc3d962ea0b026a81e with copy_from_upstream patches
- **Implementation license (SPDX-Identifier)**: Apache-2.0


## Parameter set summary

| Parameter set | Parameter set alias | Security model | Claimed NIST Level | Public key size (bytes) | Secret key size (bytes) | Signature size (bytes) |
|:---------------:|:----------------------|:-----------------|---------------------:|--------------------------:|--------------------------:|-------------------------:|
| MAYO\_1 | NA | EUF-CMA | 1 | 1168 | 24 | 321 |
| MAYO\_2 | NA | EUF-CMA | 1 | 5488 | 24 | 180 |
| MAYO\_3 | NA | EUF-CMA | 3 | 2656 | 32 | 577 |
| MAYO\_5 | NA | EUF-CMA | 5 | 5008 | 40 | 838 |
| MAYO-1 | NA | EUF-CMA | 1 | 1168 | 24 | 321 |
| MAYO-2 | NA | EUF-CMA | 1 | 5488 | 24 | 180 |
| MAYO-3 | NA | EUF-CMA | 3 | 2656 | 32 | 577 |
| MAYO-5 | NA | EUF-CMA | 5 | 5008 | 40 | 838 |

## MAYO\_1 implementation characteristics
## MAYO-1 implementation characteristics

| Implementation source | Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage?‡ |
|:---------------------------------:|:-------------------------|:----------------------------|:--------------------------------|:------------------------|:-----------------------------------|:-----------------------------------------------|:----------------------|
Expand All @@ -30,7 +30,7 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.

‡For an explanation of what this denotes, consult the [Explanation of Terms](#explanation-of-terms) section at the end of this file.

## MAYO\_2 implementation characteristics
## MAYO-2 implementation characteristics

| Implementation source | Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage? |
|:---------------------------------:|:-------------------------|:----------------------------|:--------------------------------|:------------------------|:-----------------------------------|:-----------------------------------------------|:---------------------|
Expand All @@ -39,7 +39,7 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.

Are implementations chosen based on runtime CPU feature detection? **Yes**.

## MAYO\_3 implementation characteristics
## MAYO-3 implementation characteristics

| Implementation source | Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage? |
|:---------------------------------:|:-------------------------|:----------------------------|:--------------------------------|:------------------------|:-----------------------------------|:-----------------------------------------------|:---------------------|
Expand All @@ -48,7 +48,7 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.

Are implementations chosen based on runtime CPU feature detection? **Yes**.

## MAYO\_5 implementation characteristics
## MAYO-5 implementation characteristics

| Implementation source | Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage? |
|:---------------------------------:|:-------------------------|:----------------------------|:--------------------------------|:------------------------|:-----------------------------------|:-----------------------------------------------|:---------------------|
Expand Down
10 changes: 5 additions & 5 deletions docs/algorithms/sig/mayo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ website: https://pqmayo.org
nist-round: 1
spec-version: https://eprint.iacr.org/2023/1683
primary-upstream:
source: https://github.com/PQCMayo/MAYO-C/commit/fc9079fb5ac5cd4af98e3e0f094a0a3cf2a01499
source: https://github.com/PQCMayo/MAYO-C/commit/cde2675ff404b0ae070e7dbc3d962ea0b026a81e
with copy_from_upstream patches
spdx-license-identifier: Apache-2.0
parameter-sets:
- name: MAYO_1
- name: MAYO-1
claimed-nist-level: 1
claimed-security: EUF-CMA
length-public-key: 1168
Expand Down Expand Up @@ -47,7 +47,7 @@ parameter-sets:
no-secret-dependent-branching-claimed: true
no-secret-dependent-branching-checked-by-valgrind: true
large-stack-usage: false
- name: MAYO_2
- name: MAYO-2
claimed-nist-level: 1
claimed-security: EUF-CMA
length-public-key: 5488
Expand Down Expand Up @@ -79,7 +79,7 @@ parameter-sets:
no-secret-dependent-branching-claimed: true
no-secret-dependent-branching-checked-by-valgrind: true
large-stack-usage: false
- name: MAYO_3
- name: MAYO-3
claimed-nist-level: 3
claimed-security: EUF-CMA
length-public-key: 2656
Expand Down Expand Up @@ -110,7 +110,7 @@ parameter-sets:
no-secret-dependent-branching-claimed: true
no-secret-dependent-branching-checked-by-valgrind: true
large-stack-usage: false
- name: MAYO_5
- name: MAYO-5
claimed-nist-level: 5
claimed-security: EUF-CMA
length-public-key: 5008
Expand Down
78 changes: 39 additions & 39 deletions docs/cbom.json
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
{
"bomFormat": "CBOM",
"specVersion": "1.4-cbom-1.0",
"serialNumber": "urn:uuid:dbce4160-9dc5-450c-b83c-0cb0345d7045",
"serialNumber": "urn:uuid:004d7395-7601-44af-97dd-57c2214e5f60",
"version": 1,
"metadata": {
"timestamp": "2024-05-24T18:35:02.761477",
"timestamp": "2024-07-11T15:22:22.228289",
"component": {
"type": "library",
"bom-ref": "pkg:github/open-quantum-safe/liboqs@580d494efeee25edd354eaa2e0fe6581d552b827",
"bom-ref": "pkg:github/open-quantum-safe/liboqs@ca5d956097e10672aaa9bb7994057bcc58291b65",
"name": "liboqs",
"version": "580d494efeee25edd354eaa2e0fe6581d552b827"
"version": "ca5d956097e10672aaa9bb7994057bcc58291b65"
}
},
"components": [
{
"type": "library",
"bom-ref": "pkg:github/open-quantum-safe/liboqs@580d494efeee25edd354eaa2e0fe6581d552b827",
"bom-ref": "pkg:github/open-quantum-safe/liboqs@ca5d956097e10672aaa9bb7994057bcc58291b65",
"name": "liboqs",
"version": "580d494efeee25edd354eaa2e0fe6581d552b827"
"version": "ca5d956097e10672aaa9bb7994057bcc58291b65"
},
{
"type": "crypto-asset",
Expand Down Expand Up @@ -1541,12 +1541,12 @@
},
{
"type": "crypto-asset",
"bom-ref": "alg:MAYO_1:generic",
"bom-ref": "alg:MAYO-1:generic",
"name": "MAYO",
"cryptoProperties": {
"assetType": "algorithm",
"algorithmProperties": {
"variant": "MAYO_1",
"variant": "MAYO-1",
"primitive": "signature",
"implementationLevel": "softwarePlainRam",
"cryptoFunctions": [
Expand All @@ -1561,12 +1561,12 @@
},
{
"type": "crypto-asset",
"bom-ref": "alg:MAYO_1:x86_64",
"bom-ref": "alg:MAYO-1:x86_64",
"name": "MAYO",
"cryptoProperties": {
"assetType": "algorithm",
"algorithmProperties": {
"variant": "MAYO_1",
"variant": "MAYO-1",
"primitive": "signature",
"implementationLevel": "softwarePlainRam",
"cryptoFunctions": [
Expand All @@ -1581,12 +1581,12 @@
},
{
"type": "crypto-asset",
"bom-ref": "alg:MAYO_2:generic",
"bom-ref": "alg:MAYO-2:generic",
"name": "MAYO",
"cryptoProperties": {
"assetType": "algorithm",
"algorithmProperties": {
"variant": "MAYO_2",
"variant": "MAYO-2",
"primitive": "signature",
"implementationLevel": "softwarePlainRam",
"cryptoFunctions": [
Expand All @@ -1601,12 +1601,12 @@
},
{
"type": "crypto-asset",
"bom-ref": "alg:MAYO_2:x86_64",
"bom-ref": "alg:MAYO-2:x86_64",
"name": "MAYO",
"cryptoProperties": {
"assetType": "algorithm",
"algorithmProperties": {
"variant": "MAYO_2",
"variant": "MAYO-2",
"primitive": "signature",
"implementationLevel": "softwarePlainRam",
"cryptoFunctions": [
Expand All @@ -1621,12 +1621,12 @@
},
{
"type": "crypto-asset",
"bom-ref": "alg:MAYO_3:generic",
"bom-ref": "alg:MAYO-3:generic",
"name": "MAYO",
"cryptoProperties": {
"assetType": "algorithm",
"algorithmProperties": {
"variant": "MAYO_3",
"variant": "MAYO-3",
"primitive": "signature",
"implementationLevel": "softwarePlainRam",
"cryptoFunctions": [
Expand All @@ -1641,12 +1641,12 @@
},
{
"type": "crypto-asset",
"bom-ref": "alg:MAYO_3:x86_64",
"bom-ref": "alg:MAYO-3:x86_64",
"name": "MAYO",
"cryptoProperties": {
"assetType": "algorithm",
"algorithmProperties": {
"variant": "MAYO_3",
"variant": "MAYO-3",
"primitive": "signature",
"implementationLevel": "softwarePlainRam",
"cryptoFunctions": [
Expand All @@ -1661,12 +1661,12 @@
},
{
"type": "crypto-asset",
"bom-ref": "alg:MAYO_5:generic",
"bom-ref": "alg:MAYO-5:generic",
"name": "MAYO",
"cryptoProperties": {
"assetType": "algorithm",
"algorithmProperties": {
"variant": "MAYO_5",
"variant": "MAYO-5",
"primitive": "signature",
"implementationLevel": "softwarePlainRam",
"cryptoFunctions": [
Expand All @@ -1681,12 +1681,12 @@
},
{
"type": "crypto-asset",
"bom-ref": "alg:MAYO_5:x86_64",
"bom-ref": "alg:MAYO-5:x86_64",
"name": "MAYO",
"cryptoProperties": {
"assetType": "algorithm",
"algorithmProperties": {
"variant": "MAYO_5",
"variant": "MAYO-5",
"primitive": "signature",
"implementationLevel": "softwarePlainRam",
"cryptoFunctions": [
Expand Down Expand Up @@ -2328,7 +2328,7 @@
],
"dependencies": [
{
"ref": "pkg:github/open-quantum-safe/liboqs@580d494efeee25edd354eaa2e0fe6581d552b827",
"ref": "pkg:github/open-quantum-safe/liboqs@ca5d956097e10672aaa9bb7994057bcc58291b65",
"dependsOn": [
"alg:BIKE-L1:x86_64",
"alg:BIKE-L3:x86_64",
Expand Down Expand Up @@ -2406,14 +2406,14 @@
"alg:Falcon-padded-1024:generic",
"alg:Falcon-padded-1024:x86_64",
"alg:Falcon-padded-1024:armv8-a",
"alg:MAYO_1:generic",
"alg:MAYO_1:x86_64",
"alg:MAYO_2:generic",
"alg:MAYO_2:x86_64",
"alg:MAYO_3:generic",
"alg:MAYO_3:x86_64",
"alg:MAYO_5:generic",
"alg:MAYO_5:x86_64",
"alg:MAYO-1:generic",
"alg:MAYO-1:x86_64",
"alg:MAYO-2:generic",
"alg:MAYO-2:x86_64",
"alg:MAYO-3:generic",
"alg:MAYO-3:x86_64",
"alg:MAYO-5:generic",
"alg:MAYO-5:x86_64",
"alg:ML-DSA-44-ipd:generic",
"alg:ML-DSA-44-ipd:x86_64",
"alg:ML-DSA-65-ipd:generic",
Expand Down Expand Up @@ -3012,61 +3012,61 @@
"dependencyType": "uses"
},
{
"ref": "alg:MAYO_1:generic",
"ref": "alg:MAYO-1:generic",
"dependsOn": [
"alg:sha3",
"alg:aes"
],
"dependencyType": "uses"
},
{
"ref": "alg:MAYO_1:x86_64",
"ref": "alg:MAYO-1:x86_64",
"dependsOn": [
"alg:sha3",
"alg:aes"
],
"dependencyType": "uses"
},
{
"ref": "alg:MAYO_2:generic",
"ref": "alg:MAYO-2:generic",
"dependsOn": [
"alg:sha3",
"alg:aes"
],
"dependencyType": "uses"
},
{
"ref": "alg:MAYO_2:x86_64",
"ref": "alg:MAYO-2:x86_64",
"dependsOn": [
"alg:sha3",
"alg:aes"
],
"dependencyType": "uses"
},
{
"ref": "alg:MAYO_3:generic",
"ref": "alg:MAYO-3:generic",
"dependsOn": [
"alg:sha3"
],
"dependencyType": "uses"
},
{
"ref": "alg:MAYO_3:x86_64",
"ref": "alg:MAYO-3:x86_64",
"dependsOn": [
"alg:sha3",
"alg:aes"
],
"dependencyType": "uses"
},
{
"ref": "alg:MAYO_5:generic",
"ref": "alg:MAYO-5:generic",
"dependsOn": [
"alg:sha3"
],
"dependencyType": "uses"
},
{
"ref": "alg:MAYO_5:x86_64",
"ref": "alg:MAYO-5:x86_64",
"dependsOn": [
"alg:sha3",
"alg:aes"
Expand Down
18 changes: 9 additions & 9 deletions scripts/copy_from_upstream/copy_from_upstream.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ upstreams:
name: pqmayo
git_url: https://github.com/PQCMayo/MAYO-C.git
git_branch: nibbling-mayo
git_commit: fc9079fb5ac5cd4af98e3e0f094a0a3cf2a01499
git_commit: cde2675ff404b0ae070e7dbc3d962ea0b026a81e
sig_meta_path: 'META/{pretty_name_full}_META.yml'
sig_scheme_path: '.'
patches: [pqmayo-aes.patch, pqmayo-mem.patch]
Expand Down Expand Up @@ -316,21 +316,21 @@ sigs:
schemes:
-
scheme: "1"
pqclean_scheme: mayo_1
pretty_name_full: MAYO_1
pqclean_scheme: mayo-1
pretty_name_full: MAYO-1
signed_msg_order: sig_then_msg
-
scheme: "2"
pqclean_scheme: mayo_2
pretty_name_full: MAYO_2
pqclean_scheme: mayo-2
pretty_name_full: MAYO-2
signed_msg_order: sig_then_msg
-
scheme: "3"
pqclean_scheme: mayo_3
pretty_name_full: MAYO_3
pqclean_scheme: mayo-3
pretty_name_full: MAYO-3
signed_msg_order: sig_then_msg
-
scheme: "5"
pqclean_scheme: mayo_5
pretty_name_full: MAYO_5
pqclean_scheme: mayo-5
pretty_name_full: MAYO-5
signed_msg_order: sig_then_msg
Loading

0 comments on commit 86efabc

Please sign in to comment.