管理员设置 - SAML 身份验证

通过管理菜单中身份验证部分的 SAML 页面，您可以将 Looker 配置为使用安全断言标记语言 (SAML) 对用户进行身份验证。本页介绍了该流程，并包含将 SAML 组与 Looker 角色和权限相关联的说明。

SAML 和身份提供方

公司使用不同的身份提供方 (IdP) 与 SAML 协同工作（例如 Okta 或 OneLogin）。以下设置说明和界面中使用的术语可能与您的 IdP 中使用的术语并不直接一致。如需设置过程中的说明，请与您的内部 SAML 或身份验证团队联系，或与 Looker 支持团队联系。

Looker 会假定 SAML 请求和断言将被压缩；请确保您的 IdP 已配置为这样。Looker 向 IdP 发出的请求未签名。

Looker 支持 IdP 发起的登录。

某些设置流程必须在 IdP 的网站上完成。

Okta 提供 Looker 应用，这是将 Looker 和 Okta 一起配置的推荐方式。

在身份提供方上设置 Looker

SAML IdP 需要知道 Looker 实例网址，因为 SAML IdP 应将 SAML 断言 POST 到该网址。在 IdP 中，这个网址可能叫做“Post Back 网址”（回传网址）“收件人”即“目标”以及其他名称

您需要提供的信息是您通常使用浏览器访问 Looker 实例的网址，后跟 /samlcallback。例如：none https://instance_name.looker.com/samlcallback

或

https://looker.mycompany.com/samlcallback

部分 IdP 还要求您在实例网址后面添加 :9999。例如：

https://instance_name.looker.com:9999/samlcallback

注意事项

请注意以下几点：

  • Looker 需要 SAML 2.0。
  • 通过 SAML 登录 Looker 后，请勿停用 SAML 身份验证，除非您设置了备用账号登录信息。否则，您可能会被锁定在应用之外。
  • Looker 可以使用来自当前电子邮件地址和密码设置的电子邮件地址，或者使用来自 Google Auth、LDAP 或 OIDC 的电子邮件地址将现有账号迁移到 SAML。您可以在设置过程中配置现有账号的迁移方式。

使用入门

前往 Looker 管理部分的 SAML Authentication 页面，即可查看以下配置选项。请注意，对配置选项所做的任何更改都不会生效，除非您在页面底部测试并保存您的设置。

SAML 身份验证设置

Looker 要求提供 IdP 网址、IdP 颁发者和 IdP 证书来对您的 IdP 进行身份验证。

在 IdP 端为 Looker 进行配置过程中，您的 IdP 可能会提供 IdP 元数据 XML 文档。此文件包含 SAML Auth Settings（SAML 身份验证设置）部分请求的所有信息。如果您有此文件，可以在 IdP Metadata（IdP 元数据）字段中上传，该字段会填充本部分中的必填字段。或者，您也可以根据在 IdP 端配置期间获取的输出内容填写必填字段。如果您上传 XML 文件，则无需填写这些字段。

  • IdP 元数据（可选）： 请粘贴包含 IdP 信息的 XML 文档的公开网址，或者在此处粘贴整个文档文本。Looker 会解析该文件以填充必填字段。

如果您未上传或粘贴 IdP 元数据 XML 文档，请改为在 IdP URL（IdP 网址）、IdP Issuer（IdP 颁发者）和 IdP Certificate（IdP 证书）字段中输入 IdP 身份验证信息。

  • IdP 网址：Looker 用来对用户进行身份验证的网址。这在 Okta 中称为重定向网址。

  • IdP Issuer（IdP 发布者）：IdP 的唯一标识符。在 Okta 中，这称为“外部密钥”。

  • IdP 证书：用于让 Looker 验证 IdP 响应的签名的公钥。

通过这三个字段，Looker 可以确认一组已签名的 SAML 断言是否确实来自受信任的 IdP。

  • SP Entity/IdP Audience（SP 实体/IdP 受众群体）：此字段不是 Looker 的必填字段，但许多 IdP 都需要此字段。如果您在此字段中输入一个值，该值将作为授权请求中 Looker 的 Entity ID 发送到您的 IdP。在这种情况下，Looker 仅接受将此值作为 Audience 的授权响应。如果您的 IdP 需要 Audience 值，请在此处输入该字符串。
  • 允许的时钟偏移：允许的时钟偏移（IdP 和 Looker 之间的时间戳差异）的秒数。此值通常默认为 0，但某些 IdP 可能需要额外的空间才能成功登录。

用户属性设置

在以下字段中，指定 IdP 的 SAML 配置中的属性名称，其中包含每个字段的相应信息。输入 SAML 属性名称可告知 Looker 如何映射这些字段以及在登录时提取其信息。Looker 对此信息的构建方式并不讲究，您将其输入 Looker 的方式必须与在 IdP 中定义属性的方式保持一致。Looker 提供了有关如何构建这些输入的默认建议。

标准属性

您需要指定以下标准属性：

  • Email Attr（电子邮件地址属性）：IdP 为用户电子邮件地址使用的属性名称。

  • FName Attr：您的 IdP 用于用户名字的属性名称。

  • LName Attr：IdP 用于用户姓氏的属性名称。

将 SAML 属性与 Looker 用户属性配对

您可以选择使用 SAML 属性中的数据，在用户登录时自动填充 Looker 用户属性中的值。例如，如果您已配置 SAML 以建立特定于用户的数据库连接，则可以将 SAML 属性与 Looker 用户属性配对，以便在 Looker 中使数据库连接因用户而异。

如需将 SAML 属性与相应的 Looker 用户属性配对，请执行以下操作：

  1. 在 SAML 属性字段中输入 SAML 属性名称，并在 Looker 用户属性字段中输入要与之配对的 Looker 用户属性的名称。
  2. 如果您希望要求用户提供 SAML 属性值以允许用户登录，请选中必填。
  3. 点击 +，然后重复上述步骤以添加更多属性对。

群组和角色

您可以选择让 Looker 创建镜像外部管理的 SAML 群组的群组，然后根据用户镜像的 SAML 群组为用户分配 Looker 角色。当您更改 SAML 群组成员资格时，这些更改会自动传播到 Looker 的群组配置中。

借助镜像 SAML 群组，您可以使用外部定义的 SAML 目录管理 Looker 群组和用户。这样，您就可以在一个位置管理多个软件即服务 (SaaS) 工具（例如 Looker）的群组成员资格。

如果您启用 Mirror SAML Groups（镜像 SAML 群组），Looker 会为系统引入的每个 SAML 群组创建一个 Looker 群组。您可以在 Looker 的管理部分的群组页面上查看这些 Looker 群组。群组可用于向群组成员分配角色、设置内容访问权限控制，以及分配用户属性。

默认群组和角色

默认情况下，Mirror SAML Groups 开关处于关闭状态。在这种情况下，您可以为新的 SAML 用户设置默认群组。在新用户群组和新用户角色字段中，输入您希望在新 Looker 用户首次登录 Looker 时为其分配的任何 Looker 群组或角色的名称：

这些群组和角色会在新用户首次登录时应用于其。这些群组和角色不会应用于现有用户，并且如果在用户执行删除操作之后将其从用户中移除，这些群组和角色也不会重新应用初次登录。

如果您以后启用镜像 SAML 群组，系统会在用户下次登录时移除这些默认设置，并替换为镜像 SAML 群组部分分配的角色。这些默认选项将不再可用或不再分配，而是会被镜像群组配置完全取代。

启用镜像 SAML 群组

如果您选择在 Looker 中镜像 SAML 组，请开启 Mirror SAML Groups（镜像 SAML 组）开关。Looker 会显示以下设置：

Group Finder 策略：选择 IdP 用于分配群组的系统，具体取决于您的 IdP。

  • 几乎所有 IdP 都使用单个属性值来分配群组，如以下 SAML 断言示例所示： none <saml2:Attribute Name='Groups'> <saml2:AttributeValue >Everyone</saml2:AttributeValue> <saml2:AttributeValue >Admins</saml2:AttributeValue> </saml2:Attribute> 在这种情况下，请选择将群组作为单个属性的值。

  • 某些 IdP 会为每个群组使用单独的属性，然后需要第二个属性来确定用户是否为某个群组的成员。以下是显示此系统的 SAML 断言示例：none <saml2:Attribute Name='group_everyone'> <saml2:AttributeValue >yes</saml2:AttributeValue> </saml2:Attribute> <saml2:Attribute Name='group_admins'> <saml2:AttributeValue >no</saml2:AttributeValue> </saml2:Attribute> 在本例中，选择将群组作为具有成员资格值的个别属性。

“群组”属性：当群组查找器策略设置为将群组用作单个属性的值时，Looker 会显示此字段。输入 IdP 使用的群组属性的名称。

Group Member Value：当 Group Finder 策略设置为将群组作为具有成员资格值的个人属性时，Looker 会显示此字段。输入表明用户是群组成员的值。

首选群组名称/角色/SAML 群组 ID：通过这组字段，您可以分配自定义群组名称，以及分配给 Looker 中相应 SAML 群组的一个或多个角色：

  1. 在 SAML Group ID（SAML 群组 ID）字段中输入 SAML 群组 ID。对于 Okta 用户，请输入 Okta 群组名称作为 SAML 群组 ID。系统会将包含在 SAML 群组中的 SAML 用户添加到 Looker 内的镜像群组中。

  2. 在自定义名称字段中，为镜像的群组输入自定义名称。此名称将显示在 Looker 管理部分的群组页面上。

  3. 在自定义名称字段右侧的字段中，选择将分配给群组中每个用户的一个或多个 Looker 角色。

  4. 点击 + 可添加其他组字段，以配置其他镜像组。如果您配置了多个群组，但想要移除该群组的配置，请点击该群组字段旁边的 X。

如果您修改此屏幕中之前配置的镜像群组，该群组的配置将会更改，但群组本身将保持不变。例如，您可以更改群组的自定义名称，这会更改群组在 Looker 群组页面中的显示方式，但不会更改已分配的角色和群组成员。更改 SAML 群组 ID 会保留群组名称和角色，但系统会根据具有新 SAML 群组 UD 的外部 SAML 群组的成员，重新分配群组成员。

对镜像群组所做的任何修改将在该群组的用户下次登录 Looker 时生效。

高级角色管理

如果您启用了 Mirror SAML Groups（镜像 SAML 群组）开关，Looker 会显示这些设置。本部分中的选项决定了 Looker 管理员在配置从 SAML 镜像的 Looker 群组和用户时的灵活性。

例如，如果您希望 Looker 组和用户配置与 SAML 配置完全匹配，请开启这些选项。启用前三个选项后，Looker 管理员将无法修改镜像群组的成员资格，而只能通过 SAML 镜像的群组为用户分配角色。

如果您希望更灵活地在 Looker 中自定义群组，请关闭这些选项。您的 Looker 群组仍会反映您的 SAML 配置，但您可以在 Looker 中执行其他群组和用户管理操作，例如将 SAML 用户添加到 Looker 专用群组，或直接向 SAML 用户分配 Looker 角色。

对于新的 Looker 实例或之前未配置镜像群组的实例，这些选项默认处于停用状态。

对于配置了镜像群组的现有 Looker 实例，这些选项默认处于启用状态。

高级角色管理部分包含以下选项：

禁止单个 SAML 用户接收直接角色：启用此选项后，Looker 管理员将无法直接向 SAML 用户分配 Looker 角色。SAML 用户只能通过其群组成员资格获得角色。如果允许 SAML 用户成为内置（非镜像）Looker 群组的成员，他们仍然可以同时从镜像的 SAML 群组和内置 Looker 群组继承角色。对于之前直接获得过角色的所有 SAML 用户，系统会在他们下次登录时移除这些角色。

如果此选项处于关闭状态，Looker 管理员可以直接向 SAML 用户分配 Looker 角色，就像是在 Looker 中直接配置一样。

阻止直接加入非 SAML 群组：启用此选项后，Looker 管理员将无法直接将 SAML 用户添加到内置 Looker 群组。如果允许镜像的 SAML 群组成为内置 Looker 群组的成员，SAML 用户可以保留对任何父级 Looker 群组的成员资格。之前分配到内置 Looker 群组的所有 SAML 用户在下次登录时都会从这些群组中移除。

如果此选项处于关闭状态，Looker 管理员可以直接将 SAML 用户添加到内置的 Looker 群组。

防止非 SAML 群组继承角色：启用此选项可阻止镜像 SAML 群组中的成员继承内置 Looker 群组的角色。之前从父级 Looker 群组继承角色的任何 SAML 用户都将在下次登录时失去这些角色。

如果此选项处于关闭状态，则镜像的 SAML 群组或添加为内置 Looker 群组成员的 SAML 用户将继承分配给父级 Looker 群组的角色。

Auth Requires Role（需要角色进行身份验证）：如果此选项处于开启状态，则必须为 SAML 用户分配角色。任何未分配角色的 SAML 用户都将无法登录 Looker。

如果停用此选项，即使 SAML 用户没有分配角色，他们也可以向 Looker 进行身份验证。没有分配角色的用户将无法在 Looker 中查看任何数据或执行任何操作，但可以登录 Looker。

停用镜像 SAML 组

如果您想停止在 Looker 中镜像 SAML 群组，请关闭镜像 SAML 群组开关。所有空的镜像 SAML 群组都将被删除。

非空镜像 SAML 群组仍可用于内容管理和角色创建。但是，您无法在镜像 SAML 群组中添加或移除用户。

可供选择的迁移方案

为管理员和指定用户提供备用登录方式

启用 SAML 身份验证后，普通用户始终无法使用电子邮件和密码登录 Looker。此选项允许管理员和具有 login_special_email 权限的指定用户使用 /login/email 通过备用电子邮件地址登录。

如果日后出现 SAML 配置问题，或者您需要为 SAML 目录中没有账号的用户提供支持，那么启用此选项会非常有用。

指定用于将 SAML 用户合并到 Looker 账号的方法

在Merge Users Using（使用以下方法合并用户）字段中，指定用于将首次 SAML 登录合并到现有用户账号的方法。您可以合并以下系统中的用户：

  • Looker 电子邮件地址/密码（不适用于 Looker [Google Cloud Core]）
  • Google
  • LDAP（不适用于 Looker [Google Cloud Core]）
  • OIDC

如果您有多个系统，则可以在此字段中指定要合并的多个系统。Looker 会按照用户指定的顺序从所列系统中查找用户。例如，假设您使用 Looker 电子邮件地址和密码创建了一些用户，然后启用了 LDAP，现在您想使用 SAML。Looker 会先通过电子邮件地址和密码合并，然后再通过 LDAP 进行合并。

当用户通过 SAML 首次登录时，此选项会通过查找具有匹配电子邮件地址的账号，将用户连接到其现有账号。如果用户没有现有账号，系统会创建一个新用户账号。

使用 Looker (Google Cloud Core) 时合并用户

当您使用 Looker (Google Cloud Core) 和 SAML 时，可以按照上一部分中所述的方式进行合并。不过，只有在满足以下两种条件之一时，才有可能实现：

  1. 条件 1：用户通过 SAML 协议使用其 Google 身份对 Looker (Google Cloud Core) 进行身份验证。

  2. 条件 2：在选择合并选项之前，您已完成以下两个步骤：

如果您的实例不满足这两个条件中的任一条件，则使用“合并用户”选项将不可用。

合并时，Looker (Google Cloud Core) 会搜索具有完全相同电子邮件地址的用户记录。

测试用户身份验证

点击测试按钮以测试您的设置。测试将重定向到服务器，并打开一个浏览器标签页。该标签页会显示以下内容：

  • Looker 是否能够与服务器通信并进行验证。
  • Looker 从服务器获取的名称。您需要验证服务器是否返回正确的结果。
  • 用于显示信息的查找方式的跟踪记录。如果信息不正确，请使用跟踪记录进行问题排查。如果您需要其他信息，可以读取原始 XML 服务器文件。

提示：

  • 您可以随时运行此测试，即使 SAML 仅部分配置也是如此。在配置期间运行测试有助于了解需要配置哪些参数。
  • 测试会使用您在 SAML 身份验证页面上输入的设置，即使这些设置尚未保存也是如此。测试不会影响或更改该页面上的任何设置。
  • 在测试期间，Looker 使用 SAML RelayState 参数将信息传递给 IdP。IdP 应将此 RelayState 值原封不动地返回给 Looker。

保存并应用设置

输入完信息并且测试全部通过后，请选中我已确认上述配置，并希望启用全局应用配置并点击更新设置进行保存。

用户登录行为

当用户尝试使用 SAML 登录 Looker 实例时，Looker 会打开登录页面。用户必须点击 Authenticate 按钮，才能通过 SAML 发起身份验证。

如果用户没有有效的 Looker 会话，则这是默认行为。

如果您希望用户在 IdP 对其进行身份验证后直接登录 Looker 实例，并绕过登录页面，请在登录行为下方启用绕过登录页面。

如果您使用的是 Looker（原始版本），则需要由 Looker 启用绕过登录页面功能。如需更新此功能的许可，请与 Google Cloud 销售专家联系或创建支持请求。如果您使用的是 Looker (Google Cloud Core)，则在使用 SAML 作为主要身份验证方法时，系统会自动提供绕过登录页面选项，该选项默认处于停用状态。

启用“绕过登录页面”后，用户登录顺序如下所示：

  1. 用户尝试关联到 Looker 网址（例如 instance_name.looker.com）。

  2. Looker 会确定用户是否已启用有效的会话。为此，Looker 使用 Cookie AUTH-MECHANISM-COOKIE 来识别用户在上一个会话中使用的授权方法。该值始终为以下值之一：saml、ldap、oidc、google 或 email。

  3. 如果用户确实启用了有效会话，系统会将用户定向到请求的网址。

  4. 如果用户未启用有效会话，系统会将其重定向到 IdP。当用户成功登录 IdP 后，IdP 会对用户进行身份验证。然后，当 IdP 将用户发送回 Looker 时，Looker 会验证该用户的身份，并附上表明用户已通过该 IdP 身份验证的信息。

  5. 如果在 IdP 处的身份验证成功，Looker 会验证 SAML 断言，接受身份验证，更新用户信息，然后将用户转到所请求的网址（绕过登录页面）。

  6. 如果用户无法登录 IdP，或者他们未获得 IdP 授权使用 Looker，他们要么继续留在 IdP 的网站上，要么被重定向到 Looker 登录页面，具体取决于 IdP。

SAML 响应超出限制

如果尝试进行身份验证的用户收到错误消息，指出 SAML 响应已超出大小上限，您可以增加允许的 SAML 响应大小上限。

对于 Looker 托管的实例，请创建支持请求以更新 SAML 响应大小上限。

对于客户托管的 Looker 实例，您可以使用 MAX_SAML_RESPONSE_BYTESIZE 环境变量设置 SAML 响应大小上限（字节数）。例如：

export MAX_SAML_RESPONSE_BYTESIZE=500000

SAML 响应大小上限的默认值为 250,000 字节。