CertificateManagementRequestV01

catm.007.001.01

The certificate management request message is sent by a POI terminal or any intermediary entity either to a terminal manager acting as a certificate authority for managing X.509 certificate of a public key owned by the initiating party, or for requesting the inclusion or the removal of the POI to a white list of the terminal manager.

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
%% CertificateManagementRequestV01 recursion level 0 with max 0
CertificateManagementRequestV01 *-- "1..1" Header29 : Header
CertificateManagementRequestV01 *-- "1..1" CertificateManagementRequest1 : CertificateManagementRequest
CertificateManagementRequestV01 *-- "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. Set of characteristics related to the reject of a transaction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header29 recursion level 0 with max 1
class Header29{
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    CreationDateTime IsoISODateTime
}
Header29 *-- "1..1" GenericIdentification72 : InitiatingParty
Header29 *-- "0..1" GenericIdentification93 : RecipientParty
%% GenericIdentification72 recursion level 1 with max 1
class GenericIdentification72{
    Identification IsoMax35Text
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification93 recursion level 1 with max 1
class GenericIdentification93{
    Identification IsoMax35Text
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
GenericIdentification93 *-- "0..1" NetworkParameters5 : RemoteAccess
  

Header29 members

CertificateManagementRequest building block

Information related to the request of certificate management. Information related to the request of certificate management. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CertificateManagementRequest1 recursion level 0 with max 1
class CertificateManagementRequest1{
    CertificateService CardPaymentServiceType10Code
    SecurityDomain IsoMax70Text
    BinaryCertificationRequest IsoMax20000Text
    ClientCertificate IsoMax10KBinary
}
CertificateManagementRequest1 *-- "1..1" GenericIdentification72 : POIIdentification
CertificateManagementRequest1 *-- "0..1" GenericIdentification72 : TMIdentification
CertificateManagementRequest1 *-- "0..1" CertificationRequest1 : CertificationRequest
CertificateManagementRequest1 *-- "0..1" PointOfInteraction6 : WhiteListIdentification
%% GenericIdentification72 recursion level 1 with max 1
class GenericIdentification72{
    Identification IsoMax35Text
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification72 recursion level 1 with max 1
class GenericIdentification72{
    Identification IsoMax35Text
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% CertificationRequest1 recursion level 1 with max 1
class CertificationRequest1{
    KeyIdentification IsoMax140Text
    KeyVersion IsoMax140Text
}
CertificationRequest1 *-- "1..1" CertificationRequest2 : CertificateRequestInformation
%% PointOfInteraction6 recursion level 1 with max 1
class PointOfInteraction6{
    ManufacturerIdentifier IsoMax35Text
    Model IsoMax35Text
    SerialNumber IsoMax35Text
}
  

CertificateManagementRequest1 members

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

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    CertificateManagementRequestV01 --|> IOuterRecord : Implements
    CertificateManagementRequestV01Document --|> IOuterDocument~CertificateManagementRequestV01~ : Implements
    class IOuterDocument~CertificateManagementRequestV01~ {
        CertificateManagementRequestV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    CertificateManagementRequestV01Document *-- CertificateManagementRequestV01 : 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:catm.007.001.01">
    <CertMgmtReq>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <CertMgmtReq>
            <!-- CertificateManagementRequest inner content -->
        </CertMgmtReq>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </CertMgmtReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_EQjhgI4KEeW6h7rGyYlyTg"
  nextVersions="_GPQT4dtdEee9e6xduATmQg"
  name="CertificateManagementRequestV01"
  definition="The certificate management request message is sent by a POI terminal or any intermediary entity either to a terminal manager acting as a certificate authority for managing X.509 certificate of a public key owned by the initiating party, or for requesting the inclusion or the removal of the POI to a white list of the terminal manager.&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="CertMgmtReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_mxb7oI4KEeW6h7rGyYlyTg"
    nextVersions="_GPQT49tdEee9e6xduATmQg"
    name="Header"
    definition="Information related to the protocol management."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_RtBnUY4CEeWrZqsymMFdfg" />
  <messageBuildingBlock
    xmi:id="_FkqYQI4LEeW6h7rGyYlyTg"
    nextVersions="_GPQT5dtdEee9e6xduATmQg"
    name="CertificateManagementRequest"
    definition="Information related to the request of certificate management."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CertMgmtReq"
    complexType="_199JII4KEeW6h7rGyYlyTg" />
  <messageBuildingBlock
    xmi:id="_sYvF4I4LEeW6h7rGyYlyTg"
    nextVersions="_GPQT59tdEee9e6xduATmQg"
    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="catm"
    messageFunctionality="007"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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