pgsodium 项目使用教程

pgsodium 项目使用教程

pgsodium Modern cryptography for PostgreSQL using libsodium. 项目地址: https://gitcode.com/gh_mirrors/pg/pgsodium

1. 项目的目录结构及介绍

pgsodium 项目是一个为 PostgreSQL 提供加密库扩展的开源项目，使用 libsodium 库实现高级加密算法。以下是项目的目录结构及其介绍：

• ./sql：包含用于 PostgreSQL 的 SQL 文件，包括安装扩展和定义函数的 SQL 脚本。
• ./src：源代码目录，包含 C 语言编写的扩展源文件。
• ./test：测试目录，包含用于测试扩展功能的测试脚本。
• ./getkey_scripts：包含用于获取密钥的脚本示例，适用于不同的密钥管理系统。
• ./docgen.py 和 ./doctestify.py：用于生成文档和测试的 Python 脚本。
• ./Dockerfile 和 ./Dockerfile-debug：用于构建 Docker 容器的 Dockerfile 文件。
• ./LICENSE：项目使用的许可证文件。
• ./Makefile：构建项目所需的 Makefile 文件。
• ./README.md：项目的自述文件，包含项目描述和基本使用说明。
• 其他文件：包括构建和运行项目所需的配置文件和辅助脚本。

2. 项目的启动文件介绍

pgsodium 项目的启动主要是通过编译安装扩展。以下是一些关键的启动文件：

• ./Makefile：这是构建 pgsodium 扩展的主要文件。使用 make 命令时，它会读取此文件来确定编译和安装的步骤。
• ./sql/pgsodium.sql：这个 SQL 脚本用于在 PostgreSQL 数据库中安装 pgsodium 扩展。它定义了所有的函数和类型。
• ./test/test.sql：用于测试 pgsodium 功能的 SQL 脚本。在开发过程中，可以通过运行这个脚本来验证扩展的功能。

要启动和安装扩展，你需要在 PostgreSQL 开发环境中运行以下命令：

make && sudo make install

然后，在你的 PostgreSQL 数据库中运行以下 SQL 命令来创建扩展：

CREATE EXTENSION pgsodium;

3. 项目的配置文件介绍

pgsodium 项目的配置主要通过修改 PostgreSQL 的配置文件来实现。以下是一些主要的配置步骤：

• shared_preload_libraries：在 PostgreSQL 的 postgresql.conf 文件中设置此参数，以便在服务器启动时加载 pgsodium 库。

  shared_preload_libraries = 'pgsodium'
  

• pgsodium.getkey_script：这是一个数据库配置变量，用于指定获取密钥的脚本的路径。你可以在 postgresql.conf 文件中或通过 ALTER SYSTEM 命令设置它。

  pgsodium.getkey_script = '/path/to/your/getkey_script.sh'
  

确保在修改配置文件后重启 PostgreSQL 服务以使更改生效。此外，根据你的安全要求，你可能还需要调整其他相关的 PostgreSQL 配置。

pgsodium Modern cryptography for PostgreSQL using libsodium. 项目地址: https://gitcode.com/gh_mirrors/pg/pgsodium