Secrets Loader を使用した Laravel および JS プロジェクトのシークレット管理が簡単に

API キー、トークン、資格情報などの機密データをさまざまな環境で管理することは、特にアプリケーションの開発とデプロイの場合に非常に難しい場合があります。シークレットをバージョン管理にハードコードせずに、安全に保存し、必要なときに取得できるようにすることは、セキュリティを維持するために非常に重要です。

だからこそ、私は Secrets Loader を作成しました。これは、AWS SSM と CloudFormation から .env ファイルに直接シークレットを動的に取得する Bash スクリプトであり、ローカルでの開発とデプロイメントをより簡単、安全、効率的に行うことができます。

---

シークレットローダーとは何ですか?

Secrets Loader は、.env ファイルのカスタム構文に基づいて、AWS SSM パラメータ ストアおよび AWS CloudFormation 出力からシークレットを自動的に取得するように設計されたシンプルなツールです。バージョン管理で機密情報を公開することなく、プレースホルダーを実際のシークレットに置き換えます。

たとえば、API キーや認証情報をハードコーディングする代わりに、.env ファイル内で次のように定義します。

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

Secrets Loader は 1 つのコマンドで AWS から実際の値をフェッチし、.env ファイルを更新して、機密情報を安全に保ち、管理しやすくします。

---

作った理由

ローカルでの開発と展開中に、プロジェクト ファイルにハードコーディングしたくない機密の資格情報を扱っていることに気づきました。 AWS のサービスを広範囲に使用してきたので、それほど手間をかけずにシークレット管理を既存の開発ワークフローに統合する方法を必要としていました。

Secrets Loader が解決する主な課題は次のとおりです。

1. ハードコーディングされたシークレットの回避: シークレットをバージョン管理にコミットする必要はもうありません。プレースホルダーを安全に使用して、AWS SSM と CloudFormation から実際の値を動的に取得できます。
2. 手動作業の削減: シークレット値を手動でコピーして貼り付ける代わりに、.env ファイルで一度定義するだけで、スクリプトに取得を実行させます。
3. シークレット管理の簡素化: ローカル開発、ステージング、本番環境のいずれで作業している場合でも、Secrets Loader を使用すると、シークレットが安全かつ自動的にロードされます。

---

特徴

Secrets Loader には、ローカル開発環境と運用環境の両方で便利なツールとなるいくつかの重要な機能が備わっています。

• 自動シークレット読み込み: .env ファイルでパスを指定して、AWS SSM パラメータ ストアと CloudFormation からシークレットを取得します。
• セキュリティ第一のアプローチ: 機密データを実行時に安全にロードすることで、バージョン管理の対象から外します。
• 単純な構文: .env ファイルでカスタム構文 (ssm: SSM パラメーターの場合、cf: CloudFormation 出力の場合) を使用して、シークレットの取得元を指定します。
• エラー処理: スクリプトは、1 つの取得が失敗した場合でも他のシークレットの処理を続行し、ワークフローを停止することなく警告をログに記録します。

---

仕組み

Secrets Loader の魅力は、特定のプレフィックス (ssm: および cf:) に基づいて AWS からシークレットをフェッチできる機能にあります。ワークフローの例を次に示します:

1. .env ファイルをセットアップします:

SSM パラメーターの場合は ssm: プレフィックス、または CloudFormation 出力の場合は cf: プレフィックスを使用して、.env ファイルにシークレットのプレースホルダーを追加します。

   THIRD_PARTY_API_KEY="ssm:/third-party/api/key"
   AWS_SECRET_ACCESS_KEY="cf:my-stack:SecretAccessKey"

1. スクリプトを実行します:

次のコマンドを使用してスクリプトを実行し、シークレットを取得します。

   ./secrets.sh

1. 更新された .env ファイル:

スクリプトを実行すると、.env ファイルが AWS から取得した実際の値で更新されます。

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

シークレットをハードコーディングしたり、手動で検索したりする必要はもうありません!

---

インストールとセットアップ

始める準備はできましたか?プロジェクトで Secrets Loader をセットアップする方法は次のとおりです:

1. リポジトリのクローンを作成します:

   git clone https://github.com/Thavarshan/secretst-loader.git
   cd secretst-loader

1. スクリプトを実行可能にします:

   chmod +x secrets.sh

1. AWS CLI がインストールされ、設定されていることを確認します:

AWS CLI がインストールされていない場合は、AWS CLI インストールガイドに従ってください。インストール後、AWS 認証情報を構成します:

   aws configure

1. .env でシークレットを定義します:

ssm: および cf: プレフィックスを使用して、シークレットの取得元を定義します。

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

---

使用例

簡単な例を見てみましょう:

.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.

以上がSecrets Loader を使用した Laravel および JS プロジェクトのシークレット管理が簡単にの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。