Internet-Draft | ACVP LMS | 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 LMS 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 LMS 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 LMS algorithms MAY be advertised by the ACVP compliant cryptographic module. The list is in the form "algorithm / mode / revision".¶
The ACVP server performs a set of tests on the specified LMS 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 LMS capabilities. This section describes the design of the tests used to validate implementations of the LMS algorithms.¶
The tests described in this document have the intention of ensuring an implementation is conformant to [SP800-208].¶
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 LMS 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 LMS implementation relies on other cryptographic primitives. For example, LMS keyGen 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 | SHA, or DRBG |
valValue | algorithm validation number | string | Actual number or "same" |
prereqAlgVal | prerequisite algorithm validation | object with algorithm and valValue properties | See above |
Each LMS algorithm capability advertised is a self-contained JSON object using the following values.¶
JSON Value | Description | JSON Type | Valid Values |
---|---|---|---|
algorithm | The LMS algorithm to be validated | string | See Section 5 |
mode | The LMS mode to be validated | string | See Section 5 |
revision | The algorithm testing revision to use | string | See Section 5 |
prereqVals | Prerequisite algorithm validations | array of prereqAlgVal objects | See Section 7.2 |
capabilities | The general pairs of LMS and LMOTS modes that are supported. See note. | object | See Table 4 |
specificCapabilities | The set of exact LMS and LMOTS mode matches that are supported. See note. | array of objects | See Table 5 |
The capabilities advertised by the module must use the following JSON object schema. The ACVP server MAY select any pairing of values from the arrays to test.¶
Note: The capabilities
object is preferred, as it allows the ACVP server to select from a random sampling of the product of the registered capabilities.
The specificCapabilities
object can be used as an alternative, if your IUT does not support a wide variety of capabilities, and needs to have specific combinations tested against.¶
The two capabilities
and specificCapabilities
cannot be used together with the same registration.¶
JSON Value | Description | JSON Type | Valid Values |
---|---|---|---|
lmsModes | An array of LMS modes supported | array of strings | See Section 7.3.1 |
lmOtsModes | An array of LMOTS modes supported | array of strings | See Section 7.3.2 |
The specificCapabilities advertised by the module must use the following JSON object schema. The ACVP server MUST test the listed values.¶
JSON Value | Description | JSON Type | Valid Values |
---|---|---|---|
lmsMode | A single LMS mode supported | string | See Section 7.3.1 |
lmOtsMode | A single LMOTS mode supported | string | See Section 7.3.2 |
The following LMS Modes MAY be registered by the module. The combinations of LMS Modes and LMOTS Modes MUST adhere to [SP800-208] Section 4, namely M = N, and the hash is the same.¶
The following LMOTS Modes MAY be registerd by the module.¶
Below is an example of the registration for LMS / keyGen / 1.0¶
{ "algorithm": "LMS", "mode": "keyGen", "revision": "1.0", "prereqVals": [ { "algorithm": "SHA", "valValue": "123456" } ], "capabilities": { "lmsModes": ["LMS_SHA256_M24_H5", "LMS_SHA256_M24_H10"], "lmOtsModes": ["LMOTS_SHA256_N24_W1", "LMOTS_SHA256_N24_W8"] } "specificCapabilities": [ { "lmsMode": "LMS_SHA256_M24_H5", "lmOtsMode": "LMOTS_SHA256_N24_W2" }, { "lmsMode": "LMS_SHAKE_M24_H25", "lmOtsMode": "LMOTS_SHAKE_N24_W1" } ] }¶
Below is an example of the registration for LMS / sigGen / 1.0¶
{ "algorithm": "LMS", "mode": "sigGen", "revision": "1.0", "prereqVals": [ { "algorithm": "SHA", "valValue": "123456" } ], "capabilities": { "lmsModes": ["LMS_SHA256_M24_H5", "LMS_SHA256_M24_H10"], "lmOtsModes": ["LMOTS_SHA256_N24_W1", "LMOTS_SHA256_N24_W8"] } "specificCapabilities": [ { "lmsMode": "LMS_SHA256_M24_H5", "lmOtsMode": "LMOTS_SHA256_N24_W2" }, { "lmsMode": "LMS_SHAKE_M24_H25", "lmOtsMode": "LMOTS_SHAKE_N24_W1" } ] }¶
Below is an example of the registration for LMS / sigVer / 1.0¶
{ "algorithm": "LMS", "mode": "sigVer", "revision": "1.0", "prereqVals": [ { "algorithm": "SHA", "valValue": "123456" } ], "capabilities": { "lmsModes": ["LMS_SHA256_M24_H5", "LMS_SHA256_M24_H10"], "lmOtsModes": ["LMOTS_SHA256_N24_W1", "LMOTS_SHA256_N24_W8"] } "specificCapabilities": [ { "lmsMode": "LMS_SHA256_M24_H5", "lmOtsMode": "LMOTS_SHA256_N24_W2" }, { "lmsMode": "LMS_SHAKE_M24_H25", "lmOtsMode": "LMOTS_SHAKE_N24_W1" } ] }¶
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 test session would require multiple test vector sets to be downloaded and processed by the ACVP client. Each test vector set represents an individual cryptographic algorithm defined during the capability exchange. This section describes the JSON schema for a test vector set used with LMS 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 Values | Description | JSON Type |
---|---|---|
acvVersion | Protocol version identifier | string |
vsId | Unique numeric vector set identifier | integer |
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. Depending on the algorithm, see Section 8.1.1, Section 8.2.1 or Section 8.3.1 | 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 LMS JSON elements of the Test Group JSON object.¶
The test group for LMS / keyGen / 1.0 is as follows:¶
JSON Value | Description | JSON type |
---|---|---|
tgId | Numeric identifier for the test group, unique across the entire vector set | integer |
testType | The test operation performed | string |
lmsMode | The LMS tree structure used | string |
lmOtsMode | The LMOTS tree structure used | string |
tests | Array of individual test vector JSON objects, which are defined in Section 8.1.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 LMS test vector.¶
JSON Value | Description | JSON type |
---|---|---|
tcId | Numeric identifier for the test case, unique across the entire vector set | integer |
i | The public key identifier used to generate the LMS tree | hex |
seed | The seed used to generate the OTS values | hex |
The following is an example JSON object sent from the server to the client for LMS / keyGen / 1.0.¶
[ { "acvVersion": <acvp-version> }, { "vsId": 1564, "algorithm": "LMS", "mode": "keyGen", "revision": "1.0", "testGroups": [ { "tgId": 1, "testType": "AFT", "lmsMode": "LMS_SHA256_M24_H25", "lmOtsMode": "LMOTS_SHA256_N24_W8", "tests": [ { "tcId": 1, "seed": "99182FD07F0B3ED6619ACE121E1D8E25A0604524D4C9EE67", "i": "2A1E70061F78145D18F710B889A9B32F" } ] } ] } ]¶
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 LMS JSON elements of the Test Group JSON object.¶
The test group for LMS / sigGen / 1.0 is as follows:¶
JSON Value | Description | JSON type |
---|---|---|
tgId | Numeric identifier for the test group, unique across the entire vector set | integer |
testType | The test operation performed | string |
lmsMode | The LMS tree structure used | string |
lmOtsMode | The LMOTS tree structure used | string |
tests | Array of individual test vector JSON objects, which are defined in Section 8.2.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 LMS 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 |
The following is an example JSON object sent from the server to the client for LMS / sigGen / 1.0.¶
[ { "acvVersion": <acvp-version> }, { "vsId": 0, "algorithm": "LMS", "mode": "sigGen", "revision": "1.0", "testGroups": [ { "tgId": 1, "testType": "AFT", "lmsMode": "LMS_SHA256_M24_H5", "lmOtsMode": "LMOTS_SHA256_N24_W2", "tests": [ { "tcId": 1, "message": "2C4719..." }, { "tcId": 2, "message": "4F0E7D..." } ] } ] } ]¶
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 LMS JSON elements of the Test Group JSON object.¶
The test group for LMS / sigVer / 1.0 is as follows:¶
JSON Value | Description | JSON type |
---|---|---|
tgId | Numeric identifier for the test group, unique across the entire vector set | integer |
testType | The test operation performed | string |
lmsMode | The LMS tree structure used | string |
lmOtsMode | The LMOTS tree structure used | string |
publicKey | The public key of the LMS tree | hex |
tests | Array of individual test vector JSON objects, which are defined in Section 8.3.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 LMS 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 verify with the signature | hex |
signature | THe signature to verify | hex |
The following is an example JSON object sent from the server to the client for LMS / sigVer / 1.0.¶
[ { "acvVersion": <acvp-version> }, { "vsId": 0, "algorithm": "LMS", "mode": "sigVer", "revision": "1.0", "isSample": false, "testGroups": [ { "tgId": 1, "testType": "AFT", "lmsMode": "LMS_SHA256_M24_H10", "lmOtsMode": "LMOTS_SHA256_N24_W1", "publicKey": "0000000B00000005FA5F14B9EEA8886576EF0E190A96F12D16734708776A2BB1D7F53610343D3B2F9361CB6F315E8860", "tests": [ { "tcId": 1, "message": "4F0D7...", "signature": "0000026300000005EE3..." }, { "tcId": 2, "message": "84793...", "signature": "8000017000000005E00..." } ] } ] } ]¶
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 Property | Description | JSON Type |
---|---|---|
acvVersion | The ACVP version used | string |
vsId | The vector set identifier | integer |
testGroups | The test group objects in the response, see Table 14 | array |
An example of this is the following¶
{ "acvVersion": "version", "vsId": 1, "testGroups": [ ... ] }¶
The 'testGroups' section is used to organize the ACVP client response in a similar manner to how it distributes vectors.¶
JSON Property | Description | JSON Type |
---|---|---|
tgId | The test group identifier | integer |
tests | The test case objects in the response, depending on the algorithm see Table 15, Table 17, or Table 18 | array |
An example of this is the following¶
{ "tgId": 1, "tests": [ ... ] }¶
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 LMS / keyGen / 1.0 test vector.¶
JSON Value | Description | JSON type |
---|---|---|
tcId | The test case identifier | integer |
publicKey | The computed public key of the tree | hex |
The following is an example JSON test vector response object for LMS / keyGen / 1.0.¶
[ { "acvVersion": <acvp-version> }, { "vsId": 0, "testGroups": [ { "tgId": 1, "tests": [ { "tcId": 1, "publicKey": "0000000B00000005D3933B303FD213427203BA0E04ED520B7E2AD3F4CAA4AA21F0A8E9C98944F6AAB32E9B5C6757DD30" }, { "tcId": 2, "publicKey": "0000000B0000000538805CFF7AB3B73570EDE8B2A8D5D78109DDBFBC5EABE8F178B7C4D86ECAF5B94BC0F6813F1CA565" } ] } ] } ]¶
The test groups for LMS / sigGen / 1.0 contain public key properties. The groups can be described using the following table.¶
JSON Value | Description | JSON type |
---|---|---|
tgId | The test group identifier | integer |
publicKey | The public key of the tree the IUT used | hex |
tests | The individual test cases for the group | 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 LMS / sigGen / 1.0 test vector.¶
JSON Value | Description | JSON type |
---|---|---|
tcId | The test case identifier | integer |
signature | The generated signature | hex |
The following is an example JSON test vector response object for LMS / sigGen / 1.0.¶
[ { "acvVersion": <acvp-version> }, { "vsId": 1564, "testGroups": [ { "tgId": 1, "publicKey": "0000000A000000064D2A698120B6AAF7FED6EA4E...", "tests": [ { "tcId": 1, "signature": "0000000F00000006D789CF...", } ] }, { "tgId": 2, "publicKey": "0000000B000000055FF5A7FD9CC554B3...", "tests": [ { "tcId": 2, "signature": "00000008000000053659BCB1079...", } ] } ] } ]¶
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 LMS / sigVer / 1.0 test vector.¶
JSON Value | Description | JSON type |
---|---|---|
tcId | The test case identifier | integer |
testPassed | Whether or not the signature verified | boolean |
The following is an example JSON test vector response object for LMS / sigVer / 1.0.¶
[ { "acvVersion": <acvp-version> }, { "vsId": 1564, "testGroups": [ { "tgId": 1, "tests": [ { "tcId": 1, "testPassed": false } ] } ] } ]¶
There are no additional security considerations outside of those outlined in the ACVP document.¶
This document does not require any action by IANA.¶