KeyBlockHeaders
Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
Contents
- KeyExportability
-
Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from AWS Payment Cryptography.
When set to
EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set toNON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set toSENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022. Type: String
Valid Values:
EXPORTABLE | NON_EXPORTABLE | SENSITIVERequired: No
- KeyModesOfUse
-
The list of cryptographic operations that you can perform using the key. The modes of use are deļ¬ned in section A.5.3 of the TR-31 spec.
Type: KeyModesOfUse object
Required: No
- KeyVersion
-
Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.
Type: String
Length Constraints: Fixed length of 2.
Pattern:
[0-9A-Z]{2}+Required: No
- OptionalBlocks
-
Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022
for information on allowed data type for optional blocks. Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.
Type: String to string map
Key Length Constraints: Fixed length of 2.
Key Pattern:
[0-9A-Z]{2}+Value Length Constraints: Minimum length of 1. Maximum length of 108.
Value Pattern:
[0-9A-Z]+Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
