Masquerade 项目使用教程

Masquerade 项目使用教程

masquerade A Postgres Proxy to Mask Data in Realtime 项目地址: https://gitcode.com/gh_mirrors/mas/masquerade

1. 项目介绍

Masquerade 是一个用于实时数据掩码的 Postgres 代理。它通过在客户端和数据库之间插入一个代理层，拦截并修改从数据库发送到客户端的数据，从而实现敏感数据的掩码。Masquerade 由 TonicAI 开发，支持 Docker 和 dotnet core 运行时。

2. 项目快速启动

2.1 环境准备

确保你已经安装了以下工具：

• Docker 和 docker-compose
• dotnet core runtime (v2+)

2.2 启动 Postgres 数据库

首先，启动一个包含示例数据集的 Postgres 数据库：

docker-compose up -d

这将在本地端口 15432 启动一个 Postgres 数据库。

2.3 运行 Masquerade 代理

导航到项目根目录并运行代理：

dotnet run

默认情况下，代理将在 127.0.0.1:20000 上监听客户端连接。

2.4 连接到代理

使用 Postgres 客户端连接到代理，而不是直接连接到数据库。例如，使用 psql 连接：

psql "host=localhost port=20000 dbname=test_data user=your_user password=your_password"

3. 应用案例和最佳实践

3.1 数据掩码

Masquerade 提供了多种数据掩码功能，可以应用于不同的数据类型和列。例如，你可以配置 config.json 文件来指定如何掩码特定列或数据类型。

{
  "masking_options": {
    "preserve_keys": false,
    "data_type_masks": [
      {
        "data_type": "text",
        "masking_function": "character_substitution"
      }
    ],
    "column_masks": [
      {
        "column": "first_name",
        "table": "example",
        "schema": "public",
        "masking_function": "maskx"
      }
    ]
  }
}

3.2 自定义掩码函数

你可以通过在 TonicPgProxy.Maskers 命名空间中创建自定义函数来实现更复杂的掩码逻辑。例如：

static public string MaskX(string value) {
  return new string('x', value.Length);
}

4. 典型生态项目

4.1 TonicAI 的其他项目

TonicAI 还开发了其他与数据安全和隐私相关的项目，如数据脱敏工具和数据匿名化工具。这些工具可以与 Masquerade 结合使用，提供更全面的数据保护解决方案。

4.2 开源社区项目

在开源社区中，有许多与 Postgres 相关的项目，如 pgAdmin、Postico 和 Datagrip。这些工具可以与 Masquerade 集成，提供更强大的数据库管理和监控功能。

---

通过以上步骤，你可以快速启动并使用 Masquerade 项目，实现对敏感数据的实时掩码。

masquerade A Postgres Proxy to Mask Data in Realtime 项目地址: https://gitcode.com/gh_mirrors/mas/masquerade