Configurer HMAC : authentification basée sur les jetons

Configurez HMAC pour prendre en charge l’authentification pour les points de terminaison d’API REST.

Avant de commencer

Rôle requis : admin

Module d’extension requis : clé API et authentification HMAC (com.glide.tokenbased_auth)

Procédure

1. Créez une configuration HMAC.
   1. Accédez à la Tous > Services web du système > Politiques d'accès API > Configuration HMAC.
   2. Sélectionnez Nouveau.
      Remarque :

      Vous pouvez également utiliser le codage HMAC SHA256 Base64 par défaut qui est créé lors de l’installation du module d’extension.
   3. Renseignez les champs du formulaire :

      Tableau 1. Configuration HMAC

      Champ	Description
      Nom	Nom de la configuration HMAC.
      Application	Périmètre de la configuration.
      Description	Description détaillée de la configuration.
      Algorithme de hachage	Choisissez l’algorithme de hachage. Options disponibles : HmacSHA256 HmacSHA384 HmacSHA512
      Script d'utilitaire HMAC	Script d’utilitaire pour HMAC.

      
   4. Envoyez l'enregistrement.
2. Créez un profil d’authentification entrant.
   1. Accédez à la Tous > Services web du système > Politiques d'accès API > Profils d’authentification entrants.
   2. Sélectionnez Nouveau.
      Le système affiche le message Quel type de profil d’authentification ?
   3. Sélectionnez Créer des profils d’authentification HMAC.
      
   4. Renseignez les champs du formulaire.

      Tableau 2. Profils d’authentification HMAC

      Champ	Description
      Nom	Nom permettant d’identifier la politique d’authentification.
      Application	Périmètre de la politique d’authentification.
      Configuration pour HMAC	Sélectionnez la configuration HMAC qui a été créée.
      Paramètre d'authentification	Sélectionnez le paramètre d’authentification pour la demande d’authentification. Vous pouvez sélectionner les options par défaut ou créer un nouveau paramètre d’authentification : x-sn-hmac-signature-256 : en-tête d’authentification x-sn-hmac-signature-256 : en-tête du paramètre de requête
      ID de clé par défaut du secret partagé	Informations de jeton qui peuvent être mises à jour dans ce champ pour l’utilisation de HMAC.

      Remarque :

      L’option sélectionnée doit être définie dans l’appel REST dans le cadre de l’en-tête d’authentification ou du paramètre de requête.
   5. Envoyez le formulaire.
3. Créez un secret HMAC.
   1. Accédez à la Tous > Services web du système > Politiques d'accès API > Secret HMAC de l'API REST.
   2. Sélectionnez Nouveau.
   3. Renseignez les champs du formulaire :

      Tableau 3. Secret HMAC de l'API REST

      Champ	Description
      Nom	Nom permettant d’identifier le secret HMAC de l’API REST.
      Description	Description du secret HMAC de l’API REST.
      Actif	État du secret HMAC de l’API REST.
      Utilisateur	Utilisateur associé au secret HMAC de l’API REST. Utilisez l’icône de recherche pour sélectionner l’utilisateur.
      ID clé	ID de clé qui doit être envoyé dans le cadre de l’appel REST. L’ID de clé est généré après l’envoi du formulaire.
      Secret partagé	Secrets partagés de l’utilisateur. Par exemple, le mot de passe.
      Source	Source de l’enregistrement.

   4. Envoyez le formulaire.
   5. Ouvrez l’enregistrement qui a été créé.

      Rechercher l’ID de clé généré par le Now Platform pour l’utilisateur

      .

      Remarque :

      Vous pouvez ajouter l’ID de clé qui a été généré pendant l’ID de clé dans le profil d’authentification qui a été créé pour HMAC si vous ne souhaitez pas spécifier le paramètre Auth ou Query pour l’appel d’API.
4. Créez une politique d’accès aux REST APIs.
   1. Accédez à la Tous > Services web du système > Politiques d'accès REST API.
   2. Sélectionnez Nouveau.
   3. Renseignez les champs du formulaire.

      Tableau 4. Politiques d'accès API

      Champ	Description
      Nom	Nom unique de la politique d’accès de l’API.
      Actif	Option permettant d’activer la politique d’accès API.
      API REST	L’API REST à laquelle la politique d’accès est appliquée. Par exemple, API de pièce jointe.
      CHEMIN REST API	Chemin d’accès de l’API de REST. Ce champ est automatiquement renseigné en fonction de l’API REST sélectionnée. Par exemple, now/attachment.
      Méthode HTTP	Méthode utilisée pour interagir avec l’API. Ce champ est automatiquement renseigné en fonction de l’API REST sélectionnée.
      Version	Version de l'API. Par exemple, v1. Ce champ est automatiquement renseigné en fonction de l’API REST sélectionnée. Remarque : Si vous souhaitez créer une politique d’authentification pour toutes les versions d’une REST API, vous devez créer des politiques individuelles pour chaque version.
      Ressources	Ressource enfant de l’API REST. Ce champ est automatiquement renseigné en fonction de l’API REST sélectionnée. Par exemple, /now/attachment
      Application	Périmètre de l'application.
      Global	Activez ce champ pour appliquer la politique d’authentification à toutes les méthodes, versions et ressources de l’API. Remarque : L’authentification basée sur le jeton n’est pas autorisée dans la politique API REST globale.
      Appliquer à toutes les méthodes	Activez ce champ pour appliquer la politique d’authentification de l’API à l’ensemble des méthodes, versions et ressources de l’API.
      Appliquer à toutes les ressources	Activez ce champ pour appliquer la politique d’authentification de l’API à toutes les versions.
      Appliquer à toutes les versions	Activez ce champ pour appliquer la politique d’authentification de l’API à toutes les ressources.

   4. Ajoutez le profil d’authentification d’API qui a été créé.
      
   5. Envoyez le formulaire.
      Vous pouvez envoyer l’appel d’API REST :

      • Avec x-sn-hmac-signature-256 qui a été généré lors ServiceNow® de la création de la clé API dans le paramètre En-tête ou Requête en fonction de la configuration pour l’authentification.
      • Avec script de pré-demande avec secret partagé spécifié dans le cadre de la demande.

      Avertissement :

      Utilisez la demande POST lors de l’envoi d’informations sensibles au serveur.