caam.003.001.02
The ATMKeyDownloadRequest message is sent by an ATM to an ATM manager to initiate the download of one or several cryptographic keys.
Message Construction
Every ISO20022 message has at the highest level what we call ‘building blocks’. Because the message is constructed as immutable records, the association is by composition. Below you can see the relationship between the message and its constituent building blocks: For comparison, see the ISO20022 official specification
classDiagram
direction LR
%% ATMKeyDownloadRequestV02 recursion level 0 with max 0
ATMKeyDownloadRequestV02 *-- "1..1" Header31 : Header
ATMKeyDownloadRequestV02 *-- "0..1" ContentInformationType10 : ProtectedATMKeyDownloadRequest
ATMKeyDownloadRequestV02 *-- "0..1" ATMKeyDownloadRequest2 : ATMKeyDownloadRequest
ATMKeyDownloadRequestV02 *-- "0..1" ContentInformationType13 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Information related to the protocol management on a segment of the path from the ATM to the acquirer. Information related to the protocol management on a segment of the path from the ATM to the acquirer. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header31 recursion level 0 with max 1
class Header31{
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoMax3NumericText
CreationDateTime IsoISODateTime
InitiatingParty IsoMax35Text
RecipientParty IsoMax35Text
ProcessState IsoMax35Text
}
Header31 *-- "1..1" ATMMessageFunction2 : MessageFunction
Header31 *-- "0..0" Traceability4 : Traceability
%% ATMMessageFunction2 recursion level 1 with max 1
class ATMMessageFunction2{
Function MessageFunction11Code
ATMServiceCode IsoMax35Text
HostServiceCode IsoMax35Text
}
%% Traceability4 recursion level 1 with max 1
class Traceability4{
SequenceNumber IsoMax35Text
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability4 *-- "1..1" GenericIdentification77 : RelayIdentification
Header31 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | ATMMessageFunction2 - Required 1..1 |
| ProtocolVersion | Version of the ATM protocol specifications. | IsoMax6Text - Required 1..1 |
| ExchangeIdentification | Unique identification of an exchange occurrence. | IsoMax3NumericText - Required 1..1 |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
| InitiatingParty | Unique identification of the partner that has initiated the exchange. | IsoMax35Text - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | IsoMax35Text - Optional 0..1 |
| ProcessState | State of the sender of the message inside the process flow. | IsoMax35Text - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability4 - Unknown 0..0 |
ProtectedATMKeyDownloadRequest building block
Encrypted body of the message. General cryptographic message syntax (CMS) containing encrypted data. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ContentInformationType10 recursion level 0 with max 1
class ContentInformationType10{
ContentType ContentType2Code
}
ContentInformationType10 *-- "1..1" EnvelopedData4 : EnvelopedData
%% EnvelopedData4 recursion level 1 with max 1
class EnvelopedData4{
Version IsoNumber
}
EnvelopedData4 *-- "1..0" IRecipient4Choice : Recipient
EnvelopedData4 *-- "0..1" EncryptedContent3 : EncryptedContent
ContentInformationType10 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContentType | Type of data protection. | ContentType2Code - Required 1..1 |
| EnvelopedData | Data protection by encryption or by a digital envelope, with an encryption key. | EnvelopedData4 - Required 1..1 |
ATMKeyDownloadRequest building block
Information related to the request of a key download from an ATM. Information related to the request of a key download from an ATM. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ATMKeyDownloadRequest2 recursion level 0 with max 1
class ATMKeyDownloadRequest2{
HostChallenge IsoMax140Binary
}
ATMKeyDownloadRequest2 *-- "1..1" ATMEnvironment15 : Environment
ATMKeyDownloadRequest2 *-- "0..0" ATMCommand2 : CommandResult
ATMKeyDownloadRequest2 *-- "0..1" ATMCommand3 : CommandContext
ATMKeyDownloadRequest2 *-- "1..1" ATMSecurityContext2 : ATMSecurityContext
ATMKeyDownloadRequest2 *-- "1..1" SecurityParameters4 : ATMSecurityParameters
%% ATMEnvironment15 recursion level 1 with max 1
class ATMEnvironment15{
ATMManagerIdentification IsoMax35Text
}
ATMEnvironment15 *-- "0..1" Acquirer7 : Acquirer
ATMEnvironment15 *-- "0..1" TerminalHosting1 : HostingEntity
ATMEnvironment15 *-- "1..1" AutomatedTellerMachine6 : ATM
%% ATMCommand2 recursion level 1 with max 1
class ATMCommand2{
Type ATMCommand2Code
RequiredDateTime IsoISODateTime
ProcessedDateTime IsoISODateTime
Result TerminalManagementActionResult2Code
AdditionalErrorInformation IsoMax140Text
}
ATMCommand2 *-- "0..1" ATMCommandIdentification1 : CommandIdentification
%% ATMCommand3 recursion level 1 with max 1
class ATMCommand3{
Type ATMCommand2Code
}
ATMCommand3 *-- "0..1" ATMCommandIdentification1 : CommandIdentification
%% ATMSecurityContext2 recursion level 1 with max 1
class ATMSecurityContext2{
CurrentSecurityScheme ATMSecurityScheme1Code
}
ATMSecurityContext2 *-- "0..1" ATMEquipment3 : DeviceProperty
ATMSecurityContext2 *-- "0..1" ATMSecurityConfiguration1 : CurrentConfiguration
%% SecurityParameters4 recursion level 1 with max 1
class SecurityParameters4{
Certificate IsoMax5000Binary
ATMChallenge IsoMax140Binary
RequestedKey IsoMax35Text
}
SecurityParameters4 *-- "0..1" CryptographicKey8 : Key
SecurityParameters4 *-- "0..1" ContentInformationType14 : DigitalSignature
ATMKeyDownloadRequest2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the key download. | ATMEnvironment15 - Required 1..1 |
| CommandResult | Result of a maintenance command performed by the ATM. | ATMCommand2 - Unknown 0..0 |
| CommandContext | Security command in progress inside which the key download is requested. | ATMCommand3 - Optional 0..1 |
| ATMSecurityContext | Context of the ATM for the key download. | ATMSecurityContext2 - Required 1..1 |
| ATMSecurityParameters | Security parameters of the ATM for the initiated key download. | SecurityParameters4 - Required 1..1 |
| HostChallenge | Random value from the host provided during a previous exchange. | IsoMax140Binary - Optional 0..1 |
SecurityTrailer building block
Trailer of the message containing a MAC or a digital signature. General cryptographic message syntax (CMS) containing data. protected by a MAC or a digital signature. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ContentInformationType13 recursion level 0 with max 1
class ContentInformationType13{
ContentType ContentType2Code
}
ContentInformationType13 *-- "0..1" AuthenticatedData4 : AuthenticatedData
ContentInformationType13 *-- "0..1" SignedData4 : SignedData
%% AuthenticatedData4 recursion level 1 with max 1
class AuthenticatedData4{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData4 *-- "1..0" IRecipient4Choice : Recipient
AuthenticatedData4 *-- "1..1" AlgorithmIdentification15 : MACAlgorithm
AuthenticatedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
%% SignedData4 recursion level 1 with max 1
class SignedData4{
Version IsoNumber
Certificate IsoMax5000Binary
}
SignedData4 *-- "1..0" AlgorithmIdentification16 : DigestAlgorithm
SignedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
SignedData4 *-- "1..0" Signer3 : Signer
ContentInformationType13 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContentType | Type of data protection. | ContentType2Code - Required 1..1 |
| AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData4 - Optional 0..1 |
| SignedData | Data protected by a digital signatures. | SignedData4 - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the ATMKeyDownloadRequestV02 implementation follows a specific implementaiton pattern. First of all, ATMKeyDownloadRequestV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ATMKeyDownloadRequestV02Document implements IOuterDocument. Because ATMKeyDownloadRequestV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ATMKeyDownloadRequestV02.
classDiagram
class IOuterRecord
ATMKeyDownloadRequestV02 --|> IOuterRecord : Implements
ATMKeyDownloadRequestV02Document --|> IOuterDocument~ATMKeyDownloadRequestV02~ : Implements
class IOuterDocument~ATMKeyDownloadRequestV02~ {
ATMKeyDownloadRequestV02 Message
}
Document wrapper for serialization
The only real purpose ATMKeyDownloadRequestV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caam.003.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ATMKeyDownloadRequestV02.ToDocument() method. The returned ATMKeyDownloadRequestV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ATMKeyDownloadRequestV02Document *-- ATMKeyDownloadRequestV02 : Document
Sample of message format
This is an abbreviated version of what the message should look like.
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:caam.003.001.02">
<ATMKeyDwnldReq>
<Hdr>
<!-- Header inner content -->
</Hdr>
<PrtctdATMKeyDwnldReq>
<!-- ProtectedATMKeyDownloadRequest inner content -->
</PrtctdATMKeyDwnldReq>
<ATMKeyDwnldReq>
<!-- ATMKeyDownloadRequest inner content -->
</ATMKeyDwnldReq>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</ATMKeyDwnldReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_jHkLIa45EeWRfYPBaeOY8w"
nextVersions="_BsUbUbTpEeeQy4o2AayYHg"
previousVersion="_ohA3UItKEeSxlKlAGYErFg"
name="ATMKeyDownloadRequestV02"
definition="The ATMKeyDownloadRequest message is sent by an ATM to an ATM manager to initiate the download of one or several cryptographic keys."
registrationStatus="Registered"
messageSet="_lVeMdARsEeWTJNHF-ohSqw"
xmlTag="ATMKeyDwnldReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_jHkLI645EeWRfYPBaeOY8w"
name="Header"
definition="Information related to the protocol management on a segment of the path from the ATM to the acquirer."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_eMl4Qa1wEeWMg5rOByfExw" />
<messageBuildingBlock
xmi:id="_jHkLJa45EeWRfYPBaeOY8w"
name="ProtectedATMKeyDownloadRequest"
definition="Encrypted body of the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PrtctdATMKeyDwnldReq"
complexType="_UfeMUWizEeS87LmvcA55sg" />
<messageBuildingBlock
xmi:id="_jHkLJ645EeWRfYPBaeOY8w"
name="ATMKeyDownloadRequest"
definition="Information related to the request of a key download from an ATM."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="ATMKeyDwnldReq"
complexType="_no7dga45EeWRfYPBaeOY8w" />
<messageBuildingBlock
xmi:id="_jHkLKa45EeWRfYPBaeOY8w"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC or a digital signature."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_R_tFoYreEeSvuOJS0mmL0g" />
<messageDefinitionIdentifier
businessArea="caam"
messageFunctionality="003"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.