Stocker une clé en sécurité
Ranger une clé API dans un secret, la fournir à un service hébergé sur Wakastart et éviter qu'elle n'apparaisse dans le code, les journaux ou un navigateur.
GuideDéveloppeur
- Durée
- 10 min
Quiconque détient une clé API agit avec ses droits, depuis n'importe quelle adresse autorisée. Elle se range donc comme un mot de passe d'administration : dans un secret, lue au démarrage par le seul serveur qui en a besoin.
Avant de commencer
- Vous avez reçu la clé (voir Obtenir une clé API).
Fournir la clé à un service hébergé sur Wakastart
Si le serveur qui appelle l'API tourne sur Wakastart, fournissez la clé comme secret d'environnement :
- Dans la définition du service, déclarez la variable attendue
WAKASTART_API_KEY. - Dans l'environnement concerné, créez un secret qui contient la clé, puis reliez la variable à ce secret.
Résultat : la clé est injectée dans le conteneur au déploiement, sans jamais être affichée dans la console. Le détail des écrans est dans Variables et secrets.
Fournir la clé à un serveur hébergé ailleurs
- Rangez la clé dans votre gestionnaire de secrets (coffre de votre hébergeur, Vault, 1Password, etc.).
- Injectez-la dans le processus par une variable d'environnement au démarrage.
- Lisez-la une seule fois dans votre code :
TypeScript
const apiKey = process.env.WAKASTART_API_KEY;
if (!apiKey?.startsWith("sk_")) {
throw new Error("WAKASTART_API_KEY manquante ou invalide");
}Ce qu'il ne faut pas faire
Attention
- N'écrivez jamais la clé dans le code source, un fichier
.envversionné, une image Docker ou un ticket. - N'envoyez jamais la clé à un navigateur ou à une application mobile : elle serait lisible par tous ses utilisateurs.
- Ne journalisez jamais l'en-tête
x-api-key; si besoin, n'en gardez que les 10 premiers caractères.
D'autres bonnes pratiques :
- une clé par usage et par environnement, pour pouvoir révoquer l'une sans couper les autres ;
- une liste d'adresses IP autorisées dès que vos serveurs ont des adresses fixes ;
- une date d'expiration, et un rappel pour la renouveler à temps (voir Faire tourner une clé).
Vérifier le résultat
- Recherchez le préfixe
sk_dans votre dépôt de code et vos journaux : aucune clé complète ne doit apparaître. - Redémarrez le service : il démarre et son premier appel à l'API répond
200.