Cloud-native API Gateway utilise des consommateurs pour activer l'authentification des routes et des API. Vous pouvez créer, désactiver et supprimer des consommateurs dans la console.
Créer un consommateur
Cloud-native API Gateway propose trois méthodes d'authentification.
|
Méthode |
Description |
Cas d'utilisation |
|
API key |
Le client ajoute des identifiants à la requête. La passerelle valide leur légitimité et leurs autorisations. Cette méthode est moins sécurisée que JWT ou AK/SK. Protégez soigneusement vos identifiants. |
Scénarios légers nécessitant une intégration rapide et présentant de faibles exigences en matière de sécurité. |
|
JWT |
JWT est une norme permettant de transmettre des informations de manière sécurisée entre un client et un serveur à l'aide de signatures HMAC, RSA ou ECDSA. Utilisez JWT pour la vérification d'identité et le contrôle d'accès dans la passerelle. |
Adapté aux systèmes distribués et aux scénarios SSO. |
|
HMAC |
Le client utilise une paire AK/SK pour signer le contenu de la requête avec l'algorithme HMAC, puis envoie la signature à la passerelle pour validation. |
Scénarios exigeant une haute intégrité des données et une protection contre la falsification. |
Créer un consommateur avec authentification par clé API
Accédez à la page Consommateurs dans la console Cloud-native API Gateway et sélectionnez une région.
-
Cliquez sur Create a consumer. Dans le panneau Create Consumer, définissez Consumer Name, sélectionnez API Key comme méthode d'authentification, puis effectuez les configurations suivantes :
-
Generation Method :
System Generated : le système génère automatiquement une clé API pour vous.
Custom : spécifiez une clé API personnalisée et sa source.
Credential : la clé API personnalisée.
-
Credential Source :
L'emplacement dans la requête à partir duquel la passerelle récupère la clé API :
Authorization: Bearer <token> (format de jeton standard)
Custom HTTP Header (par exemple
X-API-Key: your-key)Custom Query Parameter (par exemple
?apikey=your-key)
-
Créer un consommateur avec authentification JWT
Accédez à la page Consommateurs dans la console Cloud-native API Gateway et sélectionnez une région.
-
Cliquez sur Create a consumer. Dans le panneau Create Consumer, définissez Consumer Name, sélectionnez JSON Web Token (JWT) comme méthode d'authentification, puis effectuez les configurations suivantes :
-
Creation Method :
Local Configuration : utilisez cette option lorsque le service d'authentification et la passerelle se trouvent dans le même cluster ou réseau local, que les exigences de performance sont élevées et que les clés changent rarement.
Remote Fetch : utilisez cette option avec un center d'identité unifié tel qu'OAuth2 ou OpenID Connect. Prend en charge les mises à jour dynamiques des clés. Idéal pour les environnements multi-locataires ou de production.
-
Key Type (non requis pour Remote Fetch) :
Symmetric Key : génère une configuration JWKS par défaut unique pour chaque consommateur, contenant la clé pour le chiffrement et le déchiffrement des jetons.
Asymmetric Key : fournissez une configuration JWKS complète et utilisez une clé privée pour chiffrer le jeton. La passerelle déchiffre à l'aide de la clé publique contenue dans le JWKS.
-
JWKS :
Si vous sélectionnez Local Configuration, configurez le JWKS selon la spécification JSON Web Key (JWK).
-
Si vous sélectionnez Remote Fetch, saisissez l'URL. Le système analyse automatiquement le numéro de port, le délai d'expiration et la durée de mise en cache à partir de l'URL.
ImportantL'URL doit être un nom de domaine, et non une adresse IP.
-
JWT Token : définissez la configuration du jeton JWT.
Type : type du paramètre de jeton. La valeur par défaut est Header.
Key : nom du paramètre de jeton.
Prefix : préfixe du paramètre de jeton. Par défaut, l'en-tête Authorization utilise le préfixe Bearer, par exemple Authorization: Bearer token.
Enable Passthrough : transmet le paramètre de jeton au service backend.
-
Consumer ID in JWT Payload : paire clé-valeur dans la charge utile JWT qui identifie le consommateur. Par défaut,
uidavec une valeur de chaîne aléatoire. Personnalisable. Exemple de charge utile :{ "uid": "11215ac069234abcb8944232b79ae711" }
-
Créer un consommateur avec authentification HMAC
Accédez à la page Consommateurs dans la console Cloud-native API Gateway et sélectionnez une région.
-
Cliquez sur Create a consumer. Dans le panneau Create Consumer, définissez Consumer Name, sélectionnez Hash-based Message Authentication Code (HMAC) comme méthode d'authentification, puis effectuez les configurations suivantes :
System Generated : le système génère automatiquement la clé d'accès (AK) et la clé secrète (SK) pour vous.
Custom : spécifiez une AK et une SK personnalisées.
Désactiver un consommateur
Connectez-vous à la console API Gateway.
Dans le volet de navigation de gauche, cliquez sur Consumers. Dans la barre de navigation supérieure, sélectionnez une région.
Sur la page Consumers, recherchez le consommateur cible, cliquez sur Disable dans la colonne Actions, puis cliquez sur OK pour confirmer.
Supprimer un consommateur
Connectez-vous à la console API Gateway.
Dans le volet de navigation de gauche, cliquez sur Consumers. Dans la barre de navigation supérieure, sélectionnez une région.
Sur la page Consumers, recherchez le consommateur cible et cliquez sur Delete dans la colonne Actions. Dans la boîte de dialogue de confirmation, saisissez le nom du consommateur, puis cliquez sur Delete.