Liste de contrôle de mise en production des clés API
Les vérifications à faire avant de brancher une clé API sur un serveur de production.
GuideDéveloppeur
- Durée
- 15 min
Passez cette liste en revue pour chaque clé de production, à sa mise en service puis à chaque rotation.
Périmètre de la clé
- La clé est une clé technique, rattachée à la bonne application, au bon client et à l'environnement
prod. - Son profil ne porte que les droits des opérations réellement appelées.
- Son niveau d'administration est le minimum exigé par ces opérations.
- Une clé distincte existe pour chaque usage et pour chaque environnement : aucune clé
devoustagingen production, et inversement. - Le profil de la clé porte les droits voulus dans la matrice profils × droits de production : les droits d'une clé se lisent dans la matrice de son environnement.
Restrictions
- Si vos serveurs ont des adresses de sortie fixes, la liste des adresses IP autorisées est renseignée (adresses IPv4 exactes, blocs
/24ou/16). - La clé a une date d'expiration, et un rappel est programmé au moins deux semaines avant.
Stockage
- La clé est rangée dans un secret (secret d'environnement Wakastart ou gestionnaire de secrets), jamais dans le code, une image ou un fichier versionné.
- Seul le serveur qui en a besoin y a accès ; elle n'est jamais envoyée à un navigateur ni à une application mobile.
- Les journaux ne contiennent jamais la clé complète.
Code
- Les requêtes envoient
x-api-keysans en-têteAuthorization. - Un
401« Cle API utilisateur invalide ou expiree » déclenche une alerte, pas une boucle de nouvelles tentatives. - Un
429est suivi d'une nouvelle tentative différée, avec un délai croissant. - Les appels en volume restent sous les limites de débit par adresse IP : 10 requêtes par seconde, 100 par minute, 1 000 par heure.
Exploitation
- Le nom et le préfixe de la clé sont consignés avec son propriétaire technique.
- La procédure de rotation a été répétée une fois en préproduction (voir Faire tourner une clé).
- La personne d'astreinte sait comment demander une révocation urgente (voir Révoquer une clé).