发布层上为 AEM as a Cloud Service 提供 Open ID Connect 支持 open-id-connect-support-for-aem-as-a-cloud-service-on-publish-tier

简介 introduction

随着组织进一步推动其数字体验的现代化,安全且可扩展的身份管理已成为一项基本要求。现在,Adobe Experience Manager (AEM) 云服务在发布层支持 OpenID Connect (OIDC),允许与领先的身份提供商 (IdP)(例如 Entra ID (Azure AD)、Google、Okta、Auth0、Ping Identity、ForgeRock 和 OIDC 支持的 IDP)进行基于标准的无缝集成。

OIDC 是 OAuth 2.0 协议之上的身份层,可实现强大的用户身份验证,而且方便开发人员使用。它广泛应用于企业对消费者 (B2C)、内联网和合作伙伴门户等需要安全的用户登录和身份联盟的场景。

到目前为止,AEM 客户需要自己负责实施发布层上的自定义登录逻辑,这增加了开发时间并带来了长期维护和安全挑战。通过对 OIDC 的原生支持,AEM Cloud Service 为访问发布环境的最终用户提供一个安全、可扩展、受到 Adobe 支持的身份验证机制,从而消除了这一负担。

无论您提供的是个性化的消费者网站还是经过身份验证的内部门户网站,发布上的 OIDC 都可以简化身份联盟,并通过集中身份治理降低风险。它还可以帮助组织在不影响敏捷度的情况下满足现代合规要求和安全性标准。

为 OIDC 身份验证配置 AEM configure-aem-oidc-authentication

先决条件 prerequisits

我们假设以下信息可用或已定义:

  1. AEM 存储库中需受保护的内容的路径
  2. 要配置的 IdP 的标识符。这可以是任何字符串

IdP 配置中的信息:

  1. IdP 中配置的客户端 ID
  2. IdP 中配置的客户端密码。如果在 Idp 上配置了 PKCE,客户端密码就不可用。不要在配置文件中存储纯文本值。使用 CM 密码并引用它
  3. Idp 上配置的范围。至少必须提供范围 openid
  4. IdP 上是否启用了 PKCE
  5. callbackUrl 的定义是使用在点 1 处定义的配置路径之一,然后添加后缀:/j_security_check
  6. baseUrl 用于访问标准 .well-known 文件。例如,如果众所周知的 URL 是:https://login.microsoftonline.com/53279d7a-438f-41cd-a6a0-fdb09efc8891/v2.0/.well-known/openid-configuration,那么 baseUrl 就是:https://login.microsoftonline.com/53279d7a-438f-41cd-a6a0-fdb09efc8891

配置文件概述 overview-of-the-configuration-files

以下是需要配置的文件列表:

  1. OIDC 连接OidcAuthenticationHandler 将使用它对用户进行身份验证,或者其他组件使用它来授予对使用 OAuth 受 IdP 保护的资源的访问权限
  2. OIDC 身份验证处理程序:这个身份验证处理程序用于对访问所配置路径的用户进行身份验证
  3. UserInfoProcessor:此组件处理 IdP 接收的信息。客户可以将其扩展来实施自定义逻辑
  4. 默认同步处理程序:此组件在存储库中创建用户
  5. ExternalLoginModule:此组件在本地 oak 存储库中对用户进行身份验证。

下图显示了上述配置元素如何链接。请注意,由于这些是 ServiceFactory 组件,因此 ~uniqueid 可以是任何随机的唯一字符串:

OIDC 配置图

配置 OIDC 连接 configure-the-oidc-connection

首先,我们需要配置 OIDC 连接。可以配置多个 OIDC 连接,每个连接都必须有不同的名称。

  1. 创建一个新 .cfg.json 文件来存放配置。例如,您可以使用 org.apache.sling.auth.oauth_client.impl.OidcConnectionImpl~azure.cfg.json - azure 后缀必须是此连接的唯一标识符

  2. 遵循以下示例中的配置格式:

    code language-none
    {
     "name":"azure",
     "scopes":[
       "openid"
     ],
     "baseUrl":"<https://login.microsoftonline.com/tenant-id/v2.0>",
     "clientId":"client-id-from-idp",
     "clientSecret":"xxxxxx"
    }
    

在某些环境中,标识提供程序(IdP)可能未公开有效的.well-known端点。
发生这种情况时,可以通过在配置文件中指定以下属性来手动定义所需的端点。
在此配置模式下,不得设置baseUrl属性。

"authorizationEndpoint": "https://idp-url/oauth2/v1/authorize",
"tokenEndpoint": "https://idp-url/oauth2/v1/token",
"jwkSetURL":"https://idp-url/oauth2/v1/keys",
"issuer": "https://idp-url"
  1. 按照下述方法配置其属性:

    • “名称”​可由用户定义
    • baseUrlclientidclientSecret 是 IdP 中的配置值。
    • 范围必须至少包含值 openid

配置 OIDC 身份验证处理程序 configure-oidc-authentication-handler

现在,配置 OIDC 身份验证处理程序。可以配置多个 OIDC 连接。每个都必须有不同的名称。如果他们有相同的 OAK 外部身份提供者,他们就可以共享用户。

  1. 创建配置文件。在此例中,我们将使用 org.apache.sling.auth.oauth_client.impl.OidcAuthenticationHandler~azure.cfg.jsonazure 后缀必须是唯一的标识符。请参阅下面的配置文件示例:

    code language-none
    {
      "path":"/content/tests/us/en/test-7",
      "callbackUri":"http://localhost:14503/content/tests/us/en/test-7/j_security_check",
      "pkceEnabled":false,
      "defaultConnectionName":"azure"
      "idp": "azure-idp"
    }
    
  2. 然后,按照下述方法配置其属性:

    • path:需要保护的路径
    • callbackUri:要保护的路径,添加后缀: /j_security_check。 还必须在远程IdP中将同一callbackUri配置为重定向url。
    • defaultConnectionName:使用上一步中为 OIDC 连接定义的相同名称进行配置+
    • pkceEnabledtrue 代码交换证明密钥 (PKCE) 授权码流程
    • idpOAK 外部身份提供者的名称。请注意,不同的 OAK IDP 不能共享用户或组

配置 SlingUserInfoProcessor configure-slinguserinfoprocessor

  1. 创建配置文件。在此例中,我们将使用 org.apache.sling.auth.oauth_client.impl.SlingUserInfoProcessor~azure.cfg.jsonazure 后缀必须是唯一的标识符。请参阅下面的配置文件示例:

    code language-none
    {
       "groupsInIdToken":true,
       "groupsClaimName": "groups",
       "connection":"azure",
       "storeAccessToken": false,
       "storeRefreshToken": false,
       "idpNameInPrincipals": true
    }
    
  2. 然后,按照下述方法配置其属性:

    • groupsInIdToken:如果组在 ID 令牌中发送,将其设置为 true。如果值为 false 或未指定,则从 UserInfo 端点读取组。
    • groupsClaimName:声明的名称中包含要在 AEM 中同步的组。
    • connection:使用上一步中为 OIDC 连接定义的相同名称进行配置
    • storeAccessToken:如果访问令牌必须存储在存储库中,此值为 true。默认情况下是 false。只有当 AEM 需要代表用户访问存储在受同一 IdP 保护的外部服务器中的资源时,才将其设置为 true。
    • storeRefreshToken:如果刷新令牌必须存储在存储库中,此值为 true。默认情况下是 false。仅当AEM需要代表存储在受同一IdP保护的外部服务器中的用户访问资源并需要从IdP刷新令牌时,才将其设置为true。
    • idpNameInPrincipals:当设置为true时,IdP的名称将作为后缀添加到用“;”分隔的用户和组承担者。 例如,如果IdP名称为azure-idp,用户名为john.doe,则存储在oak中的主体将为john.doe;azure-idp。 在Oak中配置多个IdP以避免来自不同IdP的同名用户或组之间发生冲突时,此方法非常有用。 也可以设置此以避免与其他身份验证处理程序(如Saml)创建的用户或组冲突。
      请注意,访问令牌和刷新令牌都通过 AEM 主密钥加密存储。

配置同步处理程序 configure-the-synchronization-handler

必须至少配置一个同步处理程序来同步在 oak 中经过身份验证的用户。有关更多详细信息,请参阅页面。

创建名为 org.apache.jackrabbit.oak.spi.security.authentication.external.impl.DefaultSyncHandler~azure.cfg.json 的文件。azure 后缀必须是唯一的标识符。有关如何配置其属性的更多信息,请参阅 Oak 用户和组同步文档。请参阅下面的配置示例:

{
  "user.expirationTime":"1h",
  "user.membershipExpTime":"1h",
  "group.expirationTime": "1d"
  "user.propertyMapping":[
    "profile/givenName=profile/given_name",
    "profile/familyName=profile/family_name",
    "rep:fullname=profile/name",
    "profile/email=profile/email",
    "access_token=access_token",
    "refresh_token=refresh_token"
  ],
  "user.pathPrefix":"azure",
  "handler.name":"azure"
}

在开发期间,可以将过期时间减少到较低的值(例如:1秒),以加快oak中用户和组同步的测试。
下面是需要在 DefaultSyncHandler 中配置的一些最相关的属性。请注意,云服务中应始终启用动态组成员资格。

属性名称
注释
建议的值
user.expirationTime
直到被同步的用户过期的持续时间。只有在过期后才同步用户。
1h
user.membershipExpTime
直到被同步的用户会员资格过期的持续时间。只有在过期后才同步用户会员资格。
1h
user.dynamicMembership
我们建议启用动态组会员资格
true
user.enforceDynamicMembership
我们建议启用强制执行动态组会员资格
true
group.dynamicGroups
我们建议启用动态组
true
user.propertyMapping
提供的 UserInfoProcessor 实施只同步少数几个属性。可以将其修改和自定义。
"profile/givenName=profile/given_name",
"profile/familyName=profile/family_name",
"rep:fullname=profile/name",
"profile/email=profile/email",
"access_token=access_token",
"refresh_token=refresh_token"
user.membershipNestingDepth
返回在会员资格关系同步时最大的组嵌套深度。值为 0 时可有效禁用组会员资格查找。值为 1 时仅添加用户的直接组。仅在同步一个用户会员资格祖先时才同步各个组的情况下,这个值不起任何作用。
1

配置外部登录模块 configure-the-external-login-module

最后,您需要配置外部登录模块。

  1. 创建名为 org.apache.jackrabbit.oak.spi.security.authentication.external.impl.ExternalLoginModuleFactory~azure.cfg.json 的文件。请参阅下面的配置示例:

    code language-none
    {
     "sync.handlerName":"azure",
     "idp.name":"azure-idp"
    }
    
  2. 按照下述方法配置其属性:

    • sync.handlerName:之前定义的同步处理程序的名称
    • idp.name:OIDC 身份验证处理程序中定义的 OAK 身份提供者

可选:实施一个自定义 UserInfoProcessor implement-a-custom-userinfoprocessor

通过 ID 令牌验证用户身份,在为 IdP 定义的 userInfo 端点中获取附加属性。如果必须执行额外的非标准操作,则 UserInfoProcessor 的自定义实施是 Sling 的默认实施。

为外部组配置ACL configure-acl-for-external-groups

当用户通过OIDC进行身份验证时,其组成员资格通常与外部身份提供商同步。
这些外部组是在AEM存储库中动态创建的,不会自动与任何访问控制条目关联。
为确保用户具有适当的权限,必须为这些组明确定义访问控制列表(ACL)。

提供了两种主要方法。

选项1 — 本地组

可以将外部组添加为已具有所需ACL的本地组的成员。

  • 外部组必须存在于存储库中,当属于该组的用户首次登录时,会自动发生这种情况。
  • 当使用封闭用户组(CUG)时,此选项通常为首选,因为创作和发布环境中都存在本地组。

选项2 — 通过RepoInit对外部组进行直接ACL

ACL可以使用RepoInit脚本直接应用于外部组。

  • 这种方法更有效,并且在不使用CUG时更可取。

  • 以下示例显示了一个向外部组分配读取权限的RepoInit配置。 选项ignoreMissingPrincipal允许创建ACL,即使存储库中不存在该组:

    code language-none
    {
      "scripts":[
        "set ACL for \"my-group;my-idp\"  (ACLOptions=ignoreMissingPrincipal)\r\n  allow jcr:read on /content/wknd/us/en/magazine\r\nend"
      ]
    }
    
NOTE
AEM权限UI可用于检查分配给组承担者的ACL

示例:通过 Azure Active Directory 配置 OIDC 身份验证

在 Azure Active Directory 中配置新的应用程序 configure-a-new-application-in-azure-ad

  1. 按照 Azure Active Directory 文档的说明在 Azure Active Directory 中创建新的应用程序。请参见下面详细展示应用程序概述的屏幕:

    应用程序概述

  2. 如果需要组或应用程序角色,请按照文档中的说明为应用程序启用这些角色,并将其发送到 ID 令牌中。以下是已配置组的示例:

OIDC 声明令牌 ID

  1. 按照前面记录的步骤,创建必需的配置文件。下面是专门针对 Azure AD 的示例:

    • 我们将 oidc 连接、身份验证处理程序和 DefaultSyncHandler 的名称定义为:azure
    • 网站 url 为:www.mywebsite.com
    • 我们保护只能由组/content/wknd/us/en/adventures的经过身份验证的用户成员访问的路径adventures
    • 租户是:tennat-id
    • 客户端 id 是:client-id
    • 密码是:secret
    • 这些组在以下声明中发送到 ID 令牌中:groups

org.apache.sling.auth.oauth_client.impl.OidcConnectionImpl~azure.cfg.json

{
  "name":"azure",
  "scopes":[
    openid", "User.Read", "profile", "email"
  ],
  "baseUrl":"https://login.microsoftonline.com/tenant-id/v2.0",
  "clientId":"client-id",
  "clientSecret":"secret"
}

org.apache.sling.auth.oauth_client.impl.OidcAuthenticationHandler~azure.cfg.json

{
  "callbackUri":"https://www.mywebsite.com/content/wknd/us/en/adventures/j_security_check",
  "path":[
    "/content/wknd/us/en/adventures"
  ],
  "idp":"azure",
  "defaultConnectionName":"azure"
}

org.apache.jackrabbit.oak.spi.security.authentication.external.impl.ExternalLoginModuleFactory~azure.cfg.json

{
  "sync.handlerName":"azure",
  "idp.name":"azure"
}

org.apache.jackrabbit.oak.spi.security.authentication.external.impl.DefaultSyncHandler~azure.cfg.json

{
  "user.expirationTime":"1h",
  "user.membershipExpTime":"1h",
  "group.expirationTime": "1d"
  "user.propertyMapping":[
    "profile/givenName=profile/given_name",
    "profile/familyName=profile/family_name",
    "rep:fullname=profile/name",
    "profile/email=profile/email",
    "access_token=access_token",
    "refresh_token=refresh_token"
  ],
  "user.pathPrefix":"azure",
  "group.pathPrefix": "oidc",
  "user.membershipNestingDepth": "1",
  "handler.name":"azure"
}

org.apache.sling.jcr.repoinit.RepositoryInitializer~azure.cfg.json

{
  "scripts":[
    "set ACL for \"adventures;azure\"  (ACLOptions=ignoreMissingPrincipal)\r\n  allow jcr:read on /content/wknd/us/en/adventures\r\nend"
  ]
}

org.apache.sling.auth.oauth_client.impl.SlingUserInfoProcessorImpl~azure.cfg.json

{
  "groupsInIdToken": "true",
  "storeAccessToken": "false",
  "storeRefreshToken": "false",
  "connection": "azure",
  "groupsClaimName": "groups"
}

关于 Azure AD 组的其他信息 additional-information-about-azure-ad-groups

要在 Microsoft Azure 门户中为企业应用程序配置组,您需要在​ 企业应用程序 ​上搜索该应用程序,然后添加组:

添加 OIDC 组

要在 Id 令牌中启用组声明,请在 Microsoft Azure 门户的​ 令牌配置 ​分区中添加声明:

OIDC 声明令牌 ID

SlingUserInfoProcessor 的配置必须像下例中这样进行修改。

需要修改的文件名称为 org.apache.sling.auth.oauth_client.impl.SlingUserInfoProcessorImpl.cfg.json。内容应进行如下配置:

{
  "connection": "azure",
  "groupsInIdToken": "true",
  "storeAccessToken": "false",
  "storeRefreshToken": "false"
}

如何从Saml身份验证处理程序迁移到Oidc身份验证处理程序

如果AEM已配置SAML身份验证处理程序,并且存储库中存在启用了数据同步的用户,则原始SAML用户与新OIDC用户之间可能会发生冲突。

  1. SlingUserInfoProcessor配置中配置idpNameInPrincipalsOidcAuthenticationHandler并启用
  2. 为外部组设置ACL。
  3. 从用户登录后,可以删除由saml身份验证处理程序创建的旧用户。
NOTE
在禁用SAML身份验证处理程序并启用OIDC身份验证处理程序后,如果未启用数据同步,则现有会话将无效。 用户需要再次进行身份验证,这会导致在存储库中创建新的OIDC用户节点。
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab