Konfigurieren Sie HMAC – Token-basierte Authentifizierung

Konfigurieren Sie HMAC, um die Authentifizierung für REST-API-Endpunkte zu unterstützen.

Vorbereitungen

Erforderliche Rolle: Administrator

Plugin erforderlich: 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-Konfigurationan.
   2. Wählen Sie Neu.
      Hinweis:

      Sie können auch verwenden Standard-HMAC SHA256 Base64-Codierung Wird bei der Installation des Plugins erstellt.
   3. Füllen Sie im Formular die 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-Dienstskript Verwenden Sie diese Skripteinbindungs-Util, um den übergebenen Zeitstempel und den Anforderungstext zu interpretieren. Für jedes gemeinsam genutzte Geheimnis, das in erstellt wurde ServiceNow®Instanz ist eine Schlüssel-ID vorhanden. Sie müssen die Schlüssel-ID als Standardschlüssel-ID im HMAC-Authentifizierungsprofil konfigurieren.

      
   4. Übermitteln Sie den Datensatz.
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 Nachricht an Welche Art von Authentifizierungsprofil?
   3. Wählen Sie Aus Erstellen Sie HMAC-Authentifizierungsprofile .
      
   4. Füllen Sie im Formular die Felder 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 Authentifizierungsparameter für die Authentifizierungsanforderung aus. Sie können die Standardoptionen auswählen oder einen neuen Authentifizierungsparameter erstellen: X-sn-hmac-Signature-256: Authentifizierungsheader 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 Authentifizierungsheaders oder des Abfrageparameters definiert werden.
   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 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. Schlüssel-ID wird nach dem Senden des Formulars generiert.
      Gemeinsames Geheimnis	Freigegebene Geheimnisse des Anwenders. Beispiel: Das Passwort.
      Quelle	Quelle des Datensatzes.
      Ablauf	Zeit, nach der 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 wird bereinigt.

   4. Bestätigen Sie das Formular.
   5. Öffnen Sie den erstellten Datensatz.

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

      

      Hinweis:

      Sie können die Schlüssel-ID, die während der Schlüssel-ID generiert wurde, dem Authentifizierungsprofil hinzufügen, das für HMAC erstellt wurde, wenn Sie den Authentifizierungs- oder Abfrageparameter 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 im Formular die Felder 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: Jetzt/Anhang .
      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 einzelne Richtlinien 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: Token-basierte 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.
      
   5. Bestätigen Sie das Formular.
      Sie können den REST-API-Aufruf senden:

      • Mit der x-sn-hmac-Signature-256, die von generiert wurde ServiceNow®Während der API-Schlüsselerstellung innerhalb des Headers- oder Abfrageparameters basierend auf der Konfiguration für die Authentifizierung.
      • Mit Voranforderungsskript mit gemeinsam verwendetem Geheimnis, das als Teil der Anforderung angegeben ist.

      Warnung:

      Verwenden VERÖFFENTLICHEN Anforderung, wenn vertrauliche Informationen an den Server übermittelt werden.