

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# OpenSearch UI の IAM 認証

このトピックでは、IAM 認証を使用する OpenSearch UI アプリケーションにアクセスするために必要な最小限の IAM アクセス許可について説明します AWS IAM アイデンティティセンター。これらのステップを完了すると、IAM ロールはアプリケーションにサインインし、そのデータソースをクエリできます。

## 前提条件
<a name="application-auth-iam-prerequisites"></a>
+ IAM 認証で作成された OpenSearch UI アプリケーション。アプリケーションの作成手順については、「」を参照してください[Amazon OpenSearch Service における OpenSearch ユーザーインターフェースの開始方法](application-getting-started.md)。
+ アプリケーションにアクセスする必要がある IAM ロール。
+ 認証情報で AWS CLI 設定された 。

## ステップ 1: IAM アクセス許可を付与する
<a name="application-auth-iam-grant"></a>

次の 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 ポリシーリファレンス](application-iam-policy-reference.md)。

ユーザーが からアプリケーションも開く場合は AWS マネジメントコンソール、コンソールでアプリケーションを表示できるように、次のステートメントを追加します。

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

## ステップ 2: ダッシュボード管理者を設定する
<a name="application-auth-iam-admin"></a>

OpenSearch UI 内で管理者権限を受け取る IAM プリンシパルを設定します。認証されたすべてのユーザーに管理者権限を付与するには、次のコマンドを実行します。

```
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: アクセスを確認する
<a name="application-auth-iam-verify"></a>

署名付き URL を使用してブラウザから、または署名バージョン 4 リクエストヘッダーを使用してプログラムでアクセスを確認できます。

### ブラウザからのアクセスを確認する
<a name="application-auth-iam-verify-browser"></a>

次の 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 クライアントでは機能しません。

### プログラムによるアクセスの検証
<a name="application-auth-iam-verify-programmatic"></a>

次の 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)
```

成功したリクエストは、`location`ヘッダーが `HTTP/1.1 302 Found`の を返します`/app/workspace_initial`。が返すリクエストは、IAM ポリシーの問題`HTTP/1.1 403 Forbidden`を示します。

## 署名バージョン 4 の署名の詳細
<a name="application-auth-iam-sigv4"></a>

次の表に、OpenSearch UI が想定する署名バージョン 4 のパラメータを示します。


| パラメータ | 値 | 
| --- | --- | 
| サービス名 | opensearch | 
| アルゴリズム | AWS4-HMAC-SHA256 | 
| 署名付きヘッダー | host、少なくとも | 
| 署名付き URL の有効期限 | 推奨時間は 300 秒以下 | 

**重要**  
署名バージョン 4 のサービス名は です`opensearch`。`es` または で署名すると`aoss`、リクエストは失敗します。

## 構成の概要
<a name="application-auth-iam-summary"></a>

次の表に、各設定レイヤーが制御する内容を示します。


| レイヤー | 設定 | サインインに必要ですか? | 
| --- | --- | --- | 
| IAM ポリシー | opensearch:ApplicationAccessAll アプリケーション ARN の | はい | 
| IAM ポリシー | es:GetApplication アプリケーション ARN の | からアプリケーションを開く場合のみ AWS マネジメントコンソール | 
| アプリケーションの設定 | opensearchDashboards.dashboardAdmin.users | いいえ — 管理者機能のみを制御します | 

## IAM 認証のトラブルシューティング
<a name="application-auth-iam-troubleshooting"></a>

IAM 認証の問題は通常、欠落しているポリシーアクション、ブラウザの外部で使用される署名付き URL、または間違ったサービス名で署名されたリクエストが原因です。次の表に、一般的な症状、考えられる原因、およびそれぞれの解決方法を示します。


| 症状 | 考えられる原因 | 解決策 | 
| --- | --- | --- | 
| 403 Forbidden アプリケーション URL を開くとき | アクセスopensearch:ApplicationAccessAll許可がありません | ステップ 1 の IAM ポリシーを追加する | 
| 403 を実行する権限がないというメッセージが表示される es:GetApplication | コンソールのアクセス許可がありません | アプリケーション ARN es:GetApplicationに を追加します。これは AWS マネジメントコンソール アクセスにのみ必要です | 
| 400 Bad Request /\_login/を使用した の curl | /\_login/ エンドポイントはブラウザでのみ機能します | プログラムによるアクセス/のために で署名バージョン 4 ヘッダー認証を使用する | 
| 署名付き URL は を返します。 SignatureDoesNotMatch | 署名バージョン 4 のサービス名が正しくありません | es または ではなく opensearchでリクエストに署名する aoss | 
| アプリケーションを開くことはできますが、管理者機能がありません | ダッシュボード管理者が設定されていない | ステップ 2 で説明されているようにopensearchDashboards.dashboardAdmin.users、 update-applicationで を実行します。 | 
| 署名付き URL の有効期限が切れています | URL が 300 秒以上前に生成された | 新しい署名付き URL を生成します。署名付き URLsが短い | 

OpenSearch UI が使用する IAM アクションの詳細については、「」を参照してください[OpenSearch UI の IAM ポリシーリファレンス](application-iam-policy-reference.md)。