The CCKeyComponentType element is used by the loadKeyComponent web service to transport a Key Component and all its metadata as a single object. The SOAP interface will pass this parameter to the web service as a structured object, whereas the REST interface will pass a JSON representation of that structured object.
The following example defines the CCKeyComponentType element using the SOAP interface.
|
# |
CCKeyComponentTypeXML Content |
|---|---|
|
1 |
<xs:complexType name="CCKeyComponentType"> |
|
2 |
<xs:sequence> |
|
3 |
<xs:element name="KeyName" type="xs:string" minOccurs="0"/> |
|
4 |
<xs:element name="KeyComponent" type="xs:string" minOccurs="0"/> |
|
5 |
<xs:element name="KeyCheckValue" type="xs:string" minOccurs="0"/> |
|
6 |
<xs:element name="KeyAlgorithm" type="xs:string" minOccurs="0"/> |
|
7 |
<xs:element name="KeySize" type="xs:string" minOccurs="0"/> |
|
8 |
<xs:element name="KValue" type="xs:int" minOccurs="0"/> |
|
9 |
<xs:element name="NValue" type="xs:int" minOccurs="0"/> |
|
10 |
</xs:sequence> |
|
11 |
</xs:complexType> |
The following table explains each line of the above XML file:
|
# |
CCKeyComponentTypeXML Content Explanation |
|---|---|
|
1 |
The start of the CCKeyComponentType element. |
|
2 |
The start of a sequence. |
|
3 |
The KeyName element—the identifier for the key that this Key Component belongs to. All Key Components in a set must have the same KeyName. |
|
4 |
The KeyComponent element—a hex-encoded string representation of this Key Component. |
|
5 |
The KeyCheckValue element—a hex-encoded string representation of the Key Check Value (KCV) for this Key Component. The KCV will be checked against the Key Component to verify the integrity of this Key Component. |
|
6 |
The KeyAlgorithm element—the algorithm of the key to which this Key Component belongs. Valid values are AES and TDES. |
|
7 |
The KeySize element—the size of the key to which this Key Component belongs. Only keys of length 128 are currently supported. |
|
8 |
The KValue element—a numerical identifier for this Key Component in the set of Key Components. Must be one of the int values 1, 2, or 3. |
|
9 |
The NValue element—a numerical representation of the total amount of Key Components in this set. Must be one of the int values 2 or 3. |
|
10 |
The end of the sequence. |
|
11 |
The end of the CCKeyComponentType element. |
The following shows an example CCKeyComponentType in JSON format (REST interface):
{
"KeyName": "myBDK",
"KeyComponent": "4010E7B1F6A91C40217A253E3D3131CA",
"KeyAlgorithm": "AES",
"KeyCheckValue": "A60EA8",
"KeySize": "128",
"KValue": 1,
"NValue": 3
}