Skip to main content

此版本的 GitHub Enterprise Server 将于以下日期停止服务 2024-03-07. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

SAML 配置参考

可查看你的 GitHub Enterprise Server 实例 上)的 SAML 元数据,并详细了解可用的 SAML 属性和响应要求。

关于 SAML 配置

要使用 SAML 单一登录 (SSO) 对 GitHub Enterprise Server 进行身份验证,必须同时配置外部 SAML 标识提供者 (IdP) 和你的 GitHub Enterprise Server 实例 上)。 在 SAML 配置中,GitHub Enterprise Server 充当 SAML 服务提供商 (SP)。 有关企业身份验证的详细信息,请参阅“关于身份和访问管理”。

GitHub Enterprise Server 根据 SAML 2.0 规范提供集成。 有关详细信息,请参阅 OASIS 网站上的 SAML Wiki

在为 GitHub Enterprise Server 配置 SAML SSO 时,必须输入来自 SAML IdP 的唯一值,并且还必须在 IdP 上输入来自 GitHub Enterprise Server 的唯一值。 有关身份验证的详细信息

SAML 元数据

你的 GitHub Enterprise Server 实例 的 SP 元数据已在 http(s)://HOSTNAME/saml/metadata 上提供,其中 HOSTNAME 是实例的主机名。 GitHub Enterprise Server 使用 urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST 绑定。

其他名称说明示例
SP 实体 IDSP URL、受众限制GitHub Enterprise Server 的顶级 URLhttp(s)://HOSTNAME
SP 断言使用者服务 (ACS) URL回复、收件人或目标 URLIdP 发送 SAML 响应的 URLhttp(s)://HOSTNAME/saml/consume
SP 单点登录 (SSO) URL
IdP 开始 SSO 的 URLhttp(s)://HOSTNAME/sso

SAML 属性

以下 SAML 属性可用于 GitHub Enterprise Server。 你可以在 管理控制台 中更改属性名称,但 administrator 属性除外。 有关详细信息,请参阅“从 Web UI 管理实例”。

名称必需说明
NameID持久用户标识符。 可以使用任意持久名称标识符格式。 GitHub Enterprise Server 将规范化要用作用户名的 NameID 元素,除非提供了其中一个替代断言。 有关详细信息,请参阅“外部身份验证的用户名注意事项”。

注意:请务必使用易于阅读的永久性标识符。 使用暂时性标识符格式(如 urn:oasis:names:tc:SAML:2.0:nameid-format:transient)会导致每次登录时重新链接帐户,这可能不利于授权管理。
SessionNotOnOrAfterGitHub Enterprise Server 使关联会话失效的日期。 使之失效后,该用户必须再次进行身份验证才能访问你的 GitHub Enterprise Server 实例。 有关详细信息,请参阅“会话持续时间和超时”。
administrator当值为 true 时,GitHub Enterprise Server 会自动将用户提升为站点管理员。 将此属性设置为除 true 以外的任何值都将导致降级,只要该值不为空。 省略此属性或将值保留为空白不会更改用户的角色。
username你的 GitHub Enterprise Server 实例 的用户名。
full_name用户的全名将显示在用户的配置文件页上。
emails用户的电子邮件地址。可以指定多个地址。如果在 GitHub Enterprise Server 和 GitHub Enterprise Cloud 之间同步许可证使用情况,则 GitHub Connect 使用 emails 在产品之间标识唯一用户。 有关详细信息,请参阅“在 GitHub Enterprise Server 和 GitHub Enterprise Cloud 之间同步许可证使用情况”。
public_keys用户的 SSH 公钥。 你可以指定多个密钥。
gpg_keys用户的 GPG 密钥。 你可以指定多个密钥。

若要为属性指定多个值,请使用多个 <saml2:AttributeValue> 元素。

<saml2:Attribute FriendlyName="public_keys" Name="urn:oid:1.2.840.113549.1.1.1" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri">
    <saml2:AttributeValue>ssh-rsa LONG KEY</saml2:AttributeValue>
    <saml2:AttributeValue>ssh-rsa LONG KEY 2</saml2:AttributeValue>
</saml2:Attribute>

SAML 响应要求

GitHub Enterprise Server 要求来自 IdP 的响应消息满足以下要求。

  • 你的 IdP 必须在根响应文档上提供 <Destination> 元素,并且仅在根响应文档已签名时才与 ACS URL 匹配。 如果 IdP 对断言进行了签名,GitHub Enterprise Server 将忽略该断言。

  • IdP 必须始终提供 <Audience> 元素作为元素的 <AudienceRestriction> 一部分。 该值必须与 GitHub Enterprise Server 的 EntityId 一致。 此值是用于访问 你的 GitHub Enterprise Server 实例 的 URL,例如 http(s)://HOSTNAME

  • IdP 必须使用数字签名来保护响应中的每个断言。 你可以通过对每个单独的 <Assertion> 元素进行签名或通过对 <Response> 元素进行签名来完成。

  • IdP 必须提供 <NameID> 元素作为 <Subject> 元素的一部分。 可以使用任意持久名称标识符格式。

  • IdP 必须包含 Recipient 属性,该属性必须设置为 ACS URL。 下面的示例演示了该属性。

    <samlp:Response ...>
      <saml:Assertion ...>
        <saml:Subject>
          <saml:NameID ...>...</saml:NameID>
          <saml:SubjectConfirmation ...>
            <saml:SubjectConfirmationData Recipient="https://HOSTNAME/saml/consume" .../>
          </saml:SubjectConfirmation>
        </saml:Subject>
        <saml:AttributeStatement>
          <saml:Attribute FriendlyName="USERNAME-ATTRIBUTE" ...>
            <saml:AttributeValue>monalisa</saml:AttributeValue>
          </saml:Attribute>
        </saml:AttributeStatement>
      </saml:Assertion>
    </samlp:Response>
    

会话持续时间和超时

为防止有人使用你的 IdP 进行身份验证并无限期获得授权,GitHub Enterprise Server 会定期使有权访问你的 GitHub Enterprise Server 实例的每个用户帐户会话失效。 使之失效后,该用户必须再次向 IdP 进行身份验证。

默认情况下,如果 IdP 未断言 SessionNotOnOrAfter 属性的值,GitHub Enterprise Server 会使会话在成功通过 IdP 进行身份验证后失效一周。

如果 IdP 提供配置 SessionNotOnOrAfter 属性和值的选项,并且此属性包含在 SAML 响应中,则 GitHub Enterprise Server 将支持自定义会话持续时间。 如果 IdP 不允许 SessionNotOnOrAfter 属性,则站点管理员可以使用管理 shell 中的 ghe-config saml.default-session-expiration [seconds] 命令为实例上的所有用户配置自定义 SAML 会话超时。

如果定义的用户会话持续时间值小于 24 小时,GitHub Enterprise Server 可能会提示用户在每次 GitHub Enterprise Server 启动重定向时进行身份验证。

不管实例上使用的身份验证方法如何,GitHub Enterprise Server 将在非活动状态连续两周后终止用户会话。

注意:

  • 对于 Microsoft Entra ID(以前称为 Azure AD),SAML 令牌的可配置生存期策略不会控制 GitHub Enterprise Server 的会话超时。
  • 目前,Okta 在 SAML 身份验证期间不会使用 GitHub Enterprise Server 发送 SessionNotOnOrAfter 属性。 有关详细信息,请联系 Okta。