Maison  >  Article  >  interface Web  >  Gestion secrète sans effort pour les projets Laravel et JS avec Secrets Loader

Gestion secrète sans effort pour les projets Laravel et JS avec Secrets Loader

Susan Sarandon
Susan Sarandonoriginal
2024-09-20 06:43:36938parcourir

Effortless Secret Management for Laravel & JS Projects with Secrets Loader

La gestion des données sensibles telles que les clés API, les jetons et les informations d'identification dans divers environnements peut s'avérer assez délicate, en particulier lors du développement et du déploiement d'applications. S'assurer que les secrets sont stockés en toute sécurité et récupérés en cas de besoin, sans les coder en dur dans le contrôle de version, est crucial pour maintenir la sécurité.

C'est pourquoi j'ai créé Secrets Loader, un script Bash qui récupère dynamiquement les secrets d'AWS SSM et CloudFormation directement dans votre fichier .env, rendant le développement et le déploiement locaux plus faciles, plus sûrs et plus efficaces.


Qu'est-ce que Secrets Loader ?

Secrets Loader est un outil simple conçu pour récupérer automatiquement les secrets d'AWS SSM Parameter Store et des sorties AWS CloudFormation en fonction de la syntaxe personnalisée de votre fichier .env. Il remplace les espaces réservés par de véritables secrets sans jamais exposer d'informations sensibles dans le contrôle de version.

Par exemple, au lieu de coder en dur vos clés API ou vos identifiants, vous les définissez dans votre fichier .env comme ceci :

THIRD_PARTY_API_KEY="ssm:/third-party/api/key"
AWS_ACCESS_KEY_ID="cf:my-stack:AccessKeyId"

Avec une seule commande, Secrets Loader récupérera les valeurs réelles d'AWS et mettra à jour votre fichier .env, gardant les informations sensibles sécurisées et faciles à gérer.


Pourquoi je l'ai construit

Lors du développement et du déploiement local, je me suis retrouvé face à des informations d'identification sensibles que je ne voulais pas coder en dur dans les fichiers du projet. Ayant beaucoup utilisé les services AWS, je cherchais un moyen d'intégrer la gestion des secrets dans mon flux de développement existant sans trop de tracas.

Voici les principaux défis résolus par Secrets Loader :

  1. Éviter les secrets codés en dur : Plus besoin de confier des secrets au contrôle de version. Vous pouvez utiliser en toute sécurité des espaces réservés et récupérer dynamiquement les valeurs réelles d'AWS SSM et de CloudFormation.
  2. Réduire l'effort manuel : au lieu de copier et coller manuellement les valeurs secrètes, définissez-les simplement une fois dans votre fichier .env et laissez le script effectuer la récupération.
  3. Simplification de la gestion des secrets : que vous travailliez dans le développement local, la préparation ou la production, Secrets Loader garantit que les secrets sont chargés automatiquement et en toute sécurité.

Caractéristiques

Secrets Loader est livré avec quelques fonctionnalités clés qui en font un outil pratique pour les environnements de développement et de production locaux :

  • Chargement automatisé des secrets : récupérez les secrets d'AWS SSM Parameter Store et de CloudFormation en spécifiant les chemins dans votre fichier .env.
  • Approche axée sur la sécurité : gardez les données sensibles hors du contrôle de version en les chargeant en toute sécurité au moment de l'exécution.
  • Syntaxe simple : Utilisez une syntaxe personnalisée dans votre fichier .env (ssm : pour les paramètres SSM, cf : pour les sorties CloudFormation) pour spécifier d'où doivent provenir les secrets.
  • Gestion des erreurs : le script continue de traiter d'autres secrets même si une récupération échoue, en enregistrant les avertissements sans arrêter votre flux de travail.

Comment ça marche

La magie de Secrets Loader réside dans sa capacité à récupérer des secrets depuis AWS en fonction de préfixes spécifiques (ssm: et cf:). Voici un exemple de flux de travail :

  1. Configurez votre fichier .env :

Ajoutez des espaces réservés pour vos secrets dans votre fichier .env en utilisant le préfixe ssm: pour les paramètres SSM ou le préfixe cf: pour les sorties CloudFormation :

   THIRD_PARTY_API_KEY="ssm:/third-party/api/key"
   AWS_SECRET_ACCESS_KEY="cf:my-stack:SecretAccessKey"
  1. Exécuter le script :

Utilisez la commande suivante pour exécuter le script et récupérer les secrets :

   ./secrets.sh
  1. Fichier .env mis à jour :

Après avoir exécuté le script, votre fichier .env sera mis à jour avec les valeurs réelles extraites d'AWS :

   THIRD_PARTY_API_KEY=actual-api-key-value
   AWS_SECRET_ACCESS_KEY=actual-access-key-value

Plus de secrets de codage en dur et plus de recherches manuelles !


Installation et configuration

Prêt à commencer ? Voici comment configurer Secrets Loader dans votre projet :

  1. Cloner le dépôt :
   git clone https://github.com/Thavarshan/secretst-loader.git
   cd secretst-loader
  1. Rendre le script exécutable :
   chmod +x secrets.sh
  1. Assurez-vous qu'AWS CLI est installé et configuré :

Si l'AWS CLI n'est pas installée, suivez le guide d'installation de l'AWS CLI. Après l'installation, configurez vos informations d'identification AWS :

   aws configure
  1. Définissez vos secrets en .env :

Utilisez les préfixes ssm: et cf: pour définir d'où doivent provenir les secrets :

   THIRD_PARTY_API_KEY="ssm:/third-party/api/key"
   AWS_ACCESS_KEY_ID="cf:my-stack:AccessKeyId"

Exemple d'utilisation

Prenons un exemple simple :

.env.example File:

# Application settings
APP_NAME=MyApp
APP_ENV=production

# Secrets fetched from AWS SSM and CloudFormation
THIRD_PARTY_API_KEY="ssm:/third-party/api/key"
AWS_SECRET_ACCESS_KEY="cf:my-stack:SecretAccessKey"

Running Secrets Loader:

./secrets.sh

Updated .env File:

# Application settings
APP_NAME=MyApp
APP_ENV=production

# Fetched secrets
THIRD_PARTY_API_KEY=actual-api-key-value
AWS_SECRET_ACCESS_KEY=actual-secret-access-key

Troubleshooting

If you encounter any issues while using Secrets Loader, here are a few things to check:

  1. AWS Permissions: Ensure that the AWS CLI is configured correctly and that your IAM role or user has sufficient permissions to access AWS SSM and CloudFormation secrets.

  2. Syntax Errors: Double-check the syntax in your .env file to make sure the ssm: and cf: prefixes are correct.

  3. Script Errors: If the script fails to fetch certain secrets, it will log warnings but continue fetching the others. Review the logs for any error messages and make sure the AWS resources exist and are accessible.


Extending Secrets Loader

The script is designed to be extensible. If you'd like to integrate other secret management systems (like Azure Key Vault or HashiCorp Vault), you can easily modify the script to support new prefixes and fetch logic.

For example, you could add an azkv: prefix to fetch secrets from Azure Key Vault and handle the retrieval using the Azure CLI.


Contributing

Secrets Loader is open-source, and contributions are always welcome! If you'd like to add features, fix bugs, or suggest improvements, feel free to:

  • Open an issue: Share your feedback or bug reports.
  • Submit a pull request: Contribute code by following our CONTRIBUTING guidelines.

Conclusion

If you're tired of manually managing secrets across environments, Secrets Loader is a simple, effective tool to streamline the process. By fetching secrets dynamically from AWS SSM and CloudFormation, you can securely manage your credentials without risking exposure in version control.

Check out the project on GitHub, give it a try, and if you find it useful, give us a ⭐ on GitHub! Your support helps the project grow, and we'd love to hear your feedback or see your contributions to its ongoing development.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!

Déclaration:
Le contenu de cet article est volontairement contribué par les internautes et les droits d'auteur appartiennent à l'auteur original. Ce site n'assume aucune responsabilité légale correspondante. Si vous trouvez un contenu suspecté de plagiat ou de contrefaçon, veuillez contacter admin@php.cn