PostgreSQL纯PL/pgSQL实现的时间基一次性密码(TOTP)教程

PostgreSQL纯PL/pgSQL实现的时间基一次性密码(TOTP)教程

totp RFC6238 TOTP implementation in pure PostgreSQL plpgsql 项目地址: https://gitcode.com/gh_mirrors/totp/totp

本教程将指导您了解并使用pyramation/totp这个GitHub上的开源项目，该项目实现了RFC6238定义的时间基一次性密码算法在PostgreSQL数据库中的纯PL/pgSQL版本。

1. 项目目录结构及介绍

该项目采用标准的Git仓库结构，关键目录与文件概述如下：

• / 根目录，包含整个项目的元数据和主要文件。

  • README.md: 项目的说明文件，详细介绍了TOTP实现的功能、使用方法以及开发指南。
  • LICENSE: 指定了MIT许可证，说明了软件的使用权限和限制。
  • packages/totp: 包含核心功能的代码逻辑，用于生成和验证TOTP码。
  • docker-compose.yml: Docker Compose配置文件，用于快速搭建测试环境。
  • `makefile**: 提供构建、安装和管理项目的命令集。

• bin, extensions, scripts 等：可能包含辅助脚本或工具，但在这个引用中没有特别提及，因此具体细节需依据实际仓库文件为准。

2. 项目的启动文件介绍

此项目不是传统的服务应用，无需直接“启动文件”来运行服务。然而，为了在PostgreSQL环境中使用它，您需执行以下步骤：

• 部署到PostgreSQL: 使用提供的makefile（尤其是make install命令）来安装存储过程到你的数据库中。
• Docker启动: 通过make up命令启动附带的Docker环境，这主要用于开发和测试目的。

3. 项目的配置文件介绍

• 无特定配置文件: 项目本身不直接提供一个外部的配置文件进行应用程序级的配置。所有配置和设置主要是通过SQL函数参数（如TOTP间隔时间和长度）以及环境变量（在使用Docker时）来进行调整。
• PostgreSQL相关配置: 虽然项目内部不需要配置文件，但部署到PostgreSQL时，可能会涉及到数据库的连接设置，这些通常在环境变量或者Docker Compose文件中指定，而非项目内。

如何使用项目

1. 安装: 在具备PostgreSQL环境的系统上，可以通过提供的Make命令部署到数据库中。

2. 生成TOTP码: 利用提供的SQL函数totp_generate，传入密钥等参数即可生成一个新的TOTP验证码。

3. 验证TOTP码: 使用totp_verify函数，输入密钥和用户提供的验证码来验证其有效性。

4. URL编码: 可以生成包含邮箱、密钥等信息的URL编码字符串，用于配置认证应用。

请注意，项目依赖于PostgreSQL的plpgsql语言，并且当前支持SHA1散列函数及20字节的密钥，未来可能扩展对更多算法和密钥大小的支持。

以上是关于pyramation/totp项目的基本框架、部署和使用的简要指南。开发者可以根据自己的需求，进一步探索源码和使用场景，利用其提供的功能加强数据库层面的身份验证安全。

totp RFC6238 TOTP implementation in pure PostgreSQL plpgsql 项目地址: https://gitcode.com/gh_mirrors/totp/totp