HMAC konfigurieren – Tokenbasierte Authentifizierung

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 3 Minuten Lesedauer

    • Konfigurieren Sie HMAC für die Unterstützung der Authentifizierung für REST API-Endpunkte.

    Vorbereitungen

    Erforderliche Rolle: admin

    Erforderliches Plugin: API Key und HMAC-Authentifizierung (com.glide.tokenbased_auth)

    Prozedur

    1. Erstellen Sie eine HMAC-Konfiguration.
      1. Navigieren zu Alle > System-Webservices > API-Zugriffsrichtlinien > HMAC-Konfigurationan.
      2. Wählen Sie Neu.
        Hinweis:
        Sie können auch die standardmäßige HMAC-SHA256-Base64-Codierung verwenden, die bei der Installation des Plugins erstellt wird.
      3. Füllen Sie im Formular die folgenden Felder aus:
        Tabelle : 1. HMAC-Konfiguration
        Feld Beschreibung
        Name Name für die HMAC-Konfiguration.
        Anwendung Umfang der Konfiguration.
        Beschreibung Detaillierte Beschreibung der Konfiguration.
        Hash-Algorithmus Wählen Sie den Hash-Algorithmus aus. Verfügbare Optionen:
        • HmacSHA256
        • HmacSHA384
        • HmacSHA512
        HMAC-Hilfsskript Dienstprogrammskript für HMAC.
        Hinweis:
        Wenn Sie die HMAC-Authentifizierung mit Anforderungstext, Zeitstempel und Geheimnis ohne Schlüssel-ID validieren, gehen Sie wie folgt vor:
        • Erstellen Sie eine anwenderdefinierte Skripteinbindung als HMAC-Hilfsskript
        • Verwenden Sie dieses Skripteinbindungs-Dienstprogramm, um den übergebenen Zeitstempel und den Anforderungstext zu interpretieren.

        Für jedes in der Instanz ServiceNow® erstellte gemeinsame Geheimnis gibt es eine Schlüssel-ID. Sie müssen die Schlüssel-ID im HMAC-Authentifizierungsprofil als Standardschlüssel-ID konfigurieren.
        HMAC-Konfiguration
      4. Senden Sie den Datensatz ab.
    2. Erstellen Sie ein eingehendes Authentifizierungsprofil.
      1. Navigieren zu Alle > System-Webservices > API-Zugriffsrichtlinien > Eingehende Authentifizierungsprofilean.
      2. Wählen Sie Neu.
        Das System zeigt die Meldung Welche Art von Authentifizierungsprofil?
      3. Wählen Sie HMAC-Authentifizierungsprofile erstellen aus.
        HMAC-Authentifizierungsprofil
      4. Füllen Sie die Felder des Formulars aus.
        Tabelle : 2. HMAC-Authentifizierungsprofile
        Feld Beschreibung
        Name Name zur Identifizierung der Authentifizierungsrichtlinie.
        Anwendung Geltungsbereich der Authentifizierungsrichtlinie.
        Konfiguration für HMAC Wählen Sie die erstellte HMAC-Konfiguration aus.
        Auth-Parameter Wählen Sie den Authentifizierungsparameter für die Authentifizierungsanforderung aus. Sie können die Standardoptionen auswählen oder einen neuen Authentifizierungsparameter erstellen:
        • x-sn-hmac-signature-256: Auth-Header
        • x-sn-hmac-signature-256: Abfrageparameter
        Standardschlüssel-ID des gemeinsamen Geheimnisses Die Tokeninformationen, die in diesem Feld für die Verwendung von HMAC aktualisiert werden können.
        Hinweis:
        Die ausgewählte Option muss im REST-Aufruf als Teil des Auth-Headers oder Abfrageparameters definiert werden.HMAC-Profil
      5. Bestätigen Sie das Formular.
    3. Erstellen Sie ein HMAC-Geheimnis.
      1. Navigieren zu Alle > System-Webservices > API-Zugriffsrichtlinien > REST-API-HMAC-Geheimnisan.
      2. Wählen Sie Neu.
      3. Füllen Sie im Formular die folgenden Felder aus:
        Tabelle : 3. REST-API-HMAC-Geheimnis
        Feld Beschreibung
        Name Name zur Identifizierung des REST API-HMAC-Geheimnisses.
        Beschreibung Beschreibung für das REST API-HMAC-Geheimnis.
        Aktiv Status des REST API-HMAC-Geheimnisses.
        Anwender Anwender, der dem REST API-HMAC-Geheimnis zugeordnet ist. Verwenden Sie das Suchsymbol, um den Anwender auszuwählen.
        Schlüssel-ID Schlüssel-ID, die als Teil des REST-Aufrufs gesendet werden muss. Die Schlüssel-ID wird nach dem Senden des Formulars generiert.
        Gemeinsames Geheimnis Gemeinsame Geheimnisse des Anwenders. Zum Beispiel das Passwort.
        Quelle Quelle des Datensatzes.
        Ablauf Zeitpunkt, nach dem die Anmeldeinformationen nicht mehr gültig sind. Ein leerer Wert bedeutet keinen Ablauf.
        Hinweis:
        Weitere Informationen zum Ablauf des Tokens finden Sie unter Token-Ablauf bereinigen.
      4. Bestätigen Sie das Formular.
      5. Öffnen Sie den erstellten Datensatz.

        Suchen Sie die von Now Platform für den Anwender generierte Schlüssel-ID.

        HMAC-Schlüssel-ID
        Hinweis:
        Sie können die Schlüssel-ID hinzufügen, die während der Schlüssel-ID in dem für HMAC erstellten Authentifizierungsprofil generiert wurde, wenn Sie den Auth- oder Query-Parameter für den API-Aufruf nicht angeben möchten.
    4. Erstellen Sie eine REST-API-Zugriffsrichtlinie.
      1. Navigieren zu Alle > System-Webservices > REST API-Zugriffsrichtlinienan.
      2. Wählen Sie Neu.
      3. Füllen Sie die Felder des Formulars aus.
        Tabelle : 4. API-Zugriffsrichtlinien
        Feld Beschreibung
        Name Eindeutiger Name der API-Zugriffsrichtlinie.
        Aktiv Option zum Aktivieren der API-Zugriffsrichtlinie.
        REST-API Die REST API, auf die die Zugriffsrichtlinie angewendet wird. Beispiel: Anhang-API.
        REST-API-PFAD API-Pfad der REST API. Dieses Feld wird basierend auf der ausgewählten REST API automatisch ausgefüllt. Beispiel: now/attachment.
        HTTP-Methode Methode für die Interaktion mit der API. Dieses Feld wird basierend auf der ausgewählten REST API automatisch ausgefüllt.
        Version Version der API. Beispiel: v1. Dieses Feld wird basierend auf der ausgewählten REST API automatisch ausgefüllt.
        Hinweis:
        Wenn Sie eine Authentifizierungsrichtlinie für alle Versionen einer REST API erstellen möchten, müssen Sie für jede Version eine eigene Richtlinie erstellen.
        Ressource Untergeordnete Ressource der REST API. Dieses Feld wird basierend auf der ausgewählten REST API automatisch ausgefüllt. Beispiel: /now/attachment
        Anwendung Umfang der Anwendung.
        Global Aktivieren Sie dieses Feld, um die Authentifizierungsrichtlinie auf alle Methoden, Versionen und Ressourcen der API anzuwenden.
        Hinweis:
        Tokenbasierte Authentifizierung ist in der globalen REST-API-Richtlinie nicht zulässig.
        Auf alle Methoden anwenden Aktivieren Sie dieses Feld, um die Authentifizierungsrichtlinie für die API auf alle Methoden, Versionen und Ressourcen für die API anzuwenden.
        Auf alle Ressourcen anwenden Aktivieren Sie dieses Feld, um die Authentifizierungsrichtlinie für die API auf alle Versionen anzuwenden.
        Auf alle Versionen anwenden Aktivieren Sie dieses Feld, um die Authentifizierungsrichtlinie für die API auf alle Ressourcen anzuwenden.
      4. Fügen Sie das erstellte API-Authentifizierungsprofil hinzu.
        HMAC-Profil wurde der Zugriffsrichtlinie hinzugefügt
      5. Bestätigen Sie das Formular.
        Sie können den REST-API-Aufruf wie folgt senden:
        • Mit x-sn-hmac-signature-256, die von ServiceNow® während der Erstellung des API-Schlüssels im Header- oder Abfrageparameter basierend auf der Konfiguration für die Authentifizierung generiert wurde.
        • Mit Voranforderungsskript und gemeinsamem Geheimnis, das als Teil der Anforderung angegeben ist.
        Warnung:
        Verwenden Sie die POST -Anforderung, wenn Sie vertrauliche Informationen an den Server übermitteln.