Google SAML 实施

对应的官方文档地址

本文是专门针对 Google Workspace 用于配置 SAML 2.0 方式的 SSO 登录的帮助。有关其他 IdP 方式配置 SSO 登录的帮助,请参阅 SAML 2.0 配置

配置需要在 Bitwarden 业务门户和 Google Workspace 控制台中同时进行。在您继续进行操作时,我们建议您随时准备好并按照记录的顺序完成步骤。

是 SSO 专业人士?请跳过本文中的说明,然后下载配置示例的截图以与您自己的配置进行比较。

📥 下载示例

打开业务门户

如果你是直接从 SAML 2.0 配置过来的,你应该已经创建了一个组织 ID 并打开了 SSO 配置界面。如果没有,请打开业务门户并导航到 SSO 配置界面:

SAML 2.0 配置

你不需要编辑此界面上的任何内容,但要保持打开以方便参考。

创建 SAML 应用程序

在 Google Workspace 管理控制台中,从导航中选择 AppsSAML apps

选择 Add AppAdd custom SAML app

应用程序详细信息

在应用程序详细信息界面,为应用程序指定一个唯一的专用于 Bitwarden 的名称,然后选择 Continue 按钮。

Google 身份提供程序详细信息

在 Google 身份提供程序详细信息界面,复制 SSO URLEntity IDCertificate供后续步骤使用

完成后选择 Continue

服务提供程序详细信息

在服务提供程序详细信息界面,配置以下字段:

字段

描述

ACS URL

将此字段设置为从 Bitwarden SSO 配置界面预先生成的 Assertion Consumer Service (ACS) URL。 对于云托管客户,其始终为 https://sso.bitwarden.com/saml2/your-org-id/Acs。对于自托管实例,这由您配置的服务器 URL 决定,例如为 https://your.domain/sso/saml2/your-org-id/Acs

Entity ID

将此字段设置为从 Bitwarden SSO 配置界面预先生成的 SP Entity ID。 对于云托管客户,其始终为 https://sso.bitwarden.com/saml2。对于自托管实例,这由您配置的服务器 URL 决定,例如为 https://your.domain.com/sso/saml2

Start URL

可选。将此字段设置为用户访问 Bitwarden 的登录 URL。 对于云托管客户,其始终为 https://vault.bitwarden.com/#/sso。对于自托管实例,这由您配置的服务器 URL 决定,例如为 https://your.domain.com/#/sso

Signed response

如果您希望 Workspace 签名 SAML 响应,请选中此框。如果未选中,Workspace 将仅签名 SAML 声明。

Name ID format

将此字段设置为 Workspace 在 SAML 响应中使用的 SAML NameID Fomart

Name ID

选择 Workspace 用户属性,以填充 NameID。

完成后选择 Continue

属性映射

在属性映射界面,选择 Add Mapping 按钮并构建如下的映射:

Google Directory 属性

应用程序属性

Primary email

email

选择 Finish

开启应用程序

默认,Workspace SAML 应用程序将 OFF for everyone(对所有人关闭)。打开 SAML 应用程序的 User Access(用户访问)部分,并根据您的需要,设置为 ON for everyone(对所有人开启)或对特定群组开启:

Save 您的更改。

回到业务门户

至此,您已经在 Google Workspace 管理控制台中配置了所需的一切。回到 Bitwarden 业务门户以完成配置。

业务门户将配置分为两个部分:

  • SAML Service Provider Configuration(SAML 服务提供程序配置):确定 SAML 请求的格式。

  • SAML Identity Provider Configuration(SAML 身份提供程序配置):确定期望 SAML 响应的格式。

服务提供程序配置

根据在 Workspace 管理控制台设置期间所选择的选项配置以下字段:

字段

描述

Name ID Format

将此字段设置为在 Workplace 中所选择的 NameID 格式

Outbound Signing Algorithm

Bitwarden 用于签名 SAML 请求的算法。

Signing Behavior

SAML 请求是否/何时将被签名。

Minimum Incoming Signing Algorithm

Bitwarden 在 SAML 响应中接受的最小签名算法。默认,Workplace 使用 SHA-256 进行签名。请从下拉列表中选择 sha-256

Want Assertions Signed

Bitwarden 是否要求 SAML 声明被签名。默认,Workspace SAML 应用程序将签名 SAML 声明,因此请选中此框。

Validate Certificates

通过受信任的 CA 使用来自 IdP 的受信任和有效证书时,请选中此框。除非在 Bitwarden SSO 登录 docker 镜像中配置了适当的信任链,否则自签名证书可能会失败。

完成服务提供程序配置部分后,Save(保存)您的工作。

身份提供程序配置

身份提供程序配置通常需要你返回 Workplace 管理控制台以获取应用程序的值:

字段

描述

Entity ID

将此字段设置为 Workplace 的 Entity ID,这可以从 Google 身份提供程序详细信息部分或使用 Download Metadata 按钮来获取。

Binding Type

将此字段设置为 HTTP POSTRedirect

Single Sign On Service URL

将此字段设置为 Workplace 的 SSO URL,这可以从 Google 身份提供程序详细信息部分或使用 Download Metadata 按钮来获取。

Single Log Out Service URL

SSO 登录当前还不支持 SLO。该选项计划用于将来的开发,但是您可以根据需要预先配置它。

Artifact Resolution Service URL

对于 Workplace SAML 实现,将此字段留空。

X509 Public Certificate

黏贴已获取的证书,移除 -----BEGIN CERTIFICATE----------END CERTIFICATE-----。 多余的空格、回车符和其他多余的字符将导致证书验证失败

Outbound Signing Algorithm

默认,Google Workspace 将使用 RSA SHA-256 进行签名。从下拉列表中选择 sha-256

Allow Unsolicited Authentication Response

SSO 登录当前不支持未经请求(由 IdP 发起)的 SAML 声明。该选项计划用于将来的开发。

Disable Outbound Logout Requests

SSO 登录当前还不支持 SLO。该选项计划用于将来的开发。

Want Authentication Requests Signed

Google Workspace 是否要求 SAML 请求被签名。

完成身份提供程序配置部分后,Save(保存)您的工作。

测试配置

配置完成后,通过导航到 https://vault.bitwarden.com 并选择 Enterprise Single Sign-On 按钮来进行测试:

Enterprise Single Sign-On 按钮

输入已配置的组织标识符,然后选择 Log In。如果您的实现已成功配置,您将被重定向到 Google Workspace 的登录界面:

使用您的 Workspace 凭据进行身份验证后,输入您的 Bitwarden 主密码来解密您的密码库!