Iso20022

KeyExchangeInitiationV03

canm.003.001.03

The KeyExchangeInitiation message can be initiated by any party and received by any party (acquirer, agent or issuer). This message is used to initiate a cryptographic key activity (request of a key change, request of the verification of a key, etc.).

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
%% KeyExchangeInitiationV03 recursion level 0 with max 0
KeyExchangeInitiationV03 *-- "1..1" Header63 : Header
KeyExchangeInitiationV03 *-- "1..1" KeyExchangeInitiation2 : Body
KeyExchangeInitiationV03 *-- "0..1" ContentInformationType20 : SecurityTrailer

Now, we will zero-in one-by-one on each of these building blocks.

Header building block

Information related to the management of the protocol. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header63 recursion level 0 with max 1
class Header63{
    MessageFunction MessageFunction23Code
    ProtocolVersion IsoMax2048Text
    ExchangeIdentification IsoMax35Text
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header63 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header63 *-- "1..1" GenericIdentification183 : InitiatingParty
Header63 *-- "0..1" GenericIdentification183 : RecipientParty
Header63 *-- "0..0" AdditionalData1 : TraceData
Header63 *-- "0..0" Traceability9 : Traceability
%% BatchManagementInformation1 recursion level 1 with max 1
class BatchManagementInformation1{
    CollectionIdentification IsoMax35Text
    BatchIdentification IsoMax35Text
    MessageSequenceNumber IsoMax15NumericText
    MessageChecksumInputValue IsoMax140Binary
}
%% GenericIdentification183 recursion level 1 with max 1
class GenericIdentification183{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country ISOMax3ACountryCode
    ShortName IsoMax35Text
}
%% GenericIdentification183 recursion level 1 with max 1
class GenericIdentification183{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country ISOMax3ACountryCode
    ShortName IsoMax35Text
}
%% AdditionalData1 recursion level 1 with max 1
class AdditionalData1{
    Type IsoMax35Text
    Value IsoMax2048Text
}
%% Traceability9 recursion level 1 with max 1
class Traceability9{
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability9 *-- "1..1" GenericIdentification183 : RelayIdentification

Header63 members

Member name Description Data Type / Multiplicity
MessageFunction Identifies the type of process related to the message. MessageFunction23Code - Required 1..1
ProtocolVersion Version of the acquirer to issuer protocol specifications. IsoMax2048Text - Required 1..1
ExchangeIdentification Unique identification of an exchange of messages between two parties. IsoMax35Text - Optional 0..1
ReTransmissionCounter Number of retransmission of the message. Incremented by one for each retransmission. IsoMax3NumericText - Optional 0..1
CreationDateTime Date and time at which the message was sent. IsoISODateTime - Required 1..1
BatchManagementInformation Information related to the batch and the collection to which the message belongs if any. BatchManagementInformation1 - Optional 0..1
InitiatingParty Unique identification of the partner that has initiated the exchange. GenericIdentification183 - Required 1..1
RecipientParty Unique identification of the partner that is the recipient of the message exchange. GenericIdentification183 - Optional 0..1
TraceData Information sent in the request message to be returned in the response one, for instance to help in the retrieval of the context of the exchange. AdditionalData1 - Unknown 0..0
Traceability Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. Traceability9 - Unknown 0..0

Body building block

Information related to a key exchange activity. Information related to a key exchange activity. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% KeyExchangeInitiation2 recursion level 0 with max 1
KeyExchangeInitiation2 *-- "0..1" Context17 : Context
KeyExchangeInitiation2 *-- "1..1" Transaction133 : Transaction
KeyExchangeInitiation2 *-- "0..0" ProtectedData1 : ProtectedData
KeyExchangeInitiation2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Context17 recursion level 1 with max 1
Context17 *-- "0..1" TransactionContext10 : TransactionContext
%% Transaction133 recursion level 1 with max 1
class Transaction133{
    KeyExchangeFunction CardServiceType5Code
    OtherKeyExchangeFunction IsoMax35Text
    MessageReason ISO8583MessageReasonCode
    AlternateMessageReason IsoMax256Text
    KeyExchangeType KeyType1Code
    OtherKeyExchangeType IsoMax35Text
}
Transaction133 *-- "1..1" TransactionIdentification12 : TransactionIdentification
Transaction133 *-- "0..1" KeyExchangeData1 : KeyExchangeData
Transaction133 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction133 *-- "0..0" AdditionalData1 : AdditionalData
%% ProtectedData1 recursion level 1 with max 1
class ProtectedData1{
    ContentType ContentType3Code
}
ProtectedData1 *-- "0..1" EnvelopedData6 : EnvelopedData
ProtectedData1 *-- "0..1" EncryptedData1 : EncryptedData
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

KeyExchangeInitiation2 members

Member name Description Data Type / Multiplicity
Context Contains or describes conditions and characteristics of the transaction. Context17 - Optional 0..1
Transaction Details of an exchange or interaction between parties to perform a specific function. Transaction133 - Required 1..1
ProtectedData Contains protected data and the attributes used to protect the data. ProtectedData1 - Unknown 0..0
SupplementaryData Additional information that can not be captured in the structured fields and/or other specific block. SupplementaryData1 - Unknown 0..0

SecurityTrailer building block

Trailer of the message containing a MAC General cryptographic message syntax (CMS) containing encrypted data. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContentInformationType20 recursion level 0 with max 1
class ContentInformationType20{
    MAC IsoMax8HexBinaryText
}
ContentInformationType20 *-- "1..1" MACData1 : MACData
%% MACData1 recursion level 1 with max 1
class MACData1{
    Control IsoExact1HexBinaryText
    KeySetIdentifier IsoMax8NumericText
    DerivedInformation IsoMax32HexBinaryText
    Algorithm IsoMax2NumericText
    KeyLength IsoMax4NumericText
    KeyProtection IsoMax2NumericText
    KeyIndex IsoMax5NumericText
    PaddingMethod IsoMax2NumericText
    InitialisationVector IsoMax32HexBinaryText
}

ContentInformationType20 members

Member name Description Data Type / Multiplicity
MACData Type of data protection. ISO 8583:87 bit 53 or 110 ISO 8583:93 bit 53 or 111 ISO 8583:2003 bit 53 or 50 MACData1 - Required 1..1
MAC Message Authentication Code data. Binary, length of 8 ISO 8583 bit 64 or bit 128 IsoMax8HexBinaryText - Required 1..1

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the KeyExchangeInitiationV03 implementation follows a specific implementaiton pattern. First of all, KeyExchangeInitiationV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, KeyExchangeInitiationV03Document implements IOuterDocument. Because KeyExchangeInitiationV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type KeyExchangeInitiationV03.

classDiagram
    class IOuterRecord
    KeyExchangeInitiationV03 --|> IOuterRecord : Implements
    KeyExchangeInitiationV03Document --|> IOuterDocument~KeyExchangeInitiationV03~ : Implements
    class IOuterDocument~KeyExchangeInitiationV03~ {
        KeyExchangeInitiationV03 Message
     }

Document wrapper for serialization

The only real purpose KeyExchangeInitiationV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:canm.003.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using KeyExchangeInitiationV03.ToDocument() method. The returned KeyExchangeInitiationV03Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    KeyExchangeInitiationV03Document *-- KeyExchangeInitiationV03 : 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:canm.003.001.03">
    <KeyXchgInitn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </KeyXchgInitn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_oOlvsYv6EeumSPwlS1PkxQ"
  previousVersion="_2CqhVVWVEeeiG_nL4vgKnQ"
  name="KeyExchangeInitiationV03"
  definition="The KeyExchangeInitiation message can be initiated by any party and received by any party (acquirer, agent or issuer). This message is used to initiate a cryptographic key activity (request of a key change, request of the verification of a key, etc.).&#xD;&#xD;&#xA;&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_kT2-dARsEeWTJNHF-ohSqw"
  xmlTag="KeyXchgInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_oOlvs4v6EeumSPwlS1PkxQ"
    previousVersion="_2CqhVlWVEeeiG_nL4vgKnQ"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_pKuBkRvVEey2RdTw-AkXzg" />
  <messageBuildingBlock
    xmi:id="_oOlvtYv6EeumSPwlS1PkxQ"
    previousVersion="_2CqhWVWVEeeiG_nL4vgKnQ"
    name="Body"
    definition="Information related to a key exchange activity."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_Y2XogYv6EeumSPwlS1PkxQ" />
  <messageBuildingBlock
    xmi:id="_oOlvt4v6EeumSPwlS1PkxQ"
    previousVersion="_2CqhWFWVEeeiG_nL4vgKnQ"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC"
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_fP-osaQuEeeWXKXf3KjtmQ" />
  <messageDefinitionIdentifier
    businessArea="canm"
    messageFunctionality="003"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.