View a markdown version of this page

IAM-Authentifizierung für OpenSearch UI - Amazon OpenSearch Bedienung

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

IAM-Authentifizierung für OpenSearch UI

In diesem Thema werden die IAM-Mindestberechtigungen behandelt, die für den Zugriff auf Folgendes erforderlich sind OpenSearch UI-Anwendung, die die IAM-Authentifizierung verwendet, ohne AWS IAM Identity Center. Nachdem Sie diese Schritte ausgeführt haben, kann sich eine IAM-Rolle bei der Anwendung anmelden und deren Datenquellen abfragen.

Voraussetzungen

Schritt 1: Erteilen Sie die IAM-Berechtigung

Die folgende IAM-Richtlinie gewährt Zugriff auf die Anwendungsschnittstelle. Hängen Sie sie der IAM-Rolle an, die Zugriff benötigt, und ersetzen Sie die Platzhalterwerte durch Ihre eigenen Informationen:

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

Wenn Sie die Ressource auf eine einzige Anwendungs-ID beschränken, erhalten Sie die geringste Berechtigung, die die Rolle benötigt. Um stattdessen Zugriff auf alle Anwendungen im Konto und in der Region zu gewähren, verwenden Sie einen Platzhalter:

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

Sie können dieselbe Richtlinie an das anhängen 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}}" }] }'
Anmerkung

Die Aktion, die den Zugriff auf die Anwendungsoberfläche gewährt, ist opensearch:ApplicationAccessAll. Weitere Informationen zu den Berechtigungen, die eine Anwendung benötigt, finden Sie unter IAM-Richtlinienreferenz für OpenSearch UI.

Wenn Ihre Benutzer die Anwendung auch von der aus öffnen AWS-Managementkonsole, fügen Sie die folgende Anweisung hinzu, damit sie die Anwendung in der Konsole sehen können:

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

Schritt 2: Konfigurieren Sie den Dashboard-Administrator

Legen Sie fest, welche IAM-Prinzipale Administratorrechte erhalten OpenSearch UI. Führen Sie den folgenden Befehl aus, um allen authentifizierten Benutzern Administratorrechte zu gewähren:

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

Um Administratorrechte für eine einzelne Rolle zu gewähren, geben Sie den Rollen-ARN an:

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

Die Dashboard-Administratoreinstellung steuert Administratorfunktionen innerhalb der Benutzeroberfläche, wie z. B. die Verwaltung von Indexmustern und gespeicherte Objekte. Sie benötigen sie nicht, um sich anzumelden — die IAM-Richtlinie in Schritt 1 reicht aus, um auf die Anwendung zuzugreifen.

Schritt 3: Überprüfen des Zugriffs

Sie können den Zugriff über einen Browser mit einer vorsignierten URL oder programmgesteuert mit Signature Version 4-Anforderungsheadern überprüfen.

Überprüfen Sie den Zugriff über einen Browser

Das folgende Python-Codebeispiel generiert eine vorsignierte Signature-URL der Version 4, die Sie in einem Browser öffnen:

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
Anmerkung

Die /_login/ Die vorsignierte URL funktioniert nur in einem Browser. Es funktioniert nicht mit curl oder andere HTTP-Clients.

Überprüfen Sie den Zugriff programmgesteuert

Das folgende Python-Codebeispiel signiert eine Anforderung an den Anwendungsendpunkt mit Signature Version 4-Headern:

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)

Eine erfolgreiche Anfrage wird zurückgegeben HTTP/1.1 302 Found mit einem location Kopfzeile von /app/workspace_initial. Eine Anfrage, die zurückkehrt HTTP/1.1 403 Forbidden weist auf ein Problem mit der IAM-Richtlinie hin.

Signaturdetails für Version 4

In der folgenden Tabelle sind die Signature Version 4-Parameter aufgeführt, die OpenSearch Ich erwarte.

Parameter Wert
Service-Name opensearch
Algorithmus AWS4-HMAC-SHA256
Signierte Header host, mindestens
Ablauf der vorsignierten URL Es wird nicht mehr als 300 Sekunden empfohlen
Wichtig

Der Name des Signature Version 4-Dienstes lautet opensearch. Unterschreiben mit es oder aoss führt dazu, dass die Anfrage fehlschlägt.

Konfigurationsübersicht

In der folgenden Tabelle ist aufgeführt, was die einzelnen Konfigurationsebenen steuern.

Ebene Konfiguration Erforderlich, um sich anzumelden?
IAM-Richtlinie opensearch:ApplicationAccessAll auf der Anwendung ARN Ja
IAM-Richtlinie es:GetApplication auf der Anwendung ARN Nur um die Anwendung von der aus zu öffnen AWS-Managementkonsole
Konfiguration der Anwendung opensearchDashboards.dashboardAdmin.users Nein — es steuert nur Administratorfunktionen

Problembehandlung bei der IAM-Authentifizierung

IAM-Authentifizierungsprobleme sind in der Regel auf eine fehlende Richtlinienaktion, eine vorsignierte URL, die außerhalb eines Browsers verwendet wird, oder auf eine Anfrage zurückzuführen, die mit dem falschen Dienstnamen signiert wurde. In der folgenden Tabelle sind häufig auftretende Symptome, ihre wahrscheinlichen Ursachen und Lösungsmöglichkeiten aufgeführt.

Symptom Wahrscheinliche Ursache Auflösung
403 Forbidden wenn Sie die Anwendungs-URL öffnen Die opensearch:ApplicationAccessAll Die Erlaubnis fehlt Fügen Sie die IAM-Richtlinie aus Schritt 1 hinzu
403 mit einer Meldung, zu deren Ausführung Sie nicht berechtigt sind es:GetApplication Die Konsolenberechtigung fehlt Hinzufügen es:GetApplication auf der Anwendungs-ARN. Dies ist nur erforderlich für AWS-Managementkonsole Zugriff
400 Bad Request auf /_login/ mit curl Das /_login/ Endpunkt funktioniert nur in einem Browser Verwenden Sie die Signature Version 4-Header-Authentifizierung auf / für programmatischen Zugriff
Die vorsignierte URL wird zurückgegeben SignatureDoesNotMatch Der Signature Version 4-Dienstname ist falsch Unterschreiben Sie die Anfrage mit opensearch, nicht es oder aoss
Sie können die Anwendung öffnen, aber Administratorfunktionen fehlen Der Dashboard-Administrator ist nicht konfiguriert Führen Sie aus update-application mit opensearchDashboards.dashboardAdmin.users, wie in Schritt 2 beschrieben
Die vorsignierte URL ist abgelaufen Die URL wurde vor mehr als 300 Sekunden generiert Generieren Sie eine neue vorsignierte URL. Vorsignierte URLs sind kurzlebig

Weitere Informationen zu den IAM-Aktionen finden Sie unter OpenSearch Benutzeroberflächenverwendungen finden Sie unter IAM-Richtlinienreferenz für OpenSearch UI.