SAML Jackson：开源企业级单点登录和目录同步

<a href="https://bestpractices.coreinfrastructure.org/projects/7493"><img src="https://bestpractices.coreinfrastructure.org/projects/7493/badge" alt="OpenSSF 最佳实践徽章"></a> <a href="https://www.npmjs.com/package/@boxyhq/saml-jackson"><img src="https://img.shields.io/npm/dt/@boxyhq/saml-jackson" alt="NPM 下载量徽章" ></a> <a href="https://hub.docker.com/r/boxyhq/jackson"><img src="https://img.shields.io/docker/pulls/boxyhq/jackson" alt="Docker 拉取统计徽章"></a> <a href="https://github.com/boxyhq/jackson/blob/main/LICENSE"><img src="https://img.shields.io/github/license/boxyhq/jackson" alt="Apache 2.0 许可证徽章"></a> <a href="https://github.com/boxyhq/jackson/issues"><img src="https://img.shields.io/github/issues/boxyhq/jackson" alt="Github 未解决问题徽章"></a> <a href="https://github.com/boxyhq/jackson/stargazers"><img src="https://img.shields.io/github/stars/boxyhq/jackson" alt="Github 星标数"></a> <a href="https://www.npmjs.com/package/@boxyhq/saml-jackson"><img src="https://img.shields.io/node/v/@boxyhq/saml-jackson" alt="Node.js 版本支持徽章"></a> <a href="https://raw.githubusercontent.com/boxyhq/jackson/main/swagger/swagger.json"><img src="https://img.shields.io/swagger/valid/3.0?specUrl=https%3A%2F%2Fraw.githubusercontent.com%2Fboxyhq%2Fjackson%2Fmain%2Fswagger%2Fswagger.json" alt="Swagger 验证器徽章"></a>

SAML Jackson 将 SAML 登录流程桥接或代理到 OAuth 2.0 或 OpenID Connect，抽象出 SAML 协议的所有复杂性。它还通过 SCIM 2.0 协议支持目录同步，实现自动用户和群组配置/取消配置。

我们现在也支持 OpenID Connect 提供商。

目录同步

SAML Jackson 还基于 SCIM 2.0 协议支持目录同步。

目录同步帮助组织自动化用户配置和取消配置。因此，它通过节省宝贵的组织时间、创建用户身份数据的单一真实来源，并帮助保持数据安全，简化了用户生命周期管理过程。

完整文档请访问 boxyhq.com/docs/directory-sync/overview

🌟 为什么要为此仓库加星？

如果您觉得这个项目有帮助，请考虑通过为该仓库加星并与他人分享来支持我们。这有助于其他人发现该项目、发展社区并确保项目的长期健康。🙏

• SAML Jackson：开源企业级单点登录和目录同步
  • 目录同步
  • 🌟 为什么要为此仓库加星？
  • 🚀 SAML Jackson 入门
    • 尝试演示
    • 在本地部署 SAML Jackson 作为独立服务
      • 先决条件
      • 克隆仓库
      • 安装依赖
      • 设置环境变量
      • 数据库
      • 启动开发服务器
    • 文档
    • 简易云部署
  • 视频
  • 端到端 (E2E) 测试
  • 关于 BoxyHQ
  • 安全性和可观察性
    • 可观察性
    • SBOM 报告（软件物料清单）
    • 容器签名和验证
    • 🛡️ 报告安全问题
  • 贡献
  • 💫 支持
  • 📌 许可证

🚀 SAML Jackson 入门

有两种方式将 SAML Jackson 集成到应用程序中。根据您的用例，您可以选择其中之一。<br>

1. 作为独立服务（Next.js 应用程序）这包括一个内置的管理门户，用于管理单点登录和目录同步连接。
2. NPM 库作为嵌入在应用程序中的库。

尝试演示

• 在这里尝试我们的托管演示，展示 SAML 服务提供商 (SP) 发起的登录流程，它使用我们的 Mock SAML IdP 服务。
• 在这里尝试身份提供商 (IdP) 发起的登录流程。

在本地部署 SAML Jackson 作为独立服务

让我们快速开始使用 SAML Jackson。

先决条件

• Node.js 版本 18.14.2 或更高

通常使用版本管理器如 nvm 或 Windows 上的 nvs 来安装和维护 Node.js 版本是个好主意。更多信息可在此处获取。

克隆仓库

git clone https://github.com/boxyhq/jackson.git
cd jackson

安装依赖

npm i

设置环境变量

在项目根目录中从现有的 .env.example 文件创建一个 .env 文件。

cp .env.example .env

环境变量文档： 查看 https://boxyhq.com/docs/jackson/deploy/env-variables 了解所有可用的环境变量。

数据库

对于剩余的设置，我们将使用 PostgreSQL 数据库。在 macOS 上运行 PostgreSQL 最简单的方法是使用 Postgres.app。您可以从 https://postgresapp.com/ 下载它。

对于其他操作系统和 MacOS 的替代选项，请参阅 Prisma 网站上的可用文档。

启动开发服务器

现在我们的数据库已经运行，我们可以启动开发服务器了。但在此之前，我们需要一种登录管理门户的方法。

要登录管理门户，我们需要配置魔术链接，或启用用户名和密码登录。最简单的方法，也是我们将使用的方法，是启用用户名和密码登录。

在您的 .env 中找到 NEXTAUTH_ADMIN_CREDENTIALS 环境变量。我们需要提供一个 email:password 组合，然后可以用它登录管理门户。例如：

NEXTAUTH_ADMIN_CREDENTIALS=admin@example.com:password

现在我们可以启动开发服务器：

npm run dev

在浏览器中打开 http://localhost:5225，您应该会被重定向到登录界面。

在登录界面，您现在可以使用在 NEXTAUTH_ADMIN_CREDENTIALS 环境变量中设置的用户名和密码登录。点击"登录"，您应该会登录并看到没有配置连接的 SSO 连接页面。我们已经到达 Hello SAML Jackson！

文档

完整文档请访问 boxyhq.com/docs/jackson/overview

简易云部署

使用以下提供商，只需一次点击即可将 SAML Jackson 部署到云端：

视频

• SSO/OIDC 教程 SAML Jackson 企业 SSO（分章节，方便查找所需内容）
• SAML 单点登录演示

端到端 (E2E) 测试

创建一个 .env.test.local 文件并填入相应的值。要执行测试，请运行：

npm run test:e2e

关于 BoxyHQ

<a href="https://boxyhq.com/enterprise-sso"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/boxyhq/.github/assets/66887028/df1c9904-df2f-4515-b403-58b14a0e9093"> <source media="(prefers-color-scheme: light)" srcset="https://github.com/boxyhq/.github/assets/66887028/e093a466-72ea-41c6-a292-4c39a150facd"> <img alt="BoxyHQ - 面向开发者的安全构建模块" src="https://github.com/boxyhq/jackson/assets/66887028/b40520b7-dbce-400b-88d3-400d1c215ea1" height="auto" width="400" /> </picture> </a>

BoxyHQ 的使命是通过一次构建一个模块来实现企业级就绪的民主化。我们正在构建一套易于使用和集成到应用程序中的安全构建模块。我们的目标是让企业级就绪对所有开发者、创始人以及负责内部应用程序安全的人员来说都能轻松实现，无论他们的安全专业知识如何。

<a href="https://twitter.com/BoxyHQ"><img src="https://img.shields.io/twitter/follow/boxyhq?style=social" alt="在 Twitter/X 上关注我们"></a> <a href="https://www.linkedin.com/company/boxyhq"><img src="https://img.shields.io/badge/LinkedIn-blue" alt="在 LinkedIn 上与我们联系"></a>

社区是我们使命的核心。我们正在建立一个由开发者、安全爱好者和创始人组成的社区，他们对安全和构建安全应用程序充满热情。我们正在公开开发，希望您能加入我们的这次旅程。

今天就加入 Discord 社区。

<a href="https://discord.gg/uyb7pYt4Pa"><img src="https://img.shields.io/discord/877585485235630130" alt="加入 Discord 社区"></a>

安全性和可观察性

可观察性

我们在 OpenTelemetry 的基础上支持一流的可观察性，更多详情请参阅这里。

SBOM 报告（软件物料清单）

我们支持 SBOM 报告，更多详情请参阅这里。

容器签名和验证

我们支持使用 cosign 进行容器镜像验证，更多详情请参阅这里。

🛡️ 报告安全问题

负责任披露

贡献

感谢您对为 SAML Jackson 做出贡献的兴趣！我们很高兴欢迎社区的贡献。请参阅我们的贡献指南以获取更多信息。

💫 支持

在以下任一地方联系维护者：

• GitHub 讨论
• GitHub 问题
• Discord

📌 许可证

Apache 2.0 许可证