Internet-Draft | ACVP Protocol | November 2024 |
Fussell, et al. | 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.¶
The ACV Protocol provides a method for communication between a cryptographic module that is embedded inside of a device or otherwise running on a platform accessible via computer network, and an external testing system, using standard network communication interfaces and protocols. This communication protocol can also be used to validate the correctness of the algorithm implementations in the cryptographic module with a validation authority.¶
The Automated Crypto Validation Protocol (ACVP) defines a mechanism to automatically verify the cryptographic implementation of a software or hardware crypto module. It introduces a method to perform cryptographic assessment and validations at a rate which meets typical industry development cycles; providing the ability to deploy validated crypto with CVE fixes much faster than previous methods.¶
The ACVP specification describes how the protocol is structured with respect to the client-server model, messaging, optional features, and flows. It 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.¶
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¶
ACVP has the following goals:¶
ACVP defines how to communicate a request (to execute a cryptographic operation) to a cryptographic module, and how to communicate the corresponding response (containing the output of that operation) back to a testing system. It defines a transport (based on HTTP or HTTPS [RFC7230]), an JSON message structure(which is negotiated), and a set of message exchanges. Each vector test set corresponds to a single message exchange driven from the client associated with the module under test. ACVP does not define the cryptographic algorithms, nor does it detail the precise conditions for a response to be acceptable. Instead, it references existing specifications for those algorithms, and defines a mapping between the data on the wire and the algorithm testing specification. ACVP does not define detailed conformance criteria, such as those in FIPS-140. Instead, it aims to be independent of particular conformance criteria, so that it can be used in multiple domains with different (even potentially conflicting) conformance criteria. ACVP does not define an interface that can be used to manage or control a cryptographic module.¶
The goals for this document are to provide a messaging protocol that can be used with existing authentication and communication protocols to provide a way to test crypto modules. The following functions are outside the scope of this document:¶
With that in mind there are several expectations when building a server used as a validation authority. A validation authority SHALL use a combination of HTTPS [RFC7230], TLS 1.2 [RFC5246] or greater and mutual authentication. Therefore a client that expects to be used with a validation authority SHALL have the same requirements. A server, proxy or client developed for the purposes of internal organizational testing only MAY choose not to include some of those features.¶
A server/client/proxy model is used where the roles are defined as:¶
The following terms are consistently used throughout this document and SHOULD be used throughout its extensions:¶
The ACV protocol will utilize existing mechanisms for transport coordinated with JSON formatted messaging.¶
Note that deployments utilizing ACV Proxy server MAY use a different protocol, e.g., HTTP, custom server, context and port number to interact with the DUT.¶
In the table below, any parts of a resource path enclosed in curly braces, { or }, are replaced by an instance of what is described in the braces. For example {testSessionId} could be replaced with 1.¶
An empty cell for a resource and HTTP Method combination denotes that the server returns an HTTP Status 405 code Method not allowed (405).¶
Resource | GET (read) | POST (create) | PUT (update) | DELETE |
---|---|---|---|---|
/requests | Section 12.7.1 | |||
/requests/{requestId} | Section 12.7.2 | |||
/vendors | Section 12.8.1 | Section 12.8.2 | ||
/vendors/{vendorId} | Section 12.8.3 | Section 12.8.4 | Section 12.8.5 | |
/vendors/{vendorId}/addresses | Section 12.9.1 | |||
/vendors/{vendorId}/addresses/{addressId} | Section 12.9.2 | |||
/vendors/{vendorId}/contacts | Section 12.8.6 | |||
/persons | Section 12.10.1 | Section 12.10.2 | ||
/persons/{personId} | Section 12.10.3 | Section 12.10.4 | Section 12.10.5 | |
/oes | Section 12.12.1 | Section 12.12.2 | ||
/oes/{oeId} | Section 12.12.3 | Section 12.12.4 | Section 12.12.5 | |
/modules | Section 12.11.1 | Section 12.11.2 | ||
/modules/{moduleId} | Section 12.11.3 | Section 12.11.4 | Section 12.11.5 | |
/dependencies | Section 12.13.1 | Section 12.13.2 | ||
/dependencies/properties | Section 12.13.3 | |||
/dependencies/{dependencyId} | Section 12.13.4 | Section 12.13.5 | Section 12.13.6 | |
/algorithms | Section 12.14.1 | |||
/algorithms/{algorithmId} | Section 12.14.2 (Optional) | |||
/testSessions | Section 12.16.1 (Optional) | Section 12.16.2 | ||
/testSessions/{testSessionId} | Section 12.16.3 (Optional) | Section 12.16.4 | Section 12.16.5 | |
/testSessions/{testSessionId}/results | Section 12.16.6 | |||
/testSessions/{testSessionId}/vectorSets | Section 12.17.1 | |||
/testSessions/{testSessionId}/vectorSets/{vectorSetId} | Section 12.17.2 | Section 12.17.3 | ||
/testSessions/{testSessionId}/vectorSets/{vectorSetId}/results | Section 12.17.4 | Section 12.17.5 | Section 12.17.6 | |
/testSessions/{testSessionId}/vectorSets/{vectorSetId}/expected | Section 12.17.7 (Optional) |
The resource path is appended to the path prefix to form the URI used with an HTTP Method to perform the desired ACVP operation. For example to create a new test session using the "/testSessions" resource is "/acvp/v1/testSessions" (assuming an empty context). To create a new Test Session, the ACVP client would use the following HTTP request-line:¶
POST /acvp/v1/testSessions HTTP/1.1¶
Likewise, to request a specific vector set from the server the ACVP client would use the following request-line:¶
GET /acvp/v1/testSessions/1/vectorSets/1 HTTP/1.1¶
It is RECOMMENDED that HTTPS and TLS 1.2 or greater be used in order to enforce a secure communication method. Not all environments will have TLS so HTTP with some level of authentication may be the only option.¶
It is RECOMMENDED that an authentication scheme be used. Typically, a JSON Web Token (JWT) is created by the server upon successful client authentication and returned to the client to use as an authorization mechanism for accessing the server resources - see Section 12.3 below for more information. Depending on the target environment and usage objectives, the authentication can be as weak as basic HTTP authentication or as strong as TLS mutual certificate authentication. Definition of an authentication scheme will not be discussed here, but should be agreed upon between the client and server owning entities including the servers owned by the validation authorities. The Section 10 endpoint will be discussed for the purposes of establishing a test session but how a client is authenticated to the server is not prescribed.¶
The encoding used for the request/response messaging will be JSON ([RFC7159]). The data will be identified by: Content-type: application/json In order to allow environment specific extensions to a particular version of the ACV protocol, a top-level JSON keyword, extensions will be used to extend the OE description and/or the capabilities. Extensions MAY be ignored by the ACV server. Vector and vector response data will be JSON encoded.¶
Some server implementations MAY require alternative handling for submission sizes that exceed resource limitations of the normal workflow for a POST
response. Server implementations MUST indicate whether the server requires large submission handling and what the maxmimum value for non-large submissions is within the Section 10 response.¶
A login endpoint is mentioned throughout the document and although how to authenticate is left up to the server the following description is an example of the login endpoint to establish a session and obtain a Section 12.3.1. See Section 13 for more information on how to handle data which exceeds the sizeConstraint
in the event the value of largeEndpointRequired
is true
.¶
string
, a property for providing a password value¶
string
, a JWT associated with the current user for which renewal of the expiration is desired¶
boolean
, true if the server requires the large endpoint for submissions with a size that exceeds the value found in sizeConstraint.¶
number
, provides the maximum value, in bytes, of a submission not required to use the Section 13 or -1 if largeEndpointRequired
is false
.¶
There are two forms of a login request. There is the initial form which just provides the authentication information without any JWT, and there is a renewal login that allows a user to obtain a new JWT containing the claims from an expired JWT in order to access a resource protected with those claims.¶
POST /login (Initial)¶
[ {"acvVersion": "{acvp-version}"}, { "password": "{password}" } ]¶
POST /login (Renewal)¶
[ {"acvVersion": "{acvp-version}"}, { "password": "{password}", "accessToken": "{jwt value}" } ]¶
[ {"acvVersion": "{acvp-version}"}, { "accessToken": "{jwt value}", "largeEndpointRequired": false, "sizeConstraint": -1 } ]¶
This endpoint can be utilized for refreshing multiple JWTs with a single POST. Because a JWT with claims is issued for each test session created and clients have the option of performing more than one test session at a time, a mechanism for refreshing multiple JWTs across multiple test sessions simultaneously MAY be made available.¶
The version of the ACVP protocol will be carried with each message and will contain a simple major.minor format. Major version changes will not be backward compatible, however additions and enhancements that do not disrupt compatibility will be indicated with a minor version change. A server MAY accept a down-level version from the client if it can process at a lower level. If not, it will reject the session. All subsequent messages will carry the negotiated version value.¶
The product registration will utilize the URI resources Section 6.2 to register and provide cryptographic capabilities. This exchange will consist of several message exchanges and will provide a detailed list of cryptographic algorithms and their options to be tested during the testSession, see Section 12.4, Paragraph 2, retrieval of test vectors, submission of test responses, determining test result, and a certification step to associate the product and tested environment information with the completed test. A set URI resources are also available to retrieve and manage the available metadata such as companay name, primary contact, product descriptions, and operational environment descriptions.¶
The test exchange consists of the ACV client requesting a particular vectorSet associated with the testSession. The server responds with the vectorSet. The client MAY retreive and process the vectorSets in order and MAY retreive a vectorSet and immediately return results or request all of the vectorSets and return results at a later time. The client repeats this process until all of the vectorSets in the testSession list have been processed. Once a vectorSet result has been POSTed to the server the client may request success/failure results from the server at any time, however if vectorSets have not been completed the overall status will be incomplete. A minimal message flow is described below Section 12.4, Paragraph 2.¶
JSON Web Token is described in [RFC7519] and is used as an authorization mechanism for gaining access to different resources.¶
{ "alg" : "none" } { "iss" : "nist.gov", "nbf": 1598293915, "exp": 1598295715, "iat": 1598293915, "pkey" : "cc74f56acdba635079383a03941d68db55c7b3c2f (truncated)" } { }¶
The JWT can be secured if desired using the header encryption "alg" value defined to HS256(HMAC-SHA256) or one of the other secure values. Key agreement would follow RFC7518.¶
{ "alg": "HS256", "typ": "JWT" } { "iss" : "nist.gov", "nbf": 1598293915, "exp": 1598295715, "iat": 1598293915, "pkey" : "cc74f56acdba635079383a03941d68db55c7b3c2f (truncated)" } { "{signature}" }¶
where "{signature}" is made up of:¶
and where "HMACSHA256" is the algorithm specified in the JWT header.¶
The first four claims are required, however "pkey" is an optional private claim used to pass the key used for encrypting the database at the server. Enabling this option is discussed further in Section 12.16.2¶
JSON Web Token is described in [RFC7519] and is used as an authorization mechanism for gaining access to different resources.¶
In order to access any resource which requires authorization a client must supply the JWT
as an Authorization
header value as a Bearer
token. An example header value is:¶
Workflow authorization flows. All exchanges shown are over HTTP.¶
The JWT access tokens received from either the /login server endpoint SHALL be set to expire after a pre-defined period. The specific length of the expiration period is out of scope for this specification. However, the expiration period length impacts both the security and protocol overhead. Longer expiration periods reduce the overhead but increase the window for attacks. Attempting to access a service with an expired JWT SHALL result in a "401 Unauthorized" HTTP status code.¶
A client may renew an expired JWT access token using the mechanism shown in Section 12.3.2, Paragraph 3below.¶
JWT access token renewal flows. All exchanges shown are over HTTP.¶
An example minimum message flow between client and server after receiving the JWT is seen in the figure below.¶
An example minimal message flow. All exchanges shown are over HTTP.¶
Metadata creation and update example. The list of available metadata endpoints can be found in Section 6.2.¶
In the event a submission response exceeds server defined thresholds the following workflow will need to be followed in order to submit the test result. See Section 13 for more information.¶
Some resource operations require paging in order to avoid returning large amounts of data. Each operation that uses paging will indicate that uses paging and what the value for each element will be within the section describing that operation. All paged responses MUST follow the format described in Section 12.5.2. Conversely, clients may navigate pages using the paging parameters described in Section 12.5.1. Server implementations SHOULD impose limitations on the page size limit based on resource constraints.¶
A Server MUST accept requests without paging parameters. If not all results are returned, the response MUST
indicate that not all of the results were provided using the incomplete
property of a paged response described in Section 12.5.2. The query parameters clients MUST use to specify paging are described below:¶
number
, the maximum number of entries to return. Server implementations MUST allow requests without a provided value, but the default value is a choice for server implementations.¶
number
, the offset into the list of entries, MUST default to 0
if not provided.¶
GET /acvp/v1/vendors?offset=20&limit=20 HTTP/1.1¶
A paged response has the following properties:¶
number
, the total number of resources available to return¶
boolean
, true if more resources are avaiable than what is returned in the response¶
links - object
, links to use when navigating the pages¶
string
, a link to the first page in the result set¶
string
, a link to the next page in the result set, null
if no next page is available¶
string
, a link to the previous page in the result set, null
if no previous page is available¶
string
, a link to the last page in the result set¶
array
, contains an array of data appropriate to the resource requested¶
Some of the resource listing operations allow for query parameters to be provided to filter out the returned values. Each resource will list what properties and operations are available but the general format of the query parameter string is consistent across all resources. The format allows for the specification of complex filters with the concept of groups, where all elements in the same group MUST be AND'ed together and different groups are OR'ed together. The URL including the parameter values MUST conform to [RFC3986] and MUST use UTF-8 character encoding.¶
General format of a query parameter element.¶
index
MUST be between 0 and 99 inclusive.¶
operation - is an operation on a property and a value. Not all operations require a value, and not all properties will permit every operation. Available operations are:¶
Example 1¶
For the example above the results returned would include resources that have: property1
equal to foo
and property2
equal to foo
or resources that have property1
equal to test
and property2
not equal to bar
.¶
Example 2 based on Section 12.8.1.¶
For the example above the vendor results returned would include resources that have a name
property value that contains either acme
or test
.¶
Some resource operations make a request to modify or create data. To facilitate an out-of-band approval step, where data can be inspected to insure it meets the business requirements of the validation authority which operates the server, the operations will return a request
url that can be used to obtain information about the status and disposition of the requested modification. Whether or how an authority implements an approval step is outside the scope of this specification.¶
A request resource is not externally updateable, but SHOULD update based on server processing. The properties for a request response:¶
string
, identifier for this resource¶
status - string
, one of:¶
string
, a placeholder for any message describing a rejection¶
string
, a link to the resource which was created or modified as a result of the requested operation¶
GET /requests¶
Returns a paged listing of requests for the current user. Each element in the data
array is a request object
as described in Section 12.7.2. See also Section 12.5.2 for a description of a paged response.¶
The available properties for vendor resources are:¶
string
, identifier for the vendor resource within which this property is located¶
string
¶
string
¶
string
¶
phoneNumbers - array of phone objects,¶
string
, identifier for the list of person resources associated with this vendor¶
addresses - an address object,¶
GET /vendors¶
Returns a paged listing of vendors. Each element in the data
array is a vendor object
as described in Section 12.8.3. See also Section 12.5.2 for a description of a paged response.¶
Available Section 12.6:¶
POST /vendors¶
Request the creation of a new Vendor.¶
name
is required and all other defined properties are OPTIONAL.
Any additional properties included in the request are ignored.¶
[ {"acvVersion": "{acvp-version}"}, { "name": "Acme, LLC", "website": "www.acme.acme", "emails" : [ "inquiry@acme.acme" ], "phoneNumbers" : [{ "number" : "555-555-1234", "type" : "voice" }], "addresses" : [{ "street1" : "123 Main Street", "locality" : "Any Town", "region" : "AnyState", "country" : "USA", "postalCode" : "123456" }] } ]¶
Reply is a request response as described in Section 12.7. If status
is approved
the approvedUrl
returned will be the identifier of the vendor resource which was created. The url of any resources created incidental to the creation of the vendor resource would be available through the Section 12.8.3 operation.¶
Reply is a request response as described in Section 12.7.¶
GET /vendors/{vendorId}¶
Retrieve Information for a specific vendor¶
[ {"acvVersion": "{acvp-version}"}, { "url": "/acvp/v1/vendors/2", "name": "Acme, LLC", "website": "www.acme.acme", "emails" : [ "inquiry@acme.acme" ], "phoneNumbers" : [{ "number" : "555-555-1234", "type" : "voice" }], "contactsUrl": "/acvp/v1/vendors/2/contacts", "addresses" : [{ "url" : "/acvp/v1/vendors/1/addresses/4", "street1" : "123 Main Street", "locality" : "Any Town", "region" : "AnyState", "country" : "USA", "postalCode" : "123456" }] } ]¶
PUT /vendors/{vendorId}¶
Update a vendor¶
The url
property is not updateable.¶
Can be any subset of the updateable properties. If a property is not included its value is not changed. A null
value for a property indicates the value should be removed.¶
When updating the addresses array, the url
of every address resource to be kept MUST be included. Any missing addresses will be removed and any new addresses will be created.¶
[ {"acvVersion": "{acvp-version}"}, { "name": "Acme, LLC", "website": "www.acme.acme", "emails" : [ "inquiry@acme.acme" ], "addresses" : [{ "url" : "/acvp/v1/vendors/2/addresses/4", "street1" : "123 Main Street", "locality" : "Any Town", "region" : "AnyState", "country" : "USA", "postalCode" : "123456" }] } ]¶
Reply is a request response as described in Section 12.7. If status
is approved
the approvedUrl
returned will be the identifier of the vendor resource which was updated. A server implementation MAY create a new resource instead of updating the existing resource.¶
DELETE /vendors/{vendorId}¶
Request to delete a specific vendor. Reply is a request response as described in Section 12.7.¶
The server is not required to remove the resource but MUST return a rejection`value for the `status
property if the resource will not be removed.¶
GET /vendors/{vendorId}/contacts¶
Returns a paged listing of persons specific to the vendor. Each element in the data
array is a person object
as described in Section 12.10.3. See also Section 12.5.2 for a description of a paged response.¶
The available properties for address resources are:¶
string
, identifier for this resource¶
string
¶
string
¶
string
¶
string
¶
string
¶
string
¶
string
¶
GET /vendors/{vendorId}/addresses¶
Returns a paged listing of addresses for the vendor. Each element in the data
array is an address object
as described in Section 12.9.2. See also Section 12.5.2 for a description of a paged response.¶
The addresses returned are equivalent to the address array returned in Section 12.8.3 for the same vendor resource.¶
GET /vendors/{vendorId}/addresses/{addressId}¶
Retrieve Information for a specific address¶
The available properties for person resources are:¶
string
, identifier for this resource¶
string
¶
string
, identifier for the vendor resource this person is associated with¶
string
¶
phoneNumbers - array of phone objects,¶
The email and phone number values are specific to the person resource and are independent of the equivalent information in the vendor resource.¶
GET /persons¶
Returns a paged listing of persons. Each element in the data
array is a person object
as described in Section 12.10.3. See also Section 12.5.2 for a description of a paged response.¶
Available Section 12.6:¶
POST /persons¶
Request the creation of a new Person.¶
fullName
and vendorUrl
are required. Other defined resource properties are OPTIONAL.
Any additional properties included in the request are ignored.¶
[ {"acvVersion": "{acvp-version}"}, { "fullName": "Jane Smith", "vendorUrl" : "/acvp/v1/vendors/2", "emails": ["jane.smith@acme.acme"], "phoneNumbers" : [ { "number": "555-555-0001", "type" : "fax" }, { "number": "555-555-0002", "type" : "voice" } ] } ]¶
Reply is a request response as described in Section 12.7. If status
is approved
the approvedUrl
returned will be the identifier of the person resource which was created.¶
GET /persons/{personId}¶
Retrieve Information for a specific person¶
[ {"acvVersion": "{acvp-version}"}, { "url": "/acvp/v1/persons/4", "fullName": "Jane Smith", "vendorUrl" : "/acvp/v1/vendors/2" "emails": ["jane.smith@acme.acme"], "phoneNumbers" : [ { "number": "555-555-0001", "type" : "fax" }, { "number": "555-555-0002", "type" : "voice" } ] } ]¶
PUT /persons/{personId}¶
Update a person¶
The url
property is not updateable.¶
Can be any subset of the updateable properties. If a property is not included its value is not changed. A null
value for a property indicates the value should be removed.¶
[ {"acvVersion": "{acvp-version}"}, { "fullName": "Jane Smith", "emails": ["jane.smith@acme.acme"], "phoneNumbers" : [ { "number": "555-555-0001", "type" : "fax" }, { "number": "555-555-0002", "type" : "voice" } ] } ]¶
Reply is a request response as described in Section 12.7. If status
is approved
the approvedUrl
returned will be the identifier of the person resource which was updated. A server implementation MAY create a new resource instead of updating the existing resource.¶
DELETE /persons/{personId}¶
Request to delete a specific person. Reply is a request response as described in Section 12.7.¶
The server is not required to remove the resource but MUST return a rejection
value for the status
property if the resource will not be removed.¶
The available properties for module resources are:¶
string
, identifier for this resource¶
string
¶
string
¶
type - string
, valid values are:¶
string
¶
string
, identifier for a Section 12.8¶
string
, identifier for an Section 12.9¶
string array
, array of identifiers for a Section 12.10¶
string
, a description of the implementation¶
GET /modules¶
Returns a paged listing of modules. Each element in the data
array is a module object
as described in Section 12.11.3. See also Section 12.5.2 for a description of a paged response.¶
Available Section 12.6:¶
POST /modules¶
Register a new module.¶
name
, vendorUrl
, and description
are required. Other defined resource properties are OPTIONAL.
Any additional properties included in the request are ignored.¶
[ {"acvVersion": "{acvp-version}"}, { "name": "ACME ACV Test Module", "version": "3.0", "type": "Software", "vendorUrl": "/acvp/v1/vendors/2", "addressUrl": "/acvp/v1/vendors/2/addresses/4", "contactUrls": ["/acvp/v1/persons/1" ], "description" : "ACME module with more" } ]¶
Reply is a request response as described in Section 12.7. If status
is approved
the approvedUrl
returned will be the identifier of the module resource which was created. The url of any resources created incidental to the creation of the module resource would be available through the Section 12.11.3 operation.¶
GET /modules/{moduleId}¶
Returns information about a specific module.¶
[ {"acvVersion": "{acvp-version}"}, { "url": "/acvp/v1/modules/2", "name": "ACME ACV Test Module", "version": "2.0", "type": "Software", "website" : "www.acme.acme", "vendorUrl": "/acvp/v1/vendors/2", "addressUrl": "/acvp/v1/vendors/2/addresses/4", "contactUrls": ["/acvp/v1/persons/1" ], "description": "ACME module with features." } ]¶
PUT /modules/{moduleId}¶
Update an existing module.¶
It may not be possible to update all properties of a module once the module has been associated with a test session.¶
[ {"acvVersion": "{acvp-version}"}, { "description" : "ACME module with more" } ]¶
Reply is a request response as described in Section 12.7. If status
is approved
the approvedUrl
returned will be the identifier of the module resource which was updated. A server implementation MAY create a new resource instead of updating the existing resource.¶
DELETE /modules/{moduleId}¶
Request to delete a specific module. Reply is a request response as described in Section 12.7.¶
The server is not required to remove the resource but MUST return a rejection
value for the status
property if the resource will not be removed.¶
The available properties for operational environment resources are:¶
string
, identifier for this resource¶
string
¶
string
which identify the Section 12.13 which comprise this OE.¶
dependencyUrls
property.¶
GET /oes¶
Returns a paged listing of available operational environments. Each element in the data
array is a operational environment object
as described in Section 12.12.3. See also Section 12.5.2 for a description of a paged response.¶
Available Section 12.6:¶
eq
, start
, end
, contains
¶
POST /oes¶
Create a new operational environment.¶
name
is required. Other defined resource properties are OPTIONAL.
Any additional properties included in the request are ignored.¶
[ {"acvVersion": "{acvp-version}"}, { "name": "Ubuntu Linux 3.1 on AMD 6272 Opteron Processor with Acme installed", "dependencyUrls": [ "/acvp/v1/dependencies/4", "/acvp/v1/dependencies/5", "/acvp/v1/dependencies/7" ] } ]¶
Reply is a request response as described in Section 12.7. If status
is approved
the approvedUrl
returned will be the identifier of the operational environment resource which was created. The url of any resources created incidental to the creation of the operational environment resource would be available through the Section 12.8.3 operation.¶
GET /oes/{oeId}¶
Returns information about a specific operational environment.¶
[ { "acvVersion": "{acvp-version}" }, { "url": "/acvp/v1/oes/21495", "name": "Test DMC0428 Inline Ubuntu Linux 3.1 on AMD 6272 Opteron Processor with Acme package installed", "dependencies": [ { "url": "/acvp/v1/dependencies/23563", "type": "software", "name": "Linux 3.1 DMC0427 Extra", "description": "Testing0427 cpe-2.3:o:ubuntu:linux:04.27" }, { "url": "/acvp/v1/dependencies/23564", "type": "software", "name": "Linux 4.3 DMC0428 A1", "description": "Testing0428 A1 cpe-2.3:o:ubuntu:linux:4.3", "cpe": "cpe-2.3:oa1:ubuntu:linux:4.3" }, { "url": "/acvp/v1/dependencies/23565", "type": "software", "name": "Linux 4.3 DMC0428 B1", "description": "Testing0428 B1 cpe-2.3:o:ubuntu:linux:4.3", "cpe": "cpe-2.3:ob1:ubuntu:linux:4.3" }, { "url": "/acvp/v1/dependencies/23566", "type": "software", "name": "Linux 4.3 DMC0428 C1", "description": "Testing0428 C1 cpe-2.3:o:ubuntu:linux:4.3", "cpe": "cpe-2.3:oc1:ubuntu:linux:4.3" } ] } ]¶
PUT /oes/{oeId}¶
Update an existing operational environment.¶
It may not be possible to update all (or any) properties of an operational environment resource once the resource has been associated with a test session.¶
[ {"acvVersion": "{acvp-version}"}, { "name": "Windows 10 on Intel Xeon 5100 Series Processor", } ]¶
Reply is a request response as described in Section 12.7. If status
is approved
the approvedUrl
returned will be the identifier of the operational environment resource which was updated. A server implementation MAY create a new resource instead of updating the existing resource.¶
DELETE /oes/{oeId}¶
Request to delete an operation environment. Reply is a request response as described in Section 12.7.¶
The server is not required to remove the resource but MUST return a rejection
value for the status
property if the resource will not be removed.¶
An operational environment is composed of one or more dependencies which fully characterize and describe the operational environment under which a module was tested. An operational environment MAY have many different types of dependencies.¶
The available properties for dependency resources are:¶
string
, identifier for this resource¶
type - string
, the type of the dependency, a non-inclusive list of values that MAY be allowed are:¶
string
, a short name of the dependency¶
string
, a longer description of the dependency providing any additional detail that may be useful¶
{varies}
the value of type
for a dependency MAY require or allow for different name/value pairs to be added to a dependency to better describe and define the dependency which in turn describes the operational environment that a module will operate under. The possible name/value pairs for a given value of type
MAY be provided by the response of Section 12.13.3, if the server implements this endpoint.
Otherwise a server MAY choose to restrict or not restrict the range of name/value pairs available, but any
restrictions MUST be clearly documented.¶
GET /dependencies¶
Returns a paged listing of available dependencies. Each element in the data
array is a dependency object
as described in Section 12.13.4. See also Section 12.5.2 for a description of a paged response.¶
Available Section 12.6:¶
POST /dependencies¶
Register a new dependency.¶
name
is required. Other defined resource properties are OPTIONAL.
Any additional properties included in the request are ignored.¶
[ {"acvVersion": "{acvp-version}"}, { "type": "software", "name": "Linux 3.1", "description" : "Ubuntu Linux Distribution 3.1", "cpe": "cpe-2.3:o:ubuntu:linux:3.1" } ]¶
Reply is a request response as described in Section 12.7. If status
is approved
the approvedUrl
returned will be the identifier of the dependency resource which was created.¶
(Optional) GET /dependencies/properties¶
Returns a Section 12.5 list of available dependency properties.¶
An array of property objects is returned with the following properties:¶
string
¶
string
¶
string
where each element corresponds to a dependency type value that this property may be used with.¶
string
¶
{ "name": "swid", "dataType": "string", "validTypes": ["software"], "description": "A Software identification (SWID) tag as described in ISO/IEC 19770-2:2015. NIST IR 8060, https://csrc.nist.gov/publications/detail/nistir/8060/final, provides guidance on creating and maintaining SWID tags." }, { "name": "cpe", "dataType": "string", "validTypes": [ "software", "processor" ], "description": "A Common Platform Enumeration (CPE) formatted name according to Version 2.3 of the CPE Naming Specification found in NISTIR 7695, https://csrc.nist.gov/publications/detail/nistir/7695/final." }, { "name": "manufacturer", "dataType": "string", "validTypes": ["processor"], "description": "The name of the manufacturer of the processor dependency." }, { "name": "family", "dataType": "string", "validTypes": ["processor"], "description": "The name of the family of the processor." }, { "name": "series", "dataType": "string", "validTypes": ["processor"], "description": "The name of the series of the processor." }¶
GET /dependencies/{dependencyId}¶
Returns information about a specific dependency.¶
[ {"acvVersion": "{acvp-version}"}, { "type": "software", "name": "Linux 3.1", "description" : "Ubuntu Linux Distribution 3.1", "cpe": "cpe-2.3:o:ubuntu:linux:3.1" } ]¶
PUT /dependencies/{dependencyId}¶
Update an existing dependency.¶
It may not be possible to update all (or any) properties of a dependency resource once the resource has been associated with an operational environment.¶
[ {"acvVersion": "{acvp-version}"}, { "name": "Linux 3.1.0", } ]¶
Reply is a request response as described in Section 12.7. If status
is approved
the approvedUrl
returned will be the identifier of the dependency resource which was updated. A server implementation MAY create a new resource instead of updating the existing resource.¶
DELETE /dependencies/{dependencyId}¶
Request to delete a dependency. Reply is a request response as described in Section 12.7.¶
The server is not required to remove the resource but MUST return a rejection
value for the status
property if the resource will not be removed.¶
The Algorithm resources are informational only.¶
GET /algorithms¶
Returns a list of available algorithms on the server.¶
[ {"acvVersion": "{acvp-version}"}, {"algorithms": [ { "id": 1, "name": "AES", "mode": "GCM", "revision": "v1.0" }, { "id": 2, "name": "AES", "mode": "ECB", "revision": "v1.0" } ]} ]¶
GET /algorithms/{algorithmId}¶
Retrieve Information for about a specific algorithm.¶
Response may vary from server depending on internal representation.¶
The Validations resources are informational only.¶
GET /validations/{validationId}¶
Retrieve information about a specific validation.¶
Response MAY vary from server depending on internal representation. Available properties for validations MAY include (but are not limited to):¶
string
, identifier for this resource¶
string
, unique representation of the validation and source.¶
string
, the module URL associated with this validation. See Section 12.11¶
array of string
, the Operational Environments associated with this validation. See Section 12.12¶
[ {"acvVersion": "{acvp-version}"}, { "url": "/acvp/v1/validations/50", "validationId": "A12", "moduleUrl": "/acvp/v1/modules/1", "oeUrls": [ "/acvp/v1/oes/1" ] } ]¶
The available properties for test session resources are:¶
string
, identifier for this resource¶
string
, version of ACV protocol used to created the test session.¶
boolean
¶
string
, resource for all of the vector sets¶
boolean
, indicates whether this test session may be submitted for validation¶
boolean
, indicates whether all of the vector set tests have passed¶
boolean
, if true Section 12.17.7 will return expected result values. As well, Test Vector Sets MAY contain fewer Test Cases for quicker generation and verification.¶
GET /testSessions¶
This is an OPTIONAL operation.¶
Returns a paged listing of test sessions for the current user. Each element in the data
array is a test session object
as described in Section 12.16.3. See also Section 12.5.2 for a description of a paged response.¶
POST /testSessions¶
Create a new Test Session.¶
algorithms
is an array of algorithm objects. Each algorithm object has the following available properties:¶
string
, required¶
Additional properties for each algorithm are based on the algorithm definition available in each sub-specification.¶
If not provided isSample
, and encryptAtRest
default to false
.¶
[ {"acvVersion": "{acvp-version}"}, { "isSample" : true, "algorithms": [{ "algorithm": "TEST_ALGO_1", "property1": true, "property2": ["operation1", "operation2"] }]} ]¶
accessToken
is a [RFC7519] which MUST be supplied as described in Section 12.3 in order to access the Test Session.¶
[ {"acvVersion": "{acvp-version}"}, { "url": "/acvp/v1/testSessions/2", "acvpVersion": "{acvp-version}", "createdOn": "2018-05-31T12:03:43Z", "expiresOn": "2018-06-30T12:03:43Z", "encryptAtRest": false, "vectorSetUrls": [ "/acvp/v1/testSessions/2/vectorSets/10", "/acvp/v1/testSessions/2/vectorSets/11", "/acvp/v1/testSessions/2/vectorSets/12" ], "publishable": false, "passed": true, "isSample": true, "accessToken" : "eyJhbGciOiJIUzI1NiIsInR5cCI6Ik (truncated)" } ]¶
GET /testSessions/{testSessionId}¶
Returns information about the specific Test Session¶
[ {"acvVersion": "{acvp-version}"}, { "url": "/acvp/v1/testSessions/2", "acvpVersion": "{acvp-version}", "createdOn": "2018-05-31T12:03:43Z", "expiresOn": "2018-06-30T12:03:43Z", "encryptAtRest": false, "vectorSetsUrl": "/acvp/v1/testSessions/2/vectorSets", "publishable": false, "passed": true, "isSample": true } ]¶
PUT /testSessions/{testSessionId}¶
Certify the Test Session for validation.¶
Associates all of the testing information with the test session. The test session MUST be have both publishable
and passed
set to true
.¶
Available properties:¶
string
¶
moduleUrl
, but SHOULD only be used when the goal is to create a new module resource, otherwise use moduleUrl
to use an existing module.¶
string
¶
oeUrl
, but SHOULD only be used when the goal is to create a new operating environment resource, otherwise use oeUrl
to use an existing operating environment.¶
algorithmPrerequisites - array of algorithm prerequiste objects, optional, for any algorithm that has a prerequisite that was not included in testing, the prerequisite MUST be provided by adding an element to this array¶
[ {"acvVersion": "{acvp-version}"}, { "moduleUrl": "/acvp/v1/modules/20", "oeUrl": "/acvp/v1/oes/60", "algorithmPrerequisites": [{ "algorithm": "TEST_ALGO_1", "prerequisites": [ { "algorithm": "TEST_ALGO_0", "validationId": "123456" }, { "algorithm": "TEST_ALGO_0.1", "validationId": "123456" } ] }] } ]¶
Reply is a request response as described in Section 12.7. If status
is approved
the approvedUrl
returned will be the identifier of the validation resource which was created or updated as a result of this certification.¶
DELETE /testSessions/{testSessionId}¶
Delete a test session.¶
Marks a test session as being cancelled and may be deleted by the server. Further operations with the test session resource may return 404 HTTP Status.¶
GET /testSessions/{testSessionId}/results¶
Request Validation Results for a Test Session¶
[ {"acvVersion": "{acvp-version}"}, { "passed": false, "results": [ { "vectorSetUrl": "/acvp/v1/testSessions/2/vectorSets/1", "status": "incomplete" }, { "vectorSetUrl": "/acvp/v1/testSessions/2/vectorSets/2", "status": "passed" } ] } ]¶
The REQUIRED properties for vector set resources are:¶
string
, identifier for this resource¶
number
¶
string
¶
string
¶
testGroups - array of test group objects,¶
GET /testSessions/{testSessionId}/vectorSets¶
Returns a list of Vector Sets for the specific Test Session.¶
The property returned is:¶
string
¶
[ {"acvVersion": "{acvp-version}"}, {"vectorSetUrls": [ "/acvp/v1/testSessions/2/vectorSets/1", "/acvp/v1/testSessions/2/vectorSets/2" ]} ]¶
GET /testSessions/{testSessionId}/vectorSets/{vectorSetId}¶
Vector Set download request.¶
The server will respond with the vector set associated with the vsId for the client to process. The test group content contained in the response will vary depending on the specific sub-specification of the algorithm and testType being tested.¶
[ {"acvVersion": "{acvp-version}"}, { "vsId": 1, "algorithm": "TEST_ALGO_1", "revision": "1.0.0", "testGroups": [ { "tgId": 1, "testGroupProperty1": 1, "testType": "type1", "tests": [ { "tcId": 1, "testCaseProperty1": 1, "testCaseProperty2": "2" }, { "tcId": 2, "testCaseProperty1": 3, "testCaseProperty2": "4" } ... additional tests ... ] }, ... additional test groups ... { "tgId": 3, "testGroupProperty1": 2, "testType": "type2", "tests": [{ "tcId": 2139, "testCaseProperty3": 10 }] } ... additional test groups ... ] } ]¶
If the server did not have enough time to generate the vector set for a given test session, the server may reply:¶
[ { "acvVersion": "{acvp-version}" }, { "vsId": 1, "retry" : 30 } ]¶
Where:¶
The server may set the retry
value based on the current server load and expected processing time to generate the vector set.¶
DELETE /testSessions/{testSessionId}/vectorSets/{vectorSetId}¶
Cancel testing for a specific Vector Set.¶
There may be cases where a particular vector set may not be cancelled and the entire Test Session will need to be cancelled instead.¶
GET /testSessions/{testSessionId}/vectorSets/{vectorSetId}/results¶
Request Validation Results for a Vector Set.¶
When showExpected
was set to true from a POST/PUT under Section 12.17.5, additional information is provided back to the client for any failing test cases. The additional information includes an "expected" as well as "provided" object that MAY be useful in diagnosing issues within the vector set validation.¶
The client will send this request to learn the validation results for an individual vector set. Properties are:¶
number
¶
disposition - string
, the overall result for the vector set with:¶
fail
- indicates at least one test case has failed.¶
unreceived
- indicates the server has not received responses from the client for all the test cases.¶
incomplete
- indicates not all tests have been processed by the server, however none have failed thus far.¶
expired
- indicates not all the test case responses were received from the client prior to expiry.¶
passed
- indicates all test cases have been processed by the server and have passed.¶
missing
- indicates that one or more test case responses were not received from the client.¶
error
- indicates that the server encountered an error while processing the responses provided by the client.¶
tests - array of test result objects¶
number
¶
result - string
, the result for a test case with:¶
fail
- indicates the test case has failed.¶
unreceived
- indicates the server has not received a response from the client for the test case.¶
incomplete
- indicates the server has not processed the test case.¶
expired
- indicates the client did not send the test case response to the server prior to expiry.¶
passed
- indicates the test case passed.¶
missing
- indicates that a response was not received from the client for the test case.¶
string
, provides additional detail in case of a failed
result
value.¶
object
, provides the value(s) the server expected for the test case.¶
object
, provides the value(s) the client provided for the test case.¶
[ {"acvVersion": "{acvp-version}"}, {"results": { "vsId": 1437, "disposition": "incomplete", "tests": [ { "tcId": 12340, "result": "passed", "reason": "" }, { "tcId": 12341, "result": "incomplete", "reason": "" }, { "tcId": 12342, "result": "failed", "reason": "Algorithm reason XXX" } ] }} ]¶
POST /testSessions/{testSessionId}/vectorSets/{vectorSetId}/results¶
Initial Submission of Vector Set Test Results.¶
The client will send this request to submit the test results for an individual vector set. Similar to the vector set download the format will vary depending on the specific sub-specification of the algorithm and testType being tested.¶
[ {"acvVersion": "{acvp-version}"}, { "vsId": 1437, "revision": "1.0.0", "showExpected": true, "testGroups": [{ "tgId": 1, "tests": [{ "tcId": 12340, "testCaseProperty1": "ABCD", "testCaseProperty2": "1234" }, { "tcId": 12341, "testCaseProperty1": "5678", "testCaseProperty2": "FEDC" }, ... ] }, ... ] } ]¶
The showExpected
property is optional; when included (and set to true) the ACVP server will include additional information within the validation response file described in Section 12.17.4.¶
No content response. Standard HTTP status codes will indicate success or failure of the submission, but do not indicated the disposition of the tests.¶
PUT /testSessions/{testSessionId}/vectorSets/{vectorSetId}/results¶
Update Vector Set Test Results Submission.¶
When one or more test cases fails, the client will need to correct the issue in the crypto module and send the responses again. The resending of responses for failed test cases will occur for an entire vector set. Therefore, even if only a single test case in the vector set failed, the client will need to download, process, and upload responses to the server for the entire vector set (presumably after the problem has been corrected in the implementation). The resending of vector set responses MUST occur prior to expiry.¶
The request content is identical to the request content described in Section 12.17.5.¶
GET /testSessions/{testSessionId}/vectorSets/{vectorSetId}/expected¶
Expected Test Results. Expected test results SHALL be generated by the server if the isSample test session resource equals true. See Section 12.16.¶
The response is identical to the request content described in Section 12.17.5.¶
When clients have a response which exceeds the sizeConstraint
in Section 10, this endpoint MUST be used to obtain a URI in order to submit the results. The URI MAY be a one-time use URI and clients SHOULD only attempt to use this URI once regardless of success or failure in submitting. If resubmission is required clients MUST re-POST to the /large endpoint in order to obtain the URI to use.¶
The available properties for large submissions:¶
number
, the maximum size in bytes of the desired submission.¶
string
, an identifier of the vector set that will be uploaded as a large submission.¶
string
, a one-time use url value to use for a large submission.¶
string
, an optional JWT, that if provided, clients MUST use when accessing the url
. If not provided, clients MUST use their current accessToken
when accessing the url
.¶
Vector sets can expire. For example, in terms of a validation authority use, the vector sets are one-time use only. Old vector sets can never be reused to obtain a new validation certificate for an algorithm implementation or to update an existing certificate. Expiration is a server specific definition which depends on database costs, need for artifacts, etc. If the vector set has expired, the server will reply with an expired response when the client attempts to download the vector set:¶
[ {"acvVersion": "{acvp-version}"}, { "vsId": 42, "status": "expired" } ]¶
The ACVP protocol requires server implementations to generate test values and retain the data while the ACVP client processes and returns the results. Some crypto modules implementing the client-side ACVP protocol may not return results immediately. The ACVP protocol design implies the server must retain the test values to verify the client test responses at some time in the future. However, some test vector sets are fairly large, which could place significant storage requirements on ACVP server implementations. To alleviate long term storage requirements, ACVP allows for an expiration timestamp to be set when a test vector set is generated by the server.¶
The vector set expiration timestamp must be included by the server in the vector set when the client downloads the vector set. The server may change the expiration timestamp of a previously issued vector set to extend its lifetime subject to server policy. The expiration timestamp must be in the 'expiry' JSON value, which is included in the JSON encoded vector set. The expiry JSON value will be a string value of the UTC timestamp using form "YYYY-MM-DD HH:MM:SS". The following figure shows a partial JSON encoded vector set that contains the expiry value.¶
[ {"acvVersion": "{acvp-version}"}, { "vsId": 1437, "expiry": "2018-12-31 23:59:59", "algorithm": "TEST_ALGO_1", "revision": "1.0.0", "testGroups": [ { "tgId": 1, "testGroupProperty1": 1, "testType": "type1", "tests": [ { "tcId": 1, "testCaseProperty1": 1, "testCaseProperty2": "2" }, { "tcId": 2, "testCaseProperty1": 3, "testCaseProperty2": "4" }, . . . <remainder of vector set omitted from figure> . . . ] }] } ]¶
Errors will follow HTTP[S] numbering scheme. In addition errors as well as 200 messages may carry JSON encoded information that describes in detail the error and any associated troubleshooting information. Examples of client and server error messages are in Appendix B.¶
ACVP is intended to be an extensible protocol that supports testing of a large number of cryptographic algorithms from several different classes defined by the community. All algorithm identifiers intended for public use SHALL be documented by IANA in the ACVP IANA Registry [acvp-iana].¶
To add testing for a new algorithm first try to find an algorithm of the same type that is already supported by the protocol.¶
If it belongs to an already-supported type, check the test specification for the similar algorithm. Typically, similar algorithms share similar testing methodology.¶
For example, the testing of symmetric block ciphers is comprised of two test types: Algorithm Functional Tests and Monte Carlo Tests - see [sub-symmetric].¶
Assuming that the existing test types provide sufficient test coverage for the new algorithm, one needs to add the new block cipher algorithm to the symmertic block cipher specification [sub-symmetric], including the JSON schema for the corresponding test data exchanges between the validation server and the client. See in particular Section "Adding new algorithms" in the corresponding algorithm specification.¶
Next, one needs to update the IANA registry with the new algorithm by adding it to the corresponding namespace and subject to the policies stated in [acvp-iana].¶
Once this is completed and the corresponding server test generation and validation for that algorithm are implemented, testing can commence. Clients implementing that algorithm may register it for testing as described in Section "Capabilities Registration" in [sub-symmetric], process the test vectors generated by the validation server and return the results for validation.¶
If the available test types for an algorithm, existing or new, in a given class do not provide good test coverage of the algorithm, one could develop a new test type and incorporate it into the corresponding test specification for the that algorithm. See for example Section "Adding new algorithms" in [sub-symmetric] for how to add a new test type. Note that this action would require modifications of the corresponding algorithm test specification and would result in a new version of that test specification to be reflected in the IANA registry [acvp-iana].¶
Bitstrings are used to communicate a string of bits between the ACVP server and IUT.¶
BitStrings SHALL be considered in big endian order, unless otherwise specified by the algorithm.¶
The hex string "FA" (assuming all bits are considered) SHALL represent the bits 11111010 (in MSb) or the value 250.¶
"valueLen" will be used as the example, but it can apply to any bit length registration/vector set/etc parameters.¶
When a "value" is provided along with a "valueLen", the "valueLen" MUST be considered when parsing the hex string represented in "value", EXCEPT in empty bitstring cases, which MUST be represented as an empty string "". Parsing Hex strings into Bit strings is especially important for algorithms such as the SHA variations that may only include a portion of bits from the provided hex string. When only a portion of bits from a Hex string are considered, bits for use in the bitstring SHALL be taken from the most significant bits, meaning the lesser significant bits are the bits that are dropped.¶
The Range object can be used to convey a range of values. It contains its own set of properties made up of "min", "max", and "increment". "inc" may be used as a shorthand for "increment." If the "increment" property is omitted, a default value of 1 SHALL be used.¶
A range object specifying a minimum of 1, a maximum of 8, with an increment of 1. This range object includes the values 1, 2, 3, 4, 5, 6, 7, and 8.¶
{"myRange": { "min": 1, "max": 8, "increment": 1 }}¶
A range object specifying a minimum of 0, a maximum of 8, with an increment of 2. This range object includes the values 0, 2, 4, 6, and 8.¶
{"myRange": { "min": 0, "max": 8, "increment": 2 }}¶
The Domain object can be used to specify a set of values similar to Range, albeit with more control. A domain can be made up of an array of objects, where those objects can be literal values, and/or Range objects.¶
Several sample domain objects that state 0, 8, 16, 32, 96, 128, 192, and 256 are valid values.¶
{"myDomain": [ { "min": 0, "max": 16, "increment": 8 }, 32, 96, { "min": 128, "max": 256, "increment": 64 } ]}¶
{"myDomain": [ 0, 8, 16, 32, 96, 128, 192, 256 ]}¶
Because the Domain is an array of objects consisting of (potentially) both literals and ranges, algorithms that use an array of integers can be used interchangably with the Domain object.¶
This document does not require any action by IANA.¶
When an ACVP client is attached to a cryptographic module that is in use, access to ACVP MUST be controlled so that only an administrator or other authorized user can send and receive ACVP messages. This is because an attacker that has access to ACVP can potentially use it to probe for weaknesses in the cryptographic module.¶
Original ACV Protocol created by David McGrew, Bill Hudson and Anthony Grieco of Cisco Systems. Additional contributions made by Sam Farthing, Ellie Daw and Philip Perricone from Cisco Systems and Christopher Celi and Russell Hammett from NIST.¶
All JSON keywords SHALL use lower camelCase format with no underscores or hyphens and use the following characters only a-z, A-Z, 0-9. Keywords SHALL abbreviate common words and phrases wherever possible for brevity.¶
For example: password length - pwLen plain text length - ptLen¶
Keywords SHOULD be chosen such that they are informative and brief, for example:¶
[ { "acvVersion": "{acvp-version}" }, { "results" : { "disposition" : "incomplete" } } ]¶
Metadata assigned to the keyword may use any format which best reflects the information being represented including hyphens, underscores alternating case, numbers, etc. However, brevity should be a major consideration, for example:¶
{ "algorithms" : [ { "algorithm" : "ACVP-AES-GCM", "mode" : "modes", "ivGen" : "internal", "ivGenMode" : "8.2.1" } ] }¶
All metadata representing strings or big numbers SHALL use double quotes at both ends. Big numbers require conversion from strings to whatever format is used by the DUT. Numerical values of integer size or with decimal points may use quotations if those values are generally used as a string, for example the acvVersion would generally be used in displaying information not in any mathematical operations. Something like keyLen or ptLen values would be better used without quotes to avoid having to convert the string to an integer for use in the code.¶
General or registration errors detected by the server SHALL result in an HTML error and description of the problem, for example:¶
Errors detected by the client SHOULD trigger an indication of the operation that failed and a detailed error description. This information can be sent to the clients local logging facility to provide traceability of communication issues, for example:¶