perforce/helix-auth-svc

Helix认证服务 Docker镜像文档

镜像概述和主要用途

本镜像包含一个基于Node.js的应用程序，提供认证协议集成服务，可与Perforce产品配合使用。目前支持OpenID Connect和SAML 2.0认证协议。

标签说明

官方发布版本标签格式为YYYY.N，例如2019.1、2020.1或2020.2。补丁版本标签格式为三位点分隔数字，例如2020.1.1或2019.1.2。

相关文档

如需了解架构、支持的产品和身份提供商，以及当前版本的配置步骤，请参阅Helix认证服务管理员指南。

使用方法

以下是使用Docker运行认证服务的示例。最简单的方式是使用Docker CLI启动容器：

Docker CLI启动

shell
$ docker run -d --env-file .env -p 3000:3000 --name auth-svc perforce/helix-auth-svc

上述命令中引用的.env文件示例如下：

shell
SVC_BASE_URI=https://192.168.24.20:3000
PROTOCOL=https
DEFAULT_PROTOCOL=saml
SAML_IDP_METADATA_URL=https://dev-123456.okta.com/app/abc123xyz456/sso/saml/metadata
SAML_SP_ENTITY_ID=urn:example:sp

Docker Compose启动

若倾向使用Docker Compose，创建docker-compose.yml文件如下：

yaml
version: '3.7'
services:
  helix-auth-svc:
    image: perforce/helix-auth-svc:latest
    container_name: helix-auth-svc
    environment:
      SVC_BASE_URI: "https://192.168.24.20:3000"
      PROTOCOL: "https"
      DEFAULT_PROTOCOL: "saml"
      SAML_IDP_METADATA_URL: "https://dev-123456.okta.com/app/abc123xyz456/sso/saml/metadata"
      SAML_SP_ENTITY_ID: "urn:example:sp"
    ports:
      - "3000:3000"

使用以下命令启动容器：

shell
$ docker-compose up -d

核心功能和特性

• 支持OpenID Connect和SAML 2.0两种认证协议
• 可与Perforce产品集成，提供统一认证服务
• 通过环境变量灵活配置，适应不同部署场景
• 支持Docker和Docker Compose部署，易于集成到容器化环境

配置说明

环境变量配置

服务主要通过环境变量进行配置。启动容器时，可通过docker命令的-e、--env或--env-file选项，或在Docker Compose文件的environment部分设置环境变量。完整配置项列表请参阅官方文档。

容器定义了以下默认环境变量，可能影响其使用：

ENV CA_CERT_FILE certs/ca.crt
ENV DEBUG "yes"
ENV NODE_ENV development
ENV PORT 3000
ENV PROTOCOL http

注意，PROTOCOL默认值为http，会覆盖SVC_BASE_URI中的协议部分。若服务部署在执行TLS终止的反向代理后，此配置可行；否则需将PROTOCOL设置为https（如使用示例中所示）。

SSL证书

镜像包含一组自签名证书，生产环境部署时应替换。可通过卷挂载替换证书（例如使用docker命令的-v选项或Docker Compose的volumes设置），并定义证书相关环境变量（CA_CERT_PATH、IDP_CERT_FILE、CERT_FILE和KEY_FILE）指向这些文件。

Swarm支持

服务可配置为SAML 2.0身份提供商，供其他服务（包括Perforce Swarm）使用。需通过卷挂载包含配置文件的目录，并设置IDP_CONFIG_FILE环境变量指向该配置文件。配置文件示例可参考https://github.com/perforce/helix-authentication-service/blob/master/routes/saml_idp.conf.cjs%E3%80%82

如何获取帮助

配置认证服务和身份提供商是一项复杂任务，建议具备安全系统相关专业知识。如需配置协助，请联系Perforce支持。

许可信息

Helix认证服务的许可信息请查看https://github.com/perforce/helix-authentication-service/blob/master/LICENSE.txt%E3%80%82%E4%B8%8E%E6%89%80%E6%9C%89Docker%E9%95%9C%E5%83%8F%E4%B8%80%E6%A0%B7%EF%BC%8C%E6%9C%AC%E9%95%9C%E5%83%8F%E5%8F%AF%E8%83%BD%E5%8C%85%E5%90%AB%E5%85%B6%E4%BB%96%E8%BD%AF%E4%BB%B6%EF%BC%88%E5%A6%82%E5%9F%BA%E7%A1%80%E5%8F%91%E8%A1%8C%E7%89%88%E4%B8%AD%E7%9A%84Bash%E7%AD%89%EF%BC%89%EF%BC%8C%E8%BF%99%E4%BA%9B%E8%BD%AF%E4%BB%B6%E5%8F%AF%E8%83%BD%E5%85%B7%E6%9C%89%E7%8B%AC%E7%AB%8B%E8%AE%B8%E5%8F%AF%E3%80%82