Parameters
The parameters for CSNBHMV.
For the definitions of the return_code, reason_code, exit_data_length, and exit_data parameters, see Parameters common to all verbs.
- rule_array_count
The number of keywords you supplied in the rule_array parameter. This value must be 2 or 3.Direction: Input Type: Integer - rule_array
Keywords that provide control information to the verb. The following table lists the keywords. Each keyword is left-aligned in 8-byte fields and padded on the right with blanks. All keywords must be in contiguous storage. The rule_array keywords are described in Table 1.Direction: Input Type: String array Table 1. Keywords for HMAC Verify control information Keywords for HMAC Verify control information
Keyword Description Token algorithm (One required) HMAC Specifies that the HMAC algorithm is to be used to verify the MAC. Hash method (One required) SHA-1 Specifies the FIPS-198 HMAC procedure using the SHA-1 hash method, a symmetric key and text to produce a 20-byte (160-bit) MAC. SHA-224 Specifies the FIPS-198 HMAC procedure using the SHA-224 hash method, a symmetric key and text to produce a 28-byte (224-bit) MAC. SHA-256 Specifies the FIPS-198 HMAC procedure using the SHA-256 hash method, a symmetric key and text to produce a 32-byte (256-bit) MAC. SHA-384 Specifies the FIPS-198 HMAC procedure using the SHA-384 hash method, a symmetric key and text to produce a 48-byte (384-bit) MAC. SHA-512 Specifies the FIPS-198 HMAC procedure using the SHA-512 hash method, a symmetric key and text to produce a 64-byte (512-bit) MAC. Segmenting control (Optional) FIRST First call, this is the first segment of data from the application program. LAST Last call; this is the last data segment. MIDDLE Middle call; this is an intermediate data segment. ONLY Only call; segmenting is not employed by the application program. This is the default value. - key_identifier_length
The length of the key_identifier parameter. The maximum value is 9992.Direction: Input Type: Integer - key_identifier
Direction: Input/Output Type: String The identifier of the key to verify the MAC. The key identifier is an operational token or the key label of an operational token in key storage. The key algorithm of this key must be HMAC, the key type must be MAC, and the key usage fields must indicate GENERATE or VERIFY and match the hash method specified in the rule array.
When using a TR-31 token, it must have the following attributes:
- TR-31 key usage: M7
- Algorithm: H
- TR-31 mode of key use: C or V
Furthermore, for TR-31 tokens, the HM optional block must contain the same hash identifier as the hash method rule.
- text_length
The length of the text you supply in the text parameter. The maximum length of text is 214783647 bytes. For FIRST and MIDDLE calls, the text_length must be a multiple of 64 for SHA-1, SHA-224, and SHA-256 hash methods, and a multiple of 128 for SHA-384 and SHA-512 hash methods.Direction: Input Type: Integer - text
The application-supplied text for which the HMAC is to be verified.Direction: Input Type: String - chaining_vector_length
The length of the chaining_vector in bytes. This value must be 128.Direction: Input/Output Type: Integer - chaining_vector
An 128-byte string used as a system work area. Your application program must not change the data in this string. The chaining vector permits data to be chained from one invocation call to another.Direction: Input/Output Type: String On the first call, initialize this parameter as binary zeros.
- mac_length
The length of the mac parameter in bytes. The maximum value is 64.Direction: Input Type: Integer - mac
The field that contains the MAC value you want to verify.Direction: Input Type: String