Internet-Draft | ACVP KDF IKEv1 | 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 SP800-135 IKEv1 KDF 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 SP800-135 IKEv1 KDF 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 key derivation functions MAY be advertised by the ACVP compliant cryptographic module:¶
This section describes the design of the tests used to validate SP800-135 IKEv1 KDF implementations. There is only one test type: functional tests. Each has a specific value to be used in the testType field. The testType field definitions are:¶
"AFT" - Algorithm Functional Test. These tests can be processed by the client using a normal 'derive_key' operation. AFTs cause the implementation under test to exercise normal operations on a single block, multiple blocks, or partial blocks. In all cases, random data is used. The functional tests are designed to verify that the logical components of the key deriviation process are operating correctly.¶
The tests described in this document have the intention of ensuring an implementation is conformant to XXX.¶
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 IKEv1 KDF 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" } ]¶
The IKEv1 KDF mode capabilities are advertised as JSON objects within the 'capabilities_exchange' property.¶
A registration SHALL use these properties¶
JSON Property | Description | JSON Type | Valid Values |
---|---|---|---|
algorithm | Name of the algorithm to be validated | string | "kdf-components" |
mode | Mode of the algorithm to be validated | string | "ikev1" |
revision | ACVP Test version | string | "1.0" |
capabilities | Array of objects describing capabilities | array | Contains each of the below properties |
authenticationMethod | The mode of authentication used by the IUT | string | "dsa", "psk", or "pke" |
initiatorNonceLength | The supported initiator nonce lengths used by the IUT in bits | domain | Min: 64, Max: 2048 |
responderNonceLength | The lengths of data the IUT supports in bits | domain | Min: 64, Max: 2048 |
diffieHellmanSharedSecretLength | The lengths of Diffie Hellman shared secrets the IUT supports in bits | domain | Min: 224, Max: 8192 |
preSharedKeyLength | The lengths of pre-shared key the IUT supports in bits | domain | Min: 8, Max: 8192. Note this property is only required when "authenticationMethod" is "psk" |
hashAlg | Valid hash algorithms used by the IUT | array | See Section 7.3.1 |
An example registration within an algorithm capability exchange looks like this¶
"capability_exchange": [ { "algorithm": "kdf-components", "mode": "ikev1", "revision": "1.0", "prereqVals": [ { "algorithm": "SHA", "valValue": "same" } ], "capabilities": [ { "authenticationMethod": "dsa", "initiatorNonceLength": [ { "min": 64, "max": 2048, "increment": 1 } ], "responderNonceLength": [ { "min": 64, "max": 2048, "increment": 1 } ], "diffieHellmanSharedSecretLength": [ { "min": 224, "max": 8192, "increment": 1 } ], "hashAlg": [ "sha-1", "sha2-224", "sha2-256", "sha2-384", "sha2-512" ] }, { "authenticationMethod": "psk", "initiatorNonceLength": [ { "min": 64, "max": 2048, "increment": 1 } ], "responderNonceLength": [ { "min": 64, "max": 2048, "increment": 1 } ], "preSharedKeyLength": [ { "min": 8, "max": 8192, "increment": 1 } ], "diffieHellmanSharedSecretLength": [ { "min": 224, "max": 8192, "increment": 1 } ], "hashAlg": [ "sha-1", "sha2-224", "sha2-256", "sha2-384", "sha2-512" ] }, { "authenticationMethod": "pke", "initiatorNonceLength": [ { "min": 64, "max": 2048, "increment": 1 } ], "responderNonceLength": [ { "min": 64, "max": 2048, "increment": 1 } ], "diffieHellmanSharedSecretLength": [ { "min": 224, "max": 8192, "increment": 1 } ], "hashAlg": [ "sha-1", "sha2-224", "sha2-256", "sha2-384", "sha2-512" ] } ] } ]¶
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 SP800-135 IKEv1 KDF 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, which are defined in Section 8.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 SP800-135 IKEv1 KDF JSON elements of the Test Group JSON object¶
JSON Value | Description | JSON Type |
---|---|---|
tgId | Test group identifier | integer |
testType | Test operations to be performed | string |
authenticationMethod | The method used for the test vectors. See Section 7.3 for possible values | string |
dhLength | Diffie-Hellman shared secret length in bits | integer |
hashAlg | The SHA value used | string |
nInitLength | Length of initiator nonce in bits | integer |
nRespLength | Length of responder nonce in bits | integer |
preSharedKeyLength | Pre-shared key length in bits | integer |
tests | Array of individual test cases | array |
The 'tgId', 'testType' and 'tests' objects MUST appear in every test group element communicated from the server to the client as a part of a prompt. Other properties are dependent on which 'testType' (see Section 6) the group is addressing.¶
The 'preSharedKeyLength' SHALL only be present when the 'authenticationMethod' is "psk".¶
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 SP800-135 IKEv1 KDF test vector.¶
JSON Value | Description | JSON Type |
---|---|---|
tcId | Test case idenfitier | integer |
ckyInit | Initiator's cookie | hex |
ckyResp | Responder's cookie | hex |
nInit | Value of the initiator nonce | hex |
nResp | Value of the responder nonce | hex |
gxy | Diffie-Hellman shared secret | hex |
preSharedKey | Value of the pre-shared key | hex |
The 'preSharedKey' SHALL only be present when the 'authenticationMethod' is "psk".¶
Here is an abbreviated yet fully constructed example of the prompt with all possible 'authenticationMethod' values.¶
{ "vsId": 1, "algorithm": "kdf-components", "mode": "IKEv1", "revision": "1.0", "testGroups": [ { "tgId": 1, "hashAlg": "SHA-1", "authenticationMethod": "dsa", "dhLength": 6660, "nInitLength": 2048, "nRespLength": 2048, "testType": "AFT", "tests": [ { "tcId": 1, "ckyInit": "F16761897EFB81E5", "ckyResp": "4F3BA0B9C946172D", "nInit": "6F85B4C66C71791...", "nResp": "EAE7F83DBD83C18...", "gxy": "9BA5CEDAE8B3FD641..." }, { "tcId": 2, "ckyInit": "0CE83D37791E6EFD", "ckyResp": "8FA2F406395E8110", "nInit": "739D1D7AB9D1878...", "nResp": "BF3450BFCF442D1...", "gxy": "8810324F9E3405F23..." } ] }, { "tgId": 2, "hashAlg": "SHA-1", "authenticationMethod": "psk", "dhLength": 8192, "nInitLength": 989, "nRespLength": 64, "preSharedKeyLength": 8, "testType": "AFT", "tests": [ { "tcId": 3, "ckyInit": "AF501BE6A9CFDA3D", "ckyResp": "5D493412A02AC0B0", "nInit": "8C4F7093000AEC0...", "nResp": "049FBB8AD5DC5D20", "gxy": "A0DE670D5D668E930...", "preSharedKey": "C1" }, { "tcId": 4, "ckyInit": "0186060C1B45404E", "ckyResp": "205F3A38BFC363E1", "nInit": "B22CC4105FA8947...", "nResp": "3CCC6D447E8BC305", "gxy": "A281621748E344135...", "preSharedKey": "01" } ] }, { "tgId": 3, "hashAlg": "SHA-1", "authenticationMethod": "pke", "dhLength": 2165, "nInitLength": 142, "nRespLength": 64, "testType": "AFT", "tests": [ { "tcId": 5, "ckyInit": "D4B54A5C60ACD6A7", "ckyResp": "CA7528CD8DD8B254", "nInit": "D36A36DD6C69210...", "nResp": "AB4A4695F4866699", "gxy": "F04CDFA8A03E74481..." }, { "tcId": 6, "ckyInit": "14CA6041304FE168", "ckyResp": "71D6F8110638EB79", "nInit": "230F3C54635B3E8...", "nResp": "0C5A851874EE4131", "gxy": "ACFF1F744BB3D2415..." } ] } ] }¶
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 version of the protocol | string |
vsId | The vector set identifier | integer |
testGroups | The test group data | 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 receives vectors. Several algorithms SHALL require the client to send back group level properties in their response. This structure helps accommodate that.¶
JSON Property | Description | JSON Type |
---|---|---|
tgId | The test group identifier | integer |
tests | The test case data | array |
An example of this is the following¶
{ "tgId": 1, "tests": [ ... ] }¶
The following table describes the JSON object that represents a test case response for a SP800-135 IKEv1 KDF.¶
JSON Property | Description | JSON Type |
---|---|---|
tcId | The test case identifier | integer |
sKeyId | Results of the extraction step | hex |
sKeyIdD | Results of the expansion step | hex |
sKeyIdA | Results of the expansion step | hex |
sKeyIdE | Results of the expansion step | hex |
Here is an abbreviated example of the response¶
{ "vsId": 1, "algorithm": "kdf-components", "mode": "IKEv1", "revision": "1.0", "testGroups": [ { "tgId": 1, "tests": [ { "tcId": 1, "sKeyId": "FC3A8E843CC28415C6113CEAAA763CD486615465", "sKeyIdD": "27A3DF58BF1CADF914CDCCB0F975D62486EA12BF", "sKeyIdA": "4D49AF6F8F23F4068FDDD53D505667BE54AAB91C", "sKeyIdE": "D0A2F20796D66A2875477F33DEA577F98A0C2F7B" }, { "tcId": 2, "sKeyId": "7E1DB4F5571B9CC856DA9DA442431A50AA9799AD", "sKeyIdD": "65D6E37837A89C21D4DE1D6AA36CEBF103BA51F3", "sKeyIdA": "B9D7E7DBDBEA0203BFE7EC073BB140FE129A0D72", "sKeyIdE": "FCB7F5662704E89F1B151512F5B555D95F29B356" } ] }, { "tgId": 2, "tests": [ { "tcId": 3, "sKeyId": "1E7A2129CF7D0E3FC22E32BF1DFF414258342BA9", "sKeyIdD": "4B2E07B4C446DF40C90C06F294C9F05B2A174A8B", "sKeyIdA": "90682451AA897E7F9BC6E670F205929D2EBA2FD8", "sKeyIdE": "2B138E6AB5FFCE8D345F9C69313DC4798A14E709" }, { "tcId": 4, "sKeyId": "DCF270CE93FDD59B903CD60434AF075C8F9547A5", "sKeyIdD": "E5DF0DE718321B9C7A0BEB953B05D7B088699F3F", "sKeyIdA": "64816D06241E98E0B18945112CBDB17B48BB3310", "sKeyIdE": "63E7A74ACD8B9549182C06E37D01CB82B8DC6B44" }, ] }, { "tgId": 3, "tests": [ { "tcId": 5, "sKeyId": "CA0226BF4066CA296DCC3EDB9A84F14A3F2B72B1", "sKeyIdD": "77EAE9AAB8E9CD74B5A423A3D3C7D271FB192CA4", "sKeyIdA": "5BCFA7A2A116DB14F003DC3EDC169D4FABDE8AF7", "sKeyIdE": "27C368F57B4219D989DBB52FDFF0999B34E29787" }, { "tcId": 7, "sKeyId": "BD7120223435EF4E8A818F1322CC9DDAF9675682", "sKeyIdD": "87DB18ED75177847B1F7FE63B0C4C8AB5715EBFF", "sKeyIdA": "844EE67A460FF7F0F9EA36A5308DA4108C7A6434", "sKeyIdE": "2094E6217E39224B8D2C98BE3FE24959632F1BAF" }, ] } ] }¶
There are no additional security considerations outside of those outlined in the ACVP document.¶
This document does not require any action by IANA.¶
The following is a example JSON object advertising support for SHA-256.¶
The following is a example JSON object for SP800-135 IKEv1 KDF test vectors sent from the ACVP server to the crypto module.¶
The following is a example JSON object for SP800-135 IKEv1 KDF test results sent from the crypto module to the ACVP server.¶