consumerdataright/mock-data-holder

Consumer Data Right - 模拟数据持有者

概述和主要用途

本项目包含Consumer Data Right (CDR)模拟数据持有者的源代码、文档和使用说明。此仓库提供了数据持有者的模拟实现，旨在帮助社区开发和测试其CDR解决方案。模拟数据持有者解决方案可配置为银行或能源行业使用。

模拟数据持有者 - 标准对齐

模拟数据持有者：

• 符合https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.34.0/#introduction的https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.34.0/#introduction，特别是https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.34.0/#introduction，并向后兼容迁移阶段2；
• 通过了https://www.cdr.gov.au/for-providers/conformance-test-suite-data-holders的v5.2.0版本测试；
• 符合FAPI 1.0高级配置文件。

快速开始

模拟数据持有者使用https://github.com/ConsumerDataRight/authorisation-server、https://github.com/ConsumerDataRight/mock-register和https://github.com/ConsumerDataRight/mock-data-recipient。您可以将模拟数据持有者、模拟注册中心和模拟数据接收者解决方案中的任何一个替换为您自己的解决方案。

本项目中的工件有多种使用方式：

1. 构建和部署源代码
2. 使用预构建镜像
3. 使用docker compose文件运行多容器模拟CDR生态系统

构建和部署源代码

要开始，请克隆源代码。

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

从1.2.0版本开始，模拟数据持有者现在使用https://github.com/ConsumerDataRight/authorisation-server作为身份提供商。运行模拟数据持有者时，https://github.com/ConsumerDataRight/authorisation-server也需要运行。可以使用以下命令克隆https://github.com/ConsumerDataRight/authorisation-server仓库：

git clone https://github.com/ConsumerDataRight/authorisation-server.git ./cdr-auth-server

有关设置行业配置文件、启动和调试解决方案的帮助，请参阅https://github.com/ConsumerDataRight/mock-data-holder/blob/main/./Help/debugging/HELP.md。

如果您想向模拟数据持有者仓库贡献功能或修复，请查阅https://github.com/ConsumerDataRight/mock-data-holder/blob/main/./CONTRIBUTING.md。

使用预构建的银行或能源镜像

Docker镜像在https://hub.docker.com/r/consumerdataright上提供，包括https://hub.docker.com/r/consumerdataright/mock-data-holder和https://hub.docker.com/r/consumerdataright/mock-data-holder-energy模拟数据持有者。

注意：从1.2.0版本开始，身份服务器已替换为https://github.com/ConsumerDataRight/authorisation-server。尽管https://github.com/ConsumerDataRight/authorisation-server作为单独的仓库存在，但当为Docker构建mock-data-holder银行或能源镜像时，授权服务器会被复制到镜像中，替换Identity Server 4。

从Docker拉取最新的银行或能源镜像

运行以下命令从Docker Hub拉取最新的银行模拟数据持有者镜像：

docker pull docker.xuanyuan.run/consumerdataright/mock-data-holder:latest

运行以下命令从Docker Hub拉取最新的能源模拟数据持有者镜像：

docker pull docker.xuanyuan.run/consumerdataright/mock-data-holder-energy:latest

有关将行业设置为银行或能源、将解决方案作为容器启动和调试以及替换您自己的解决方案的帮助，请参阅https://github.com/ConsumerDataRight/mock-data-holder/blob/main/./Help/container/HELP.md。

试用

可以通过访问以下地址查看模拟数据持有者的OpenID Connect发现文档：

银行模拟数据持有者
https://localhost:8001/.well-known/openid-configuration

能源模拟数据持有者
https://localhost:8101/.well-known/openid-configuration

https://github.com/ConsumerDataRight/mock-data-recipient已构建为测试工具，用于演示注册中心和模拟数据持有者之间的交互。模拟数据接收者可用于执行动态客户端注册、创建同意安排和探索模拟数据持有者API。提供的https://github.com/ConsumerDataRight/mock-data-holder/blob/main/./Help/container/HELP.md将协助在Docker中设置模拟CDR生态系统。

证书管理

有关证书如何用于模拟数据持有者的更多信息，请查阅https://github.com/ConsumerDataRight/mock-data-holder/blob/main/./CertificateManagement/README.md文档。

加载您自己的银行或能源种子数据

当模拟数据持有者容器首次启动时，它将从CDR.DataHolder.Manage.API项目中包含的seed-data-{industry}.json文件加载数据。使用银行配置文件运行模拟数据持有者将从seed-data-banking.json文件加载数据；使用能源配置文件运行将从seed-data-energy.json文件加载数据。这些文件包含虚拟银行和能源数据（客户、账户、银行交易、能源优惠）以及可从注册中心获取的数据接收者元数据。当调用资源API时，将返回虚拟银行或能源数据。

有几种方法可以将您自己的数据加载到容器实例中：

1. 在模拟数据持有者容器中提供您自己的seed-data.json文件

• 在容器的/app/manage/Data文件夹中，复制seed-data-{industry}.json文件，重命名为您选择的名称，例如my-seed-data.json。
• 使用您所需的元数据更新种子数据文件。
• 更改/app/manage/appsettings.json文件以加载新的数据文件并覆盖现有数据：

"SeedData": {
    "FilePath": "Data/my-seed-data.json",
    "OverwriteExistingData": true
},

• 重启容器。

2. 使用管理API端点加载数据

模拟数据持有者包含管理元数据API，允许将元数据重新加载到仓库中。

要使用元数据重新加载仓库，请向管理API发出以下请求：

注意：调用此API将删除所有现有元数据并重新加载提供的元数据

银行模拟数据持有者
POST https://localhost:8005/manage/metadata

{
    <JSON元数据 - 与GET /manage/metadata响应或seed-data.json文件格式相同>
}

能源模拟数据持有者
POST https://localhost:8105/manage/metadata

{
    <JSON元数据 - 与GET /manage/metadata响应或seed-data.json文件格式相同>
}

注意：目前管理API端点未应用任何身份验证/授权，因为这些被视为容器所有者可控。如果社区有相关反馈或提交拉取请求，可能会添加此功能。

使用docker compose文件运行多容器模拟CDR生态系统

https://github.com/ConsumerDataRight/mock-data-holder/blob/main/./Source/DockerCompose/docker-compose.yml可用于运行模拟CDR生态系统中的多个容器。

注意：https://github.com/ConsumerDataRight/mock-data-holder/blob/main/./Source/DockerCompose/docker-compose.yml使用Docker Hub上的Microsoft SQL Server镜像。使用https://github.com/ConsumerDataRight/mock-data-holder/blob/main/./Source/DockerCompose/docker-compose.yml必须接受Microsoft SQL Server镜像的Microsoft EULA。有关更多信息，请参见Docker Hub上的Microsoft SQL Server镜像。

有关将解决方案作为容器启动和调试以及替换您自己的解决方案的帮助，请参阅https://github.com/ConsumerDataRight/mock-data-holder/blob/main/./Help/container/HELP.md。

模拟数据持有者 - 要求

根据https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.34.0/#introduction，数据持有者在https://www.cdr.gov.au/中运营需要以下核心功能：

• 用于https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.34.0/#security-profile的身份提供商，符合OAuth和FAPI 1.0高级配置文件。
• https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.34.0/#dcr-apis，允许客户端注册其软件产品。
• 使用https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.34.0/#register-apis更新数据接收者和软件产品元数据。
• 行业特定数据（以下之一）
  • https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.34.0/#banking-apis
  • https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.34.0/#energy-apis
• 行业无关数据
  • https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.34.0/#common-apis
• https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.34.0/#admin-apis

模拟数据持有者与https://github.com/ConsumerDataRight/authorisation-server结合，为银行和能源行业提供所有这些功能。下图显示了在集成开发环境中打开时的模拟数据持有者和授权服务器。

通过启动给定行业所需的项目并使用行业特定数据和端口，可以在银行和能源之间切换。下图显示了根据行业配置文件启动的项目，还说明了哪些数据持有者功能在行业间共享。

模拟数据持有者 - 架构

以下部分概述了模拟数据持有者的高层架构和组件：

银行配置文件的模拟数据持有者

银行配置文件的模拟数据持有者 - 组件

模拟数据持有者包含以下组件：

• 公共API
  • 托管于https://localhost:8000
  • 包含公共发现API - Get Status和Get Outages
  • 直接通过端口8000访问
• 身份提供商
  • 托管于https://localhost:8001
  • 模拟数据持有者身份提供商实现，使用作为单独仓库托管的https://github.com/ConsumerDataRight/authorisation-server
  • 根据目标端点，可直接（仅TLS）或通过mTLS网关访问
• mTLS网关
  • 托管于https://localhost:8002
  • 提供mTLS通信的基础URL端点，包括信息安全、资源和管理API
  • 执行证书验证
• 资源API
  • Get Accounts和Get Transactions端点托管于https://localhost:8003
  • Get Customer端点托管于https://localhost:8006
  • 通过mTLS网关访问
• 管理API
  • 托管于https://localhost:8005
  • 不属于消费者数据标准，但允许维护模拟数据持有者仓库中的数据
  • 还包括从模拟注册中心刷新数据接收者、数据接收者状态和软件产品状态的触发点
  • 未来可能会添加用户界面，以提供对仓库数据的用户友好访问
• 仓库
  • 包含模拟数据持有者数据的SQL数据库

能源配置文件的模拟数据持有者

能源配置文件的模拟数据持有者 - 组件

模拟数据持有者包含以下组件：

• 公共API
  • 托管于https://localhost:8100
  • 包含公共发现API - Get Status和Get Outages
  • 直接通过端口8100访问
• 身份提供商
  • 托管于https://localhost:8101
  • 模拟数据持有者身份提供商实现，使用作为单独仓库托管的https://github.com/ConsumerDataRight/authorisation-server
  • 根据目标端点，可直接（仅TLS）或通过mTLS网关访问
• mTLS网关
  • 托管于https://localhost:8102
  • 提供mTLS通信的基础URL端点，包括信息安全、资源和管理API
  • 执行证书验证
• 资源API
  • Get Accounts和Get Concessions端点托管于https://localhost:8103
  • Get Customer端点托管于https://localhost:8106
  • 通过mTLS网关访问
• 管理API
  • 托管于https://localhost:8105
  • 不属于消费者数据标准，但允许维护模拟数据持有者仓库中的数据
  • 还包括从模拟注册中心刷新数据接收者、数据接收者状态和软件产品状态的触发点
  • 未来可能会添加用户界面，以提供对仓库数据的用户友好访问
• 仓库
  • 包含模拟数据持有者数据的SQL数据库

技术栈

构建模拟数据持有者使用了以下技术：

• 源代码使用C#编写，基于.Net 8框架
• 身份提供商使用https://github.com/ConsumerDataRight/authorisation-server实现
• mTLS网关使用Ocelot实现
• 仓库使用SQL实例
• xUnit是用于编写和运行测试的框架
• Microsoft Playwright是用于Web测试的框架

测试

本解决方案包含自动化集成测试。有关更多信息，请参见https://github.com/ConsumerDataRight/mock-data-holder/blob/main/./Help/testing/HELP.md文档。

贡献

我们鼓励社区贡献。请参见我们的[贡献指南](https://github.com/ConsumerDataRight/mock-data-holder/blob/main/./CONTRIBUTING.md