View a markdown version of this page

Authentification IAM pour OpenSearch UI - Amazon OpenSearch Service

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Authentification IAM pour OpenSearch UI

Cette rubrique décrit les autorisations IAM minimales requises pour accéder à OpenSearch Application d'interface utilisateur qui utilise l'authentification IAM, sans AWS IAM Identity Center. Une fois ces étapes terminées, un rôle IAM peut se connecter à l'application et interroger ses sources de données.

Conditions préalables

Étape 1 : accorder l'autorisation IAM

La politique IAM suivante autorise l'accès à l'interface de l'application. Attachez-le au rôle IAM qui doit y accéder et remplacez les valeurs des espaces réservés par vos propres informations :

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

Le fait de limiter la ressource à un identifiant d'application unique confère le minimum de privilèges dont le rôle a besoin. Pour accorder l'accès à toutes les applications du compte et de la région, utilisez plutôt un caractère générique :

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

Vous pouvez joindre la même politique au 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}}" }] }'
Note

L'action qui autorise l'accès à l'interface de l'application est opensearch:ApplicationAccessAll. Pour plus d'informations sur les autorisations requises par une application, consultez Référence de politique IAM pour OpenSearch UI.

Si vos utilisateurs ouvrent également l'application depuis Console de gestion AWS, ajoutez l'instruction suivante afin qu'ils puissent visualiser l'application dans la console :

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

Étape 2 : Configuration de l'administrateur du tableau de bord

Définissez les principaux administrateurs IAM qui reçoivent des privilèges d'administrateur OpenSearch UI. Pour accorder des privilèges d'administrateur à tous les utilisateurs authentifiés, exécutez la commande suivante :

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

Pour accorder des privilèges d'administrateur à un seul rôle, spécifiez l'ARN du rôle :

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

Le paramètre administrateur du tableau de bord contrôle les fonctionnalités de l'administrateur au sein de l'interface, telles que la gestion des modèles d'index et les objets enregistrés. Vous n'en avez pas besoin pour vous connecter : la politique IAM de l'étape 1 est suffisante pour accéder à l'application.

Étape 3 : Vérifier l'accès

Vous pouvez vérifier l'accès à partir d'un navigateur à l'aide d'une URL présignée ou par programmation à l'aide des en-têtes de demande Signature Version 4.

Vérifier l'accès depuis un navigateur

L'exemple de code Python suivant génère une URL présignée Signature Version 4 que vous ouvrez dans un navigateur :

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
Note

Le /_login/ L'URL présignée ne fonctionne que dans un navigateur. Cela ne fonctionne pas avec curl ou d'autres clients HTTP.

Vérifier l'accès par programmation

L'exemple de code Python suivant signe une demande au point de terminaison de l'application avec les en-têtes Signature Version 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)

Une demande réussie est renvoyée HTTP/1.1 302 Found avec un location en-tête de /app/workspace_initial. Une demande qui renvoie HTTP/1.1 403 Forbidden indique un problème lié à la politique IAM.

Détails de signature de la version 4 de Signature

Le tableau suivant répertorie les paramètres de Signature Version 4 qui OpenSearch Je m'y attends.

Paramètre Value
Nom du service opensearch
Algorithme AWS4-HMAC-SHA256
En-têtes signés host, au minimum
Expiration de l'URL présignée Il est recommandé de ne pas dépasser 300 secondes
Important

Le nom du service Signature Version 4 est opensearch. Signer avec es ou aoss entraîne l'échec de la demande.

Récapitulatif de configuration

Le tableau suivant répertorie ce que chaque couche de configuration contrôle.

Couche Configuration Vous êtes obligé de vous connecter ?
Politique IAM opensearch:ApplicationAccessAll sur l'application ARN Oui
Politique IAM es:GetApplication sur l'application ARN Pour ouvrir l'application uniquement depuis le Console de gestion AWS
Configuration de l’application opensearchDashboards.dashboardAdmin.users Non, il contrôle uniquement les fonctionnalités d'administration

Résolution des problèmes liés à l'authentification IAM

Les problèmes d'authentification IAM proviennent généralement d'une action stratégique manquante, d'une URL présignée utilisée en dehors d'un navigateur ou d'une demande signée avec un nom de service incorrect. Le tableau suivant répertorie les symptômes courants, leurs causes probables et les moyens de les résoudre.

Symptôme Cause probable Résolution
403 Forbidden lorsque vous ouvrez l'URL de l'application Le opensearch:ApplicationAccessAll l'autorisation est manquante Ajoutez la politique IAM à partir de l'étape 1
403 avec un message que vous n'êtes pas autorisé à exécuter es:GetApplication L'autorisation de la console est manquante Ajouter es:GetApplication sur l'ARN de l'application. Ceci n'est requis que pour Console de gestion AWS accès
400 Bad Request sur /_login/ avec curl Le /_login/ endpoint ne fonctionne que dans un navigateur Utiliser l'authentification d'en-tête Signature Version 4 sur / pour un accès programmatique
L'URL présignée renvoie SignatureDoesNotMatch Le nom du service Signature Version 4 est incorrect Signez la demande avec opensearch, pas es ou aoss
Vous pouvez ouvrir l'application mais les fonctionnalités d'administrateur sont manquantes L'administrateur du tableau de bord n'est pas configuré Courez update-application avec opensearchDashboards.dashboardAdmin.users, comme décrit à l'étape 2
L'URL présignée a expiré L'URL a été générée plus de 300 secondes plus tôt Générez une nouvelle URL présignée. Les URL présignées sont de courte durée

Pour plus d'informations sur les actions IAM qui OpenSearch Utilisations de l'interface utilisateur, voir Référence de politique IAM pour OpenSearch UI.