Commit 623dcfc9 authored by Gabriel Commeau's avatar Gabriel Commeau Committed by Mark Canterbury
Browse files

Add XML example of GETCSPCONFIG request-response messages for e-Evidence use case

parent 3eefa5e1

103120/examples/xml/request_ee_config.xml

0 → 100644
+31 −0
Original line number Diff line number Diff line 
<?xml version="1.0" encoding="UTF-8"?>

<!-- Example of a GETCSPCONFIG request to a CSP (Comunications Service Provider). -->

<HI1Message xmlns="http://uri.etsi.org/03120/common/2019/10/Core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:common="http://uri.etsi.org/03120/common/2016/02/Common" xmlns:task="http://uri.etsi.org/03120/common/2020/09/Task" xmlns:auth="http://uri.etsi.org/03120/common/2020/09/Authorisation">

    <Header>

        <SenderIdentifier>

            <CountryCode>XX</CountryCode>

            <UniqueIdentifier>ACTOR01</UniqueIdentifier>

        </SenderIdentifier>

        <ReceiverIdentifier>

            <CountryCode>XX</CountryCode>

            <UniqueIdentifier>ACTOR02</UniqueIdentifier>

        </ReceiverIdentifier>

        <TransactionIdentifier>da735c3f-3ab9-4e9e-810e-daf84d973505</TransactionIdentifier>

        <Timestamp>2025-05-14T15:21:00.000000Z</Timestamp>

        <Version>

            <ETSIVersion>V1.18.1</ETSIVersion>

            <NationalProfileOwner>XX</NationalProfileOwner>

            <NationalProfileVersion>v1.0</NationalProfileVersion>

        </Version>

    </Header>

    <Payload>

        <RequestPayload>

            <ActionRequests>

                <ActionRequest>

                    <ActionIdentifier>0</ActionIdentifier>

                    <GETCSPCONFIG/>

                </ActionRequest>

            </ActionRequests>

        </RequestPayload>

    </Payload>

</HI1Message>
 
 No newline at end of file

103120/examples/xml/response_ee_config.xml

0 → 100644
+181 −0
Original line number Diff line number Diff line 
<?xml version="1.0" encoding="UTF-8"?>

<!-- Example of a CSP (Comunications Service Provider) response to a GETCSPCONFIG request. -->

<HI1Message xmlns="http://uri.etsi.org/03120/common/2019/10/Core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:common="http://uri.etsi.org/03120/common/2016/02/Common" xmlns:task="http://uri.etsi.org/03120/common/2020/09/Task" xmlns:config="http://uri.etsi.org/03120/common/2024/06/Config" xmlns:dictionaries="http://uri.etsi.org/03280/common/2019/10/Dictionaries">

    <Header>

        <SenderIdentifier>

            <CountryCode>XX</CountryCode>

            <UniqueIdentifier>ACTOR01</UniqueIdentifier>

        </SenderIdentifier>

        <ReceiverIdentifier>

            <CountryCode>XX</CountryCode>

            <!-- ACTOR2 is the CSP (Comunications Service Provider) -->

            <UniqueIdentifier>ACTOR02</UniqueIdentifier>

        </ReceiverIdentifier>

        <TransactionIdentifier>da735c3f-3ab9-4e9e-810e-daf84d973505</TransactionIdentifier>

        <Timestamp>2025-05-14T15:21:03.000000Z</Timestamp>

        <Version>

            <ETSIVersion>V1.18.1</ETSIVersion>

            <NationalProfileOwner>XX</NationalProfileOwner>

            <NationalProfileVersion>v1.0</NationalProfileVersion>

        </Version>

    </Header>

    <Payload>

        <ResponsePayload>

            <ActionResponses>

                <ActionResponse>

                    <ActionIdentifier>0</ActionIdentifier>

                    <GETCSPCONFIGResponse>

                        <LastChanged>2025-04-03T07:25:21Z</LastChanged>

                        <!-- ACTOR2 defines 2 new services, ServiceA and Service B, both for LD (Lawful Disclosure) and LP (Lawful Preservation). -->

                        <Dictionaries>

                            <dictionaries:Dictionary>

                                <dictionaries:Owner>ACTOR2</dictionaries:Owner>

                                <dictionaries:Name>LDRequestSubtype</dictionaries:Name>

                                <dictionaries:DictionaryEntries>

                                    <dictionaries:DictionaryEntry>

                                        <dictionaries:Value>ServiceA</dictionaries:Value>

                                        <dictionaries:Meaning>Service A allows users to ...</dictionaries:Meaning>

                                    </dictionaries:DictionaryEntry>

                                    <dictionaries:DictionaryEntry>

                                        <dictionaries:Value>ServiceB</dictionaries:Value>

                                        <dictionaries:Meaning>Service B allows users to ...</dictionaries:Meaning>

                                    </dictionaries:DictionaryEntry>

                                </dictionaries:DictionaryEntries>

                            </dictionaries:Dictionary>

                            <dictionaries:Dictionary>

                                <dictionaries:Owner>ACTOR2</dictionaries:Owner>

                                <dictionaries:Name>LPServiceTypes</dictionaries:Name>

                                <dictionaries:DictionaryEntries>

                                    <dictionaries:DictionaryEntry>

                                        <dictionaries:Value>ServiceA</dictionaries:Value>

                                        <dictionaries:Meaning>Service A allows users to ...</dictionaries:Meaning>

                                    </dictionaries:DictionaryEntry>

                                    <dictionaries:DictionaryEntry>

                                        <dictionaries:Value>ServiceB</dictionaries:Value>

                                        <dictionaries:Meaning>Service B allows users to ...</dictionaries:Meaning>

                                    </dictionaries:DictionaryEntry>

                                </dictionaries:DictionaryEntries>

                            </dictionaries:Dictionary>

                        </Dictionaries>

                        <!-- ACTOR2 defines a new type of target identifier. -->

                        <TargetFormatTypeDefinitions>

                            <config:FormatOwner>ACTOR02</config:FormatOwner>

                            <config:TargetFormatTypeDefinitionEntries>

                                <config:TargetFormatTypeDefinitionEntry>

                                    <config:FormatName>ProprietaryIdentifier</config:FormatName>

                                    <config:Description>This is an illustration of a proprietary identifier type specific to this CSP, which consists of the string "CSP" followed by 10 digits</config:Description>

                                    <config:FormatRegex>^CSP[0-9]{10}$</config:FormatRegex>

                                </config:TargetFormatTypeDefinitionEntry>

                            </config:TargetFormatTypeDefinitionEntries>

                        </TargetFormatTypeDefinitions>

                        <!-- ACTOR2 defines the possible targeting configuration acceptable. -->

                        <TargetingConfigurations>

                            <config:TargetingConfiguration>

                                <!-- First Targeting Configuration -->

                                <config:FormatName>PropietaryIdentifier</config:FormatName>

                                <config:FormatOwner>ACTOR02</config:FormatOwner>

                                <config:Guidance>This targeting configuration defines that the service provider accepts lawful disclosure and lawful preservation requests for the propietary identifier format type described in the TargetFormatTypeDefinitions, associated with Service A for the "Subscriber Data" category only</config:Guidance>

                                <config:AssociatedLIServiceTypes/> <!-- In this example, no LI types are supported -->

                                <config:AssociatedLDTypes>

                                    <common:DictionaryEntry>

                                        <common:Owner>ETSI</common:Owner>

                                        <common:Name>RequestType</common:Name>

                                        <common:Value>SubscriberData</common:Value>

                                    </common:DictionaryEntry>

                                </config:AssociatedLDTypes>

                                <config:AssociatedLDSubtypes>

                                    <common:DictionaryEntry>

                                        <common:Owner>ACTOR02</common:Owner>

                                        <common:Name>LDRequestSubtype</common:Name>

                                        <common:Value>ServiceA</common:Value>

                                    </common:DictionaryEntry>

                                </config:AssociatedLDSubtypes>

                                <config:AssociatedLPTypes>

                                    <common:DictionaryEntry>

                                        <common:Owner>ETSI</common:Owner>

                                        <common:Name>RequestType</common:Name>

                                        <common:Value>SubscriberData</common:Value>

                                    </common:DictionaryEntry>

                                </config:AssociatedLPTypes>

                                <config:AssociatedLPRequestSubtypes>

                                    <common:DictionaryEntry>

                                        <common:Owner>ACTOR02</common:Owner>

                                        <common:Name>LPServiceTypes</common:Name>

                                        <common:Value>ServiceA</common:Value>

                                    </common:DictionaryEntry>

                                </config:AssociatedLPRequestSubtypes>

                            </config:TargetingConfiguration>

                            <!-- Second Targeting Configuration -->

                            <config:TargetingConfiguration>

                                <config:FormatName>InternationalE164</config:FormatName>

                                <config:FormatOwner>ETSI</config:FormatOwner>

                                <config:Guidance>This targeting configuration defines that the service provider accepts lawful disclosure and lawful preservation requests for a telephone number (as ETSI standard format E164 number) associated with Service A and Service B for the "Traffic Data" and "Content Data" categories</config:Guidance>

                                <config:AssociatedLIServiceTypes/> <!-- In this example, no LI types are supported -->

                                <config:AssociatedLDTypes>

                                    <common:DictionaryEntry>

                                        <common:Owner>ETSI</common:Owner>

                                        <common:Name>RequestType</common:Name>

                                        <common:Value>TrafficData</common:Value>

                                    </common:DictionaryEntry>

                                    <common:DictionaryEntry>

                                        <common:Owner>ETSI</common:Owner>

                                        <common:Name>RequestType</common:Name>

                                        <common:Value>StoredContentData</common:Value>

                                    </common:DictionaryEntry>

                                </config:AssociatedLDTypes>

                                <config:AssociatedLDSubtypes>

                                    <common:DictionaryEntry>

                                        <common:Owner>ACTOR02</common:Owner>

                                        <common:Name>LDRequestSubtype</common:Name>

                                        <common:Value>ServiceA</common:Value>

                                    </common:DictionaryEntry>

                                    <common:DictionaryEntry>

                                        <common:Owner>ACTOR02</common:Owner>

                                        <common:Name>LDRequestSubtype</common:Name>

                                        <common:Value>ServiceB</common:Value>

                                    </common:DictionaryEntry>

                                </config:AssociatedLDSubtypes>

                                <config:AssociatedLPTypes>

                                    <common:DictionaryEntry>

                                        <common:Owner>ETSI</common:Owner>

                                        <common:Name>RequestType</common:Name>

                                        <common:Value>TrafficData</common:Value>

                                    </common:DictionaryEntry>

                                    <common:DictionaryEntry>

                                        <common:Owner>ETSI</common:Owner>

                                        <common:Name>RequestType</common:Name>

                                        <common:Value>StoredContentData</common:Value>

                                    </common:DictionaryEntry>

                                </config:AssociatedLPTypes>

                                <config:AssociatedLPSubtypes>

                                    <common:DictionaryEntry>

                                        <common:Owner>ACTOR02</common:Owner>

                                        <common:Name>LPServiceTypes</common:Name>

                                        <common:Value>ServiceA</common:Value>

                                    </common:DictionaryEntry>

                                    <common:DictionaryEntry>

                                        <common:Owner>ACTOR02</common:Owner>

                                        <common:Name>LPServiceTypes</common:Name>

                                        <common:Value>ServiceB</common:Value>

                                    </common:DictionaryEntry>

                                </config:AssociatedLPSubtypes>

                            </config:TargetingConfiguration>

                        </TargetingConfigurations>

                        <SupportedLPWorkflowEndpoints>

                            <config:SupportedLPWorkflowEndpoint>

                                <config:LPWorkflowEndpoint>

                                    <common:Owner>ETSI</common:Owner>

                                    <common:Name>LPWorkflowEndpoint</common:Name>

                                    <common:Value>NewAuthorisation</common:Value>

                                </config:LPWorkflowEndpoint>

                                <config:Guidance>This tells the LEA what endpoint to use for new warrants. For brevity, in this example, this is the only endpoint specified.</config:Guidance>

                                <config:URL>https://ts103120.example.com/lp/authorisation/new</config:URL>

                            </config:SupportedLPWorkflowEndpoint>

                        </SupportedLPWorkflowEndpoints>

                        <SupportedLIWorkflowEndpoints/>

                    </GETCSPCONFIGResponse>

                </ActionResponse>

            </ActionResponses>

        </ResponsePayload>

    </Payload>

</HI1Message>
 
 No newline at end of file