本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
OpenSearch UI 的 IAM 身分驗證
本主題涵蓋存取使用 IAM 身分驗證且不使用 的 OpenSearch UI 應用程式所需的最低 IAM 許可 AWS IAM Identity Center。完成這些步驟後,IAM 角色可以登入應用程式並查詢其資料來源。
先決條件
-
使用 IAM 身分驗證建立的 OpenSearch UI 應用程式。如需建立應用程式的指示,請參閱 Amazon OpenSearch Service 中的 OpenSearch 使用者介面入門。
-
需要存取應用程式的 IAM 角色。
-
使用登入資料 AWS CLI 設定的 。
步驟 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。如需應用程式所需許可的詳細資訊,請參閱 OpenSearch UI 的 IAM 政策參考。
如果您的使用者也從 開啟應用程式 AWS 管理主控台,請新增下列陳述式,讓他們可以在 主控台中檢視應用程式:
{ "Effect": "Allow", "Action": "es:GetApplication", "Resource": "arn:aws:opensearch:{{region}}:{{account-id}}:application/{{application-id}}" }
步驟 2:設定儀表板管理員
設定哪些 IAM 主體在 OpenSearch UI 中接收管理員權限。若要授予所有已驗證使用者的管理員權限,請執行下列命令:
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 來驗證瀏覽器的存取,或以程式設計方式使用 Signature 第 4 版請求標頭來驗證存取。
從瀏覽器驗證存取權
下列 Python 程式碼範例會產生您在瀏覽器中開啟的 Signature 第 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 程式碼範例使用 Signature 第 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 政策發生問題。
Signature 第 4 版簽署詳細資訊
下表列出 OpenSearch UI 預期的 Signature 第 4 版參數。
| 參數 | 值 |
|---|---|
| 服務名稱 | opensearch |
| 演算法 | AWS4-HMAC-SHA256 |
| 已簽署的標頭 | host,至少 |
| 預先簽章的 URL 過期 | 建議不超過 300 秒 |
Signature 第 4 版服務名稱為 opensearch。使用 es或 簽署aoss會導致請求失敗。
組態摘要
下表列出每個組態層控制的內容。
| Layer | 組態 | 需要登入嗎? |
|---|---|---|
| IAM 政策 | opensearch:ApplicationAccessAll 應用程式 ARN 上的 |
是 |
| IAM 政策 | es:GetApplication 應用程式 ARN 上的 |
僅適用於從 開啟應用程式 AWS 管理主控台 |
| 應用程式組態 | opensearchDashboards.dashboardAdmin.users |
否 - 它僅控制管理員功能 |
IAM 身分驗證疑難排解
IAM 身分驗證問題通常來自缺少政策動作、瀏覽器外部使用的預先簽章 URL,或以錯誤的服務名稱簽署的請求。下表列出常見的症狀、可能的原因,以及如何解決每個症狀。
| 徵狀 | 可能原因 | Resolution |
|---|---|---|
403 Forbidden 當您開啟應用程式 URL 時 |
缺少opensearch:ApplicationAccessAll許可 |
從步驟 1 新增 IAM 政策 |
403 含有您無權執行的訊息 es:GetApplication |
缺少主控台許可 | 在應用程式 ARN es:GetApplication上新增 。這僅適用於 AWS 管理主控台 存取 |
400 Bad Request 在 /_login/ 上使用 curl |
/_login/ 端點只能在瀏覽器中運作 |
在 上使用簽章第 4 版標頭身分驗證/進行程式設計存取 |
預先簽章的 URL 會傳回 SignatureDoesNotMatch |
Signature 第 4 版服務名稱錯誤 | 使用 簽署請求opensearch,而非 es或 aoss |
| 您可以開啟應用程式,但缺少管理員功能 | 未設定儀表板管理員 | update-application 使用 執行opensearchDashboards.dashboardAdmin.users,如步驟 2 所述 |
| 預先簽章的 URL 已過期 | URL 的產生時間早於 300 秒 | 產生新的預先簽章 URL。預先簽章URLs 是短期的 |
如需 OpenSearch UI 使用之 IAM 動作的詳細資訊,請參閱 OpenSearch UI 的 IAM 政策參考。