Internet-Draft | ACVP EdDSA | November 2024 |
Celi | Expires 5 May 2025 | [Page] |
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 5 May 2025.¶
Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document.¶
There are no acknowledgements.¶
This document defines the JSON schema for testing FIPS Pub 186 EdDSA implementations with the ACVP specification.¶
The Automated Crypto Validation Protocol (ACVP) defines a mechanism to automatically verify the cryptographic implementation of a software or hardware crypto module. The ACVP specification defines how a crypto module communicates with an ACVP server, including crypto capabilities negotiation, session management, authentication, vector processing and more. The ACVP specification does not define algorithm specific JSON constructs for performing the crypto validation. A series of ACVP sub-specifications define the constructs for testing individual crypto algorithms. Each sub-specification addresses a specific class of crypto algorithms. This sub-specification defines the JSON constructs for testing FIPS Pub 186 EdDSA implementations using ACVP.¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 of [RFC2119] and [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
The initial request from the client to the server describing the capabilities of one or several algorithm, mode and revision combinations¶
A collection of test cases that share similar properties within a prompt or response¶
A collection of test groups under a specific algorithm, mode, and revision¶
JSON sent from the server to the client that specifies the correctness of the response¶
The following EDDSA algorithms MAY be advertised by the ACVP compliant cryptographic module:¶
The ACVP server performs a set of tests on the specified EDDSA algorithm in order to assess the correctness and robustness of the implementation. A typical ACVP validation session SHALL require multiple tests to be performed for every supported permutation of EDDSA capabilities. This section describes the design of the tests used to validate implementations of the EDDSA algorithms.¶
ACVP requires crypto modules to register their capabilities. This allows the crypto module to advertise support for specific algorithms, notifying the ACVP server which algorithms need test vectors generated for the validation process. This section describes the constructs for advertising support of EdDSA algorithms to the ACVP server.¶
The algorithm capabilities MUST be advertised as JSON objects within the 'algorithms' value of the ACVP registration message. The 'algorithms' value is an array, where each array element is an individual JSON object defined in this section. The 'algorithms' value is part of the 'capability_exchange' element of the ACVP JSON registration message. See the ACVP specification [ACVP] for more details on the registration message.¶
Each algorithm implementation MAY rely on other cryptographic primitives. For example, RSA Signature algorithms depend on an underlying hash function. Each of these underlying algorithm primitives must be validated, either separately or as part of the same submission. ACVP provides a mechanism for specifying the required prerequisites:¶
Prerequisites, if applicable, MUST be submitted in the registration as the prereqVals
JSON property array inside each element of the algorithms
array. Each element in the prereqVals
array MUST contain the following properties¶
JSON Property | Description | JSON Type |
---|---|---|
algorithm | a prerequisite algorithm | string |
valValue | algorithm validation number | string |
A "valValue" of "same" SHALL be used to indicate that the prerequisite is being met by a different algorithm in the capability exchange in the same registration.¶
An example description of prerequisites within a single algorithm capability exchange looks like this¶
"prereqVals": [ { "algorithm": "Alg1", "valValue": "Val-1234" }, { "algorithm": "Alg2", "valValue": "same" } ]¶
Each EDDSA implementation relies on other cryptographic primitives. For example, EDDSA uses an underlying SHA algorithm. Each of these underlying algorithm primitives must be validated, either separately or as part of the same submission. ACVP provides a mechanism for specifying the required prerequisites:¶
JSON Value | Description | JSON type | Valid Values |
---|---|---|---|
algorithm | a prerequisite algorithm | string | DRBG, SHA |
valValue | algorithm validation number | string | actual number or "same" |
prereqAlgVal | prerequistie algorithm validation | object with algorithm and valValue properties | see above |
prereqVals | prerequistie algorithm validations | array of prereqAlgVal objects | see above |
Each algorithm capability advertised is a self-contained JSON object using the following values¶
JSON Value | Description | JSON type | Valid Values |
---|---|---|---|
algorithm | The algorithm under test | string | "EDDSA" |
mode | The EDDSA mode to be validated | string | "keyGen", "keyVer", "sigGen", or "sigVer" |
revision | The algorithm testing revision to use | string | "1.0" |
prereqVals | prerequistie algorithm validations | array of prereqAlgVal objects | See Section 7.2 |
The follwing sections offer additional REQUIRED JSON properties for each algorithm / mode / revision.¶
Each EDDSA keyGen mode capability set is advertised as a self-contained JSON object.¶
The complete list of EDDSA key generation capabilities may be advertised by the ACVP compliant crypto module:¶
JSON Value | Description | JSON type | Valid Values |
---|---|---|---|
curve | The curve names supported for the IUT in keyGen | array | Any non-empty subset of {"ED-25519", "ED-448"} |
An example of this is the following¶
{ "algorithm": "EDDSA", "mode": "keyGen", "revision": "1.0", "prereqVals": [{ "algorithm": "SHA", "valValue": "123456" }, { "algorithm": "DRBG", "valValue": "123456" } ], "curve": [ "ED-25519", "ED-448" ] }¶
Each EDDSA keyVer mode capability set is advertised as a self-contained JSON object.¶
The complete list of EDDSA key verification capabilities may be advertised by the ACVP compliant crypto module:¶
JSON Value | Description | JSON type | Valid Values |
---|---|---|---|
curve | The curve names supported for the IUT in keyVer | array | Any non-empty subset of {"ED-25519", "ED-448"} |
An example of this is the following¶
{ "algorithm": "EDDSA", "mode": "keyVer", "revision": "1.0", "prereqVals": [{ "algorithm": "SHA", "valValue": "123456" }, { "algorithm": "DRBG", "valValue": "123456" } ], "curve": [ "ED-25519", "ED-448" ] }¶
Each EDDSA sigGen mode capability set is advertised as a self-contained JSON object.¶
The complete list of EDDSA signature generation capabilities may be advertised by the ACVP compliant crypto module:¶
JSON Value | Description | JSON type | Valid Values |
---|---|---|---|
curve | The curve names supported for the IUT in sigGen | array | Any non-empty subset of {"ED-25519", "ED-448"} |
pure | If the IUT supports normal 'pure' EdDSA signature generation functionality | bool | true/false |
preHash | If the IUT supports Prehash EdDSA, i.e., HashEdDSA, signature generation functionality | bool | true/false |
contextLength | The lengths the IUT supports in octets for generated context strings | domain | Min: 0, Max: 255 |
The following is an example¶
{ "algorithm": "EDDSA", "mode": "sigGen", "revision": "1.0", "prereqVals": [{ "algorithm": "SHA", "valValue": "123456" }, { "algorithm": "DRBG", "valValue": "123456" } ], "pure": true, "preHash": true, "contextLength": [ { "min": 0, "max": 255, "increment": 1 } ], "curve": [ "ED-25519", "ED-448" ] }¶
Each EDDSA sigVer mode capability set is advertised as a self-contained JSON object.¶
The complete list of EDDSA signature verification capabilities may be advertised by the ACVP compliant crypto module:¶
JSON Value | Description | JSON type | Valid Values |
---|---|---|---|
curve | The curve names supported for the IUT in sigGen | array | Any non-empty subset of {"ED-25519", "ED-448"} |
pure | If the IUT supports normal 'pure' sigGen functionality | bool | true/false |
preHash | If the IUT supports accepting a preHashed message to sign | bool | true/false |
The following is an example¶
{ "algorithm": "EDDSA", "mode": "sigVer", "revision": "1.0", "prereqVals": [{ "algorithm": "SHA", "valValue": "123456" }, { "algorithm": "DRBG", "valValue": "123456" } ], "pure": true, "preHash": true, "curve": [ "ED-25519", "ED-448" ] }¶
The ACVP server provides test vectors to the ACVP client, which are then processed and returned to the ACVP server for validation. A typical ACVP validation session would require multiple test vector sets to be downloaded and processed by the ACVP client. Each test vector set represents an individual EdDSA function. This section describes the JSON schema for a test vector set used with EdDSA algorithms.¶
The test vector set JSON schema is a multi-level hierarchy that contains meta data for the entire vector set as well as individual test vectors to be processed by the ACVP client.The following table describes the JSON elements at the top level of the hierarchy.¶
JSON Value | Description | JSON type |
---|---|---|
acvVersion | Protocol version identifier | string |
vsId | Unique numeric identifier for the vector set | string |
algorithm | Algorithm defined in the capability exchange | string |
mode | Mode defined in the capability exchange | string |
revision | Protocol test revision selected | string |
testGroups | Array of test group JSON objects, which are defined in Section 8.1, Section 8.3, Section 8.5, and Section 8.7 | array |
An example of this would look like this¶
{ "acvVersion": "version", "vsId": 1, "algorithm": "Alg1", "mode": "Mode1", "revision": "Revision1.0", "testGroups": [ ... ] }¶
The testGroups element at the top level in the test vector JSON object is an array of test groups. Test vectors are grouped into similar test cases to reduce the amount of data transmitted in the vector set. For instance, all test vectors that use the same key size would be grouped together. The Test Group JSON object contains meta data that applies to all test vectors within the group. The following table describes the JSON elements of the Test Group JSON object.¶
The test group for EDDSA / keyGen / 1.0 is as follows:¶
JSON Value | Description | JSON type |
---|---|---|
tgId | The test group identifier | integer |
curve | The curve type used for the test vectors | string |
testType | The testType for the group | string |
tests | Array of individual test vector JSON objects, which are defined in Section 8.2 | array |
Each test group contains an array of one or more test cases. Each test case is a JSON object that represents a single test vector to be processed by the ACVP client. The following table describes the JSON elements for each EDDSA test vector.¶
JSON Value | Description | JSON type |
---|---|---|
tcId | Numeric identifier for the test case, unique across the entire vector set | integer |
The following is an example of a prompt for EDDSA / keyGen / 1.0¶
[ { "acvVersion": <acvp-version> }, { "vsId": 1564, "algorithm": "EDDSA", "mode": "keyGen", "revision": "1.0", "testGroups": [ { "tgId": 1, "curve": "ED-25519", "testType": "AFT", "tests": [ { "tcId": 1 } ] } ] } ]¶
The testGroups element at the top level in the test vector JSON object is an array of test groups. Test vectors are grouped into similar test cases to reduce the amount of data transmitted in the vector set. For instance, all test vectors that use the same key size would be grouped together. The Test Group JSON object contains meta data that applies to all test vectors within the group. The following table describes the JSON elements of the Test Group JSON object.¶
The test group for EDDSA / keyVer / 1.0 is as follows:¶
JSON Value | Description | JSON type |
---|---|---|
tgId | The test group identifier | integer |
curve | The curve type used for the test vectors | string |
testType | The testType for the group | string |
tests | Array of individual test vector JSON objects, which are defined in Section 8.4 | array |
Each test group contains an array of one or more test cases. Each test case is a JSON object that represents a single test vector to be processed by the ACVP client. The following table describes the JSON elements for each EDDSA test vector.¶
JSON Value | Description | JSON type |
---|---|---|
tcId | Numeric identifier for the test case, unique across the entire vector set | integer |
q | The encoded public key curve point | hex |
The following is an example of a prompt for EDDSA / keyVer / 1.0¶
[ { "acvVersion": <acvp-version> }, { "vsId": 1564, "algorithm": "EDDSA", "mode": "keyVer", "revision": "1.0", "testGroups": [ { "tgId": 1, "curve": "ED-25519", "testType": "AFT", "tests": [ { "tcId": 1, "q": "227093C50F7D04A41121CEFDF076CC8B21D44E7506F341F8BFAB269CE06F2B7E", } ] } ] } ]¶
The testGroups element at the top level in the test vector JSON object is an array of test groups. Test vectors are grouped into similar test cases to reduce the amount of data transmitted in the vector set. For instance, all test vectors that use the same key size would be grouped together. The Test Group JSON object contains meta data that applies to all test vectors within the group. The following table describes the JSON elements of the Test Group JSON object.¶
The test group for EDDSA / sigGen / 1.0 is as follows:¶
JSON Value | Description | JSON type |
---|---|---|
tgId | The test group identifier | integer |
curve | The curve type used for the test vectors | string |
prehash | Whether or not Prehash EdDSA/HashEdDSA (vs normal/'pure' EdDSA) should be used for the test vectors | boolean |
testType | The testType for the group | string |
tests | Array of individual test vector JSON objects, which are defined in Section 8.6 | array |
Each test group contains an array of one or more test cases. Each test case is a JSON object that represents a single test vector to be processed by the ACVP client. The following table describes the JSON elements for each EDDSA test vector.¶
JSON Value | Description | JSON type |
---|---|---|
tcId | Numeric identifier for the test case, unique across the entire vector set | integer |
message | The message used to generate the signature | hex |
context | The context string defined in FIPS 186-5 sections 7.6 and 7.8 | hex |
contextLength | The lengths the IUT supports in octets for generated context strings | domain |
The following is an example of a prompt for EDDSA / sigGen / 1.0¶
[ { "acvVersion": <acvp-version> }, { "vsId": 1564, "algorithm": "EDDSA", "mode": "sigGen", "revision": "1.0", "testGroups": [ { "tgId": 1, "testType": "AFT", "curve": "ED-25519", "preHash": true, "tests": [ { "tcId": 1, "message": "A81C8A22735A260...", "context": "12CBEF869A08BCD..." } ] }, { "tgId": 5, "testType": "BFT", "curve": "ED-25519", "preHash": false, "tests": [ { "tcId": 41, "message": "F27E9F9D" }, { "tcId": 42, "message": "F27E9F9C" }, { "tcId": 43, "message": "F27E9F9F" } ] } ] } ]¶
The testGroups element at the top level in the test vector JSON object is an array of test groups. Test vectors are grouped into similar test cases to reduce the amount of data transmitted in the vector set. For instance, all test vectors that use the same key size would be grouped together. The Test Group JSON object contains meta data that applies to all test vectors within the group. The following table describes the JSON elements of the Test Group JSON object.¶
The test group for EDDSA / sigVer / 1.0 is as follows:¶
JSON Value | Description | JSON type |
---|---|---|
tgId | The test group identifier | integer |
curve | The curve type used for the test vectors | string |
prehash | Whether or not Prehash EdDSA/HashEdDSA (vs normal/'pure' EdDSA) should be used for the test vectors | boolean |
testType | The testType for the group | string |
tests | Array of individual test vector JSON objects, which are defined in Section 8.8 | array |
Each test group contains an array of one or more test cases. Each test case is a JSON object that represents a single test vector to be processed by the ACVP client. The following table describes the JSON elements for each EDDSA test vector.¶
JSON Value | Description | JSON type |
---|---|---|
tcId | Numeric identifier for the test case, unique across the entire vector set | integer |
message | The message used to generate the signature | hex |
q | The encoded public key | hex |
signature | The signature to verify | hex |
The following is an example of a prompt for EDDSA / sigVer / 1.0¶
[ { "acvVersion": <acvp-version> }, { "vsId": 0, "algorithm": "EDDSA", "mode": "sigVer", "revision": "1.0", "isSample": true, "testGroups": [ { "tgId": 1, "testType": "AFT", "curve": "ED-25519", "preHash": false, "tests": [ { "tcId": 1, "message": "61524B41E89736DEE...", "q": "14FB8D71A6CEDFC7B33109F...", "signature": "283877CFDAFE61A..." }, { "tcId": 2, "message": "43529BD72351015CA...", "q": "99E318DCAD59F37DD3355EE...", "signature": "F21BCB4898B32B6..." } ] } ] } ]¶
After the ACVP client downloads and processes a vector set, it must send the response vectors back to the ACVP server. The following table describes the JSON object that represents a vector set response.¶
JSON Value | Description | JSON type |
---|---|---|
acvVersion | Protocol version identifier | string |
vsId | Unique numeric identifier for the vector set | integer |
testGroups | Array of JSON objects that are defined in Section 9.1, Section 9.2, Section 9.3 and Section 9.4 | array |
The following table describes the JSON object that represents a test group response for EDDSA / keyGen / 1.0.¶
JSON Value | Description | JSON type |
---|---|---|
tgId | Unique numeric identifier for the test group | integer |
tests | Array of JSON objects that represent each result, as defined by the table below | array |
The following table describes the JSON object that represents a test case response for EDDSA / keyGen / 1.0.¶
JSON Value | Description | JSON type |
---|---|---|
tcId | The test case identifier | integer |
d | The encoded private key point | hex |
q | The encoded public key point | hex |
The following is an example of the response for EDDSA / keyGen / 1.0¶
[ { "acvVersion": <acvp-version> }, { "vsId": 1564, "testGroups": [ { "tgId": 1, "tests": [ { "tcId": 1, "q": "D51FB3D405A63622783...", "d": "147BA261D11CD323331..." } ] } ] } ]¶
The following table describes the JSON object that represents a test group response for EDDSA / keyVer / 1.0.¶
JSON Value | Description | JSON type |
---|---|---|
tgId | Unique numeric identifier for the test group | integer |
tests | Array of JSON objects that represent each result, as defined by the table below | array |
The following table describes the JSON object that represents a test case response for EDDSA / keyVer / 1.0.¶
JSON Value | Description | JSON type |
---|---|---|
tcId | The test case identifier | integer |
testPassed | Whether or not the key provided was valid | boolean |
The following is an example of the response for EDDSA / keyVer / 1.0¶
[ { "acvVersion": <acvp-version> }, { "vsId": 1564, "testGroups": [ { "tgId": 1, "tests": [ { "tcId": 1, "testPassed": true } ] } ] } ]¶
The following table describes the JSON object that represents a test group response for EDDSA / sigGen / 1.0.¶
JSON Value | Description | JSON type |
---|---|---|
tgId | Unique numeric identifier for the test group | integer |
q | The encoded public key point used for signatures in the group | hex |
tests | Array of JSON objects that represent each result, as defined by the table below | array |
The following table describes the JSON object that represents a test case response for EDDSA / sigGen / 1.0.¶
JSON Value | Description | JSON type |
---|---|---|
tcId | The test case identifier | integer |
signature | The computed signature | hex |
The following is an example of the response for EDDSA / sigGen / 1.0¶
[ { "acvVersion": <acvp-version> }, { "vsId": 1564, "testGroups": [ { "tgId": 1, "q": "4BA34FE699DBDC89750FF006...", "tests": [ { "tcId": 1, "signature": "772990B0..." } ] }, { "tgId": 5, "q": "ADD51513B67540E3A392721...", "tests": [ { "tcId": 41, "signature": "6EA857E..." }, { "tcId": 42, "signature": "883B033..." }, { "tcId": 43, "signature": "E402705..." } ] } ] } ]¶
The following table describes the JSON object that represents a test group response for EDDSA / sigVer / 1.0.¶
JSON Value | Description | JSON type |
---|---|---|
tgId | Unique numeric identifier for the test group | integer |
tests | Array of JSON objects that represent each result, as defined by the table below | array |
The following table describes the JSON object that represents a test case response for EDDSA / sigVer / 1.0.¶
JSON Value | Description | JSON type |
---|---|---|
tcId | The test case identifier | integer |
testPassed | Whether or not the signature provided was valid | boolean |
The following is an example of the response for EDDSA / sigVer / 1.0¶
[ { "acvVersion": <acvp-version> }, { "vsId": 1564, "testGroups": [ { "tgId": 1, "tests": [ { "tcId": 1, "testPassed": true } ] } ] } ]¶
There are no additional security considerations outside of those outlined in the ACVP document.¶
This document does not require any action by IANA.¶