kivaprotocol/bioauth

Guardian Bio Auth

镜像概述

guardian-bio-auth 是一套用于生物识别指纹认证的服务和工具集合，专为与 aries-key-guardian 配合使用而设计。该项目主要提供指纹图像质量分析、指纹模板生成、存储与匹配验证等核心能力，并包含相关的数据库初始化脚本和桌面命令行工具。

核心功能与特性

1. 生物分析服务 (Bioanalyzer Service)

• 图像质量评估：对生物识别图像（目前主要支持指纹）进行通用分析。
• 标准化评分：根据 ISO/IEC 29794-1:2016 标准，评估图像质量并返回 0 到 100 的质量评分。
• Docker 镜像：kivaprotocol/bioanalyzer

2. 生物认证/身份服务 (Bio Auth / Identity Service)

• 模板生成与存储：接收指纹图像并生成指纹模板，存储于 identity_template_db 数据库中。
• 多格式支持与转换：支持 ANSI-378、ISO-***-2 或 SourceAFIS v3 格式的模板，并统一转换为 SourceAFIS v3 格式进行存储。
• 指纹匹配验证：接收候选指纹模板，与已存储的模板进行比对，验证是否匹配。
• Docker 镜像：kivaprotocol/identity

3. 指纹桌面工具 (Fingerprint Desktop Tool)

• 提供命令行接口 (CLI)，允许用户根据输入的指纹图像在本地生成指纹模板。

使用场景和适用范围

• 去中心化身份验证：与 aries-key-guardian 结合，为去中心化身份 (DID) 和可验证凭证 (VC) 提供生物识别安全恢复和验证机制。
• 高安全级别访问控制：需要基于指纹生物特征进行用户身份核验的系统。
• 指纹数据标准化处理：需要将不同标准（ANSI、ISO）的指纹模板统一转换为 SourceAFIS v3 格式的场景。

详细的使用方法和配置说明

环境变量配置

在运行服务前，需要为各个子项目配置 .env 文件。您可以运行项目提供的脚本生成默认配置，或参考各子项目中的 dummy.env 文件手动创建自定义配置。

bash
# 使用默认的 dummy 环境变量
./scripts/useDummyEnvFiles.sh

Docker Compose 部署 (本地开发推荐)

项目提供了 docker-compose 配置，用于快速拉起服务及其依赖的数据库（identity_intelligence_db 和 identity_template_db）。

1. 确保已安装 docker-compose。
2. 构建服务（如果在本地修改了代码）：

   bash
   cd identity_service && ./gradlew build
   cd ../bioanalyzer_service && ./gradlew build
   

3. 启动服务网络：

   bash
   docker-compose up
   

独立 Docker 镜像部署 (生产环境)

官方在 Docker Hub 上提供了预构建的公开镜像，您可以直接拉取并集成到自己的部署环境中：

拉取镜像：

bash
docker pull kivaprotocol/bioanalyzer
docker pull kivaprotocol/identity

运行 Bioanalyzer Service 示例：

bash
docker run -d \
  --name bioanalyzer \
  -p 8080:8080 \
  --env-file ./bioanalyzer_service/.env \
  kivaprotocol/bioanalyzer

运行 Identity Service 示例：

bash
docker run -d \
  --name identity \
  -p 8081:8081 \
  --env-file ./identity_service/.env \
  --link postgres:postgres \
  kivaprotocol/identity

注：Identity Service 需要连接到 PostgreSQL 数据库，请确保在 .env 文件中配置了正确的数据库连接参数。

运行测试

项目使用 Gradle 进行构建和测试。确保本地已安装 Gradle（macOS 可通过 brew install gradle 安装），然后执行以下命令运行单元测试：

bash
# 测试 Identity Service
cd identity_service
./gradlew test

# 测试 Bioanalyzer Service
cd ../bioanalyzer_service
./gradlew test