View a markdown version of this page

的 IAM 身份验证 OpenSearch 用户界面 - 亚马逊 OpenSearch 服务

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

的 IAM 身份验证 OpenSearch 用户界面

本主题涵盖了访问所需的最低 IAM 权限 OpenSearch 使用 IAM 身份验证的 UI 应用程序,没有 AWS IAM Identity Center。完成这些步骤后,IAM 角色可以登录应用程序并查询其数据源。

先决条件

第 1 步:授予 IAM 权限

以下 IAM 策略授予对应用程序接口的访问权限。将其附加到需要访问权限的 IAM 角色,并将占位符值替换为您自己的信息:

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "opensearch:ApplicationAccessAll", "Resource": "arn:aws:opensearch:{{region}}:{{account-id}}:application/{{application-id}}" } ] }

将资源范围限定为单个应用程序 ID 可授予角色所需的最低权限。要改为向账户和区域中的所有应用程序授予访问权限,请使用通配符:

"Resource": "arn:aws:opensearch:{{region}}:{{account-id}}:application/*"

您可以将相同的策略附加到 AWS CLI:

aws iam put-role-policy \ --role-name {{role-name}} \ --policy-name OpenSearchAppAccess \ --policy-document '{ "Version":"2012-10-17", "Statement":[{ "Effect":"Allow", "Action":"opensearch:ApplicationAccessAll", "Resource":"arn:aws:opensearch:{{region}}:{{account-id}}:application/{{application-id}}" }] }'
注意

授予应用程序接口访问权限的操作是 opensearch:ApplicationAccessAll。有关应用程序所需权限的更多信息,请参阅 的 IAM 政策参考 OpenSearch 用户界面。

如果您的用户还从中打开应用程序 AWS 管理控制台,添加以下语句,这样他们就可以在控制台中查看应用程序:

{ "Effect": "Allow", "Action": "es:GetApplication", "Resource": "arn:aws:opensearch:{{region}}:{{account-id}}:application/{{application-id}}" }

步骤 2:配置仪表板管理员

设置哪些 IAM 委托人在内部获得管理员权限 OpenSearch 用户界面。要向所有经过身份验证的用户授予管理员权限,请运行以下命令:

aws opensearch update-application \ --id {{application-id}} \ --app-configs '[{"key":"opensearchDashboards.dashboardAdmin.users","value":"*"}]' \ --region {{region}}

要向单个角色授予管理员权限,请指定角色 ARN:

aws opensearch update-application \ --id {{application-id}} \ --app-configs '[{"key":"opensearchDashboards.dashboardAdmin.users","value":"arn:aws:iam::{{account-id}}:role/{{role-name}}"}]' \ --region {{region}}
注意

仪表板管理员设置控制界面内部的管理员功能,例如索引模式管理和保存的对象。您无需登录——步骤 1 中的 IAM 策略足以访问应用程序。

步骤 3:验证访问权限

您可以使用预签名 URL 验证浏览器的访问权限,也可以使用签名版本 4 请求标头以编程方式验证访问权限。

验证浏览器访问权限

以下 Python 代码示例生成您在浏览器中打开的签名版本 4 预签名 URL:

from botocore.session import Session from botocore.auth import SigV4QueryAuth from botocore.awsrequest import AWSRequest session = Session() cred = session.get_credentials().get_frozen_credentials() endpoint = "{{application-endpoint}}" region = "{{region}}" url = f"https://{endpoint}/_login/" request = AWSRequest(method="GET", url=url) SigV4QueryAuth(cred, "opensearch", region, expires=300).add_auth(request) print(request.url) # Open this URL in a browser
注意

这个 /_login/ 预签名 URL 只能在浏览器中使用。它不适用于 curl 或其他 HTTP 客户端。

以编程方式验证访问权限

以下 Python 代码示例使用签名版本 4 标头对向应用程序端点发出的请求进行签名:

from botocore.session import Session from botocore.auth import SigV4Auth from botocore.awsrequest import AWSRequest import subprocess session = Session() cred = session.get_credentials().get_frozen_credentials() endpoint = "{{application-endpoint}}" region = "{{region}}" url = f"https://{endpoint}/" request = AWSRequest(method="GET", url=url) SigV4Auth(cred, "opensearch", region).add_auth(request) cmd = ["curl", "-s", "-w", "\nHTTP: %{http_code}\n", "-D", "-"] for k, v in request.headers.items(): cmd.extend(["-H", f"{k}: {v}"]) cmd.append(url) result = subprocess.run(cmd, capture_output=True, text=True) print(result.stdout)

成功的请求返回 HTTP/1.1 302 Found 用 location 的标题 /app/workspace_initial。返回的请求 HTTP/1.1 403 Forbidden 表示 IAM 政策存在问题。

签名版本 4 签名详情

下表列出了签名版本 4 的参数 OpenSearch 我预计。

参数 值
服务名称 opensearch
算法 AWS4-HMAC-SHA256
已签名标头 host,至少
预签名 URL 到期 建议不超过 300 秒
重要

签名版本 4 的服务名称是 opensearch。使用签名 es 要么 aoss 导致请求失败。

配置摘要

下表列出了每个配置层控制的内容。

层 配置 需要登录吗?
IAM 策略 opensearch:ApplicationAccessAll 在应用程序 ARN 上 是
IAM 策略 es:GetApplication 在应用程序 ARN 上 只能从中打开应用程序 AWS 管理控制台
应用程序配置 opensearchDashboards.dashboardAdmin.users 不——它仅控制管理员功能

排除 IAM 身份验证

IAM 身份验证问题通常源于缺少策略操作、在浏览器外部使用的预签名 URL 或使用错误的服务名称签名的请求。下表列出了常见症状、可能的原因以及每种症状的解决方法。

症状 可能原因 解决方案
403 Forbidden 当你打开应用程序 URL 时 这个 opensearch:ApplicationAccessAll 权限缺失 添加步骤 1 中的 IAM 策略
403 并显示一条您无权执行的消息 es:GetApplication 缺少控制台权限 添加 es:GetApplication 在应用程序 ARN 上。这仅对以下情况是必需的 AWS 管理控制台 访问
400 Bad Request 上 /_login/ 和 curl 这个 /_login/ 端点只能在浏览器中使用 启用签名版本 4 标头身份验证 / 用于编程访问
预签名 URL 返回 SignatureDoesNotMatch 签名版本 4 的服务名称错误 使用以下方式签署请求 opensearch,不是 es 要么 aoss
您可以打开应用程序,但缺少管理员功能 未配置仪表板管理员 跑 update-application 和 opensearchDashboards.dashboardAdmin.users,如步骤 2 中所述
预签名 URL 已过期 该网址是在 300 多秒之前生成的 生成新的预签名 URL。预签名 URL 的寿命很短

有关 IAM 操作的更多信息, OpenSearch 用户界面用途,请参阅 的 IAM 政策参考 OpenSearch 用户界面。