Kodex (社区版 - CE) 是一个面向隐私与安全工程的开源工具包。它帮助你在数据工程工作流中自动化数据安全与数据保护措施。它提供以下功能：

• 从文件、数据库或消息队列等各类来源读取数据项。
• 使用多种隐私与安全增强变换（如去标识化、掩码、假名化、匿名化或加密）保护这些数据项。
• 将保护后的数据项发送到各类目标。

借助 Kodex，你可以用简单的声明式配置语言描述你的数据保护与数据安全工作流：正如 DevOps 工具让你将基础设施描述为代码，Kodex 是一个 PrivacyOps 和 SecurityOps 工具，让你将隐私与安全措施描述为代码。

Kodex 处理隐私方面枯燥且困难的部分，例如

• 密钥管理：Kodex 为你管理加密和假名化密钥（如果你希望如此）。
• 参数管理：Kodex 追踪每个数据项的处理方式，以便你证明数据工作流的合规性并创建审计追踪。
• 数据变换：Kodex 实现现代密码学与统计技术来保护你的数据。

开始使用

要从源码下载并安装 Kodex，只需运行

git clone https://github.com/kiprotect/kodex
cd kiprotect

make
make install

文档

你可以在 https://heykodex.com/docs 找到官方文档。

变换数据

Kodex 从所谓的蓝图(blueprints)中读取配置。要了解其工作原理，请查看我们的 蓝图仓库，其中包含示例蓝图及运行说明。你可以通过 Kodex 安装这些蓝图（需要网络连接）：

kodex blueprints download

或者，你可以手动将它们复制到你的机器上，详情请参考 文档。然后运行假名化示例，只需输入

# 对示例数据进行假名化，并将结果写入文件 'pseudonymized.json'
kodex run pseudonymization/examples/data-types/pseudonymize

# 再次去假名化，并将结果输出到标准输出
kodex run pseudonymization/examples/data-types/depseudonymize

就是这样！Kodex 负责生成和存储假名化的加密参数。如果你想手动输入密钥来生成参数，也可以这样做：

# 使用用户提供的密钥对数据进行假名化
kodex run pseudonymization/examples/data-types/pseudonymize-with-key

# 也使用密钥进行去假名化
kodex run pseudonymization/examples/data-types/depseudonymize-with-key

运行测试

Kodex 附带一套自动化单元测试，你可以通过 Make 运行：

make test

测试插件

插件测试可能会失败并显示错误消息 "plugin was built with a different version of package internal/cpu"，这通常发生在编译主代码和插件时使用的编译标志不同。例如，如果你执行了竞态条件检测测试。要解决此问题，请进入插件文件夹并运行

make clean
make

运行基准测试

Kodex 还附带了一些基准测试，你可以按如下方式运行：

make bench

状态与路线图

这仍然是 Kodex 的早期版本，尚未包含许多功能。我们将逐步从企业版（EE）移植更多功能。以下是我们计划的下一个功能列表：

• 匿名化：使用差分隐私聚合对流式数据进行匿名化。
• 发现：在结构化与非结构化数据中发现敏感和个人信息。
• 加密：加密和解密结构化数据。
• 数据映射：分析并映射你的数据基础设施。
• 同意管理：管理所有数据流的处理目的和用户同意。

企业版

我们的开源工作得益于商业化的 Kodex 企业版（EE），它扩展了社区版（CE），增加了支持 Kodex 在专业企业环境中部署的功能。其中包括以下功能：

• 基于 SQL 的高级配置与参数管理和存储。
• 用于控制所有 Kodex 功能的 REST API。
• 用于管理和监控数据流的 Web 界面。
• 更高级的数据变换。
• 基于角色的访问控制机制。

你有兴趣了解更多关于 Kodex EE 的信息吗？请访问 我们的网站 或 联系我们！

许可证

Kodex 目前根据 Affero GPL 许可证第 3 版（AGPL-3.0）发布。详情请参见 许可证文件。此外，我们还提供商业许可证，允许你将 Kodex 代码直接集成到闭源软件中而无需公开你自己的代码。如果你有兴趣购买商业许可证，请与我们联系。

为什么选择 Affero GPL？

Affero GPL 许可证是一种强 copyleft 许可证，允许你自由地将 Kodex 用于商业和非商业目的。如果你将软件作为独立工具使用，而不将其与自己的软件代码集成（即，你不将其作为 Go 库导入并编译到自己的 Go 代码中），则其使用不会以任何方式影响你自己的软件代码。在这方面，Kodex 可以像其他 GPL 许可的 Linux 工具一样自由使用。

但是，如果你将 Kodex 代码与自己的软件代码集成，并以 Web 服务的形式分发或提供该软件，则你必须以兼容许可证提供你软件的源代码。同样，如果你修改或扩展 Kodex，并分发或将其作为服务提供，你也要公开你更改的源代码。这确保你对 Kodex 所做的改进将惠及整个用户社区。

我需要其他许可证

如果你因许可证条款而难以使用 Kodex-CE，请 与我们联系。我们提供商业许可证，让你将 Kodex 与自己的软件代码集成，而不受 AGPL 许可证条款的影响。

联系我们

你在运行 Kodex 时遇到问题了吗？你想建议新功能或报告 bug 吗？请在此问题跟踪器中创建议题。如果希望直接与我们讨论，请 发送电子邮件，我们期待您的来信！

传播消息

你在组织中使用 Kodex 并喜欢它吗？请让世界知道！传播信息并给我们反馈有助于我们改进软件。