Skip to content

Latest commit

 

History

History
128 lines (92 loc) · 7.6 KB

README.md

File metadata and controls

128 lines (92 loc) · 7.6 KB
Raw

Consumer Data Right Logo

Consumer Data Standards v1.31.0 made-with-dotnet made-with-csharp MIT License Pull Requests Welcome

Consumer Data Right - Mock Data Recipient

This project includes source code, documentation and instructions for a Consumer Data Right (CDR) Mock Data Recipient.

This repository contains a mock implementation of a Data Recipient and is offered to help the community in the development and testing of their CDR solutions.

Mock Data Recipient - Alignment

The Mock Data Recipient in this release:

Getting Started

The Mock Data Recipient uses the Mock Register and the Banking and Energy Mock Data Holders. You can swap out any of the Mock Data Holders, Mock Data Register and Mock Data Recipient solutions with a solution of your own.

There are a number of ways that the artefacts within this project can be used:

  1. Build and deploy the source code
  2. Use the pre-built image
  3. Use the docker compose file to run a multi-container mock CDR Ecosystem

Build and deploy the source code

To get started, clone the source code.

git clone https://github.com/ConsumerDataRight/mock-data-recipient.git

Set your debug profile to CDR.DataRecipient.Web

To get help on launching and debugging the solution, see the help guide.

If you would like to contribute features or fixes back to the Mock Data Recipient repository, consult the contributing guidelines.

Use the pre-built image

A version of the Mock Data Recipient is built into a single Docker image that is made available via docker hub.

Pull the latest image

docker pull consumerdataright/mock-data-recipient

To get help on launching and debugging the solutions as containers and switching out your solution(s), see the help guide.

Certificate Management

Consult the Certificate Management documentation for more information about how certificates are used for the Mock Data Recipient.

Use the docker compose file to run a multi-container mock CDR Ecosystem

The docker compose file can be used to run multiple containers from the Mock CDR Ecosystem.

Note: the docker compose file utilises the Microsoft SQL Server Image from Docker Hub. The Microsoft EULA for the Microsoft SQL Server Image must be accepted to use the docker compose file. See the Microsoft SQL Server Image on Docker Hub for more information.

To get help on launching and debugging the solutions as containers and switching out your solution(s), see the help guide.

Mock Data Recipient - Architecture

The following diagram outlines the high level architecture of the Mock Data Recipient:

Mock Data Recipient - Architecture

Dynamic Client Registration Interface:

Dynamic Client Registration Interface

Mock Data Recipient - Components

The Mock Data Recipient contains the following components:

  • Website & API
    • Hosted at https://localhost:9001
    • Contains the user interface for testing a variety of interactions with participants, including:
      • Get Data Holder Brands
      • Get SSA
      • Dynamic Client Registration
      • Consumer Data Sharing
      • OIDC Authentication can be enabled in appsettings by including the issuer details.
      • Pushed Authorisation Request (PAR). Supports FAPI 1.0 Migration Phase 3
    • Also contains the JWKS and CDR Arrangement Revocation endpoints.
  • SDK
    • Used internally within the Mock Data Recipient to simplify interactions with the Register and Data Holders.
  • Azure Functions
    • Azure Functions that can automate the continuous Get Data Holders discovery and Dynamic Client Registration process.
    • For each Data Holder retrieved from the Register, a message will be added to the DynamicClientRegistration queue. A function listening to the queue, will pick up the message and attempt to register the Data Recipient with the Data Holder.
    • To get help on the Azure Functions, see the help guide.
  • Repository
    • A SQL repository is included that contains local data used within the Mock Data Recipient.
    • Includes the following collections:
      • data-holder-brands - populated when a response is received from the Register's Get Data Holder Brands API.
      • client-registrations - populated when a response is received from a successful DCR request to a Data Holder.
      • cdr-arrangements - populated after a successful consent and authorisation flow with a Data Holder.

Technology Stack

The following technologies have been used to build the Mock Data Recipient:

  • The source code has been written in C# using the .Net 8 framework.
  • The Repository utilises a SQL instance.

Testing

The Mock Data Recipient has been built as a test harness to demonstrate the interactions between the Register and Data Holders. The Mock Data Recipient allows the end user to test the various interactions by changing input values, executing and viewing the response. The Mock Data Recipient requires a Mock Register and a Banking and Energy Mock Data Holder to completely mimic the CDR Ecosystem. You can swap out any of the Mock Data Holders, Mock Data Register and Mock Data Recipient solutions with a solution of your own.

Consents and Authorisation flow of FAPI 1.0 Migration Phase 1 is no longer supported. Use the Pushed Authorisation Request (PAR) flow when testing against data holders that have implemented FAPI 1.0 Migration Phase 2 or Phase 3.

Contribute

We encourage contributions from the community. See our contributing guidelines.

Code of Conduct

This project has adopted the Contributor Covenant. For more information see the code of conduct.

Security Policy

See our security policy for information on security controls, reporting a vulnerability and supported versions.

License

MIT License

Notes

The Mock Data Recipient is provided as a development tool only. It conforms to the Consumer Data Standards.