Konfigurieren Sie die tokenbasierte HMAC-Authentifizierung

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 3 Minuten Lesedauer

    • Konfigurieren Sie HMAC so, dass die Authentifizierung für REST-API-Endpunkte unterstützt wird.

    Vorbereitungen

    Erforderliche Rolle: admin

    Erforderliches Plugin: API-Schlüssel und HMAC-Authentifizierung (com.glide.tokenbased_auth)

    Prozedur

    1. Erstellen Sie eine HMAC-Konfiguration.
      1. Navigieren zu Alle > System-Webservices > API-Zugriffsrichtlinien > HMAC-Konfiguration.
      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 Hilfsskript für HMAC.
        HMAC-Konfiguration
      4. Senden Sie den Datensatz ab.
    2. Erstellen Sie ein eingehendes Authentifizierungsprofil.
      1. Navigieren zu Alle > System-Webservices > API-Zugriffsrichtlinien > Eingehende Authentifizierungsprofile.
      2. Wählen Sie Neu.
        Die Meldung Welche Art von Authentifizierungsprofil?wird angezeigt.
      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 Umfang der Authentifizierungsrichtlinie.
        Konfiguration für HMAC Wählen Sie die erstellte HMAC-Konfiguration aus.
        Auth-Parameter Wählen Sie den Auth-Parameter 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-Header
        Standardschlüssel-ID des gemeinsamen Geheimnisses Die Token-Informationen, 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 der Auth-Kopfzeile oder des Abfrageparameters definiert werden.HMAC-Profil
      5. Bestätigen Sie das Formular.
    3. Erstellen Sie einen HMAC-Geheimschlüssel.
      1. Navigieren zu Alle > System-Webservices > API-Zugriffsrichtlinien > REST-API-HMAC-Geheimnis.
      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 den REST-API-HMAC-Geheimschlüssel.
        Aktiv Status des REST-API-HMAC-Geheimnisses.
        Benutzer Benutzer, der dem REST-API-HMAC-Geheimnis zugeordnet ist. Verwenden Sie das Suchsymbol, um den Benutzer auszuwählen.
        Schlüssel-ID Schlüssel-ID, die als Teil des REST-Aufrufs gesendet werden muss. Schlüssel-ID wird nach dem Absenden des Formulars generiert.
        Gemeinsames Geheimnis Gemeinsame geheime Schlüssel des Benutzers. Zum Beispiel das Passwort.
        Quelle Quelle des Datensatzes.
      4. Bestätigen Sie das Formular.
      5. Öffnen Sie den erstellten Datensatz.

        Suchen Sie die Schlüssel-ID, die von Now Platform für den Benutzer generiert wurde

        .HMAC-Schlüssel-ID
        Hinweis:
        Sie können die Schlüssel-ID hinzufügen, die während der Schlüssel-ID im für HMAC erstellten Authentifizierungsprofil generiert wurde, wenn Sie den Parameter Auth oder Query für den API-Aufruf nicht angeben möchten.
    4. Erstellen Sie eine REST-API-Zugriffsrichtlinie.
      1. Navigieren zu Alle > System-Webservices > REST API-Zugriffsrichtlinien.
      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 Für die Interaktion mit der API verwendete Methode. 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 für die 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 senden:
        • Mit der x-sn-hmac-signature-256, die von ServiceNow® während der API-Schlüsselerstellung im Header- oder Abfrageparameter basierend auf der Konfiguration für die Authentifizierung generiert wurde.
        • Mit Vorab-Anforderungsskript, bei dem das gemeinsame Geheimnis als Teil der Anforderung angegeben ist.
        Warnung:
        Verwenden Sie die POST -Anforderung, wenn Sie vertrauliche Informationen an den Server senden.