Secrets Loader를 사용한 Laravel 및 JS 프로젝트의 간편한 비밀 관리

다양한 환경에서 API 키, 토큰, 자격 증명과 같은 민감한 데이터를 관리하는 것은 매우 까다로울 수 있으며, 특히 애플리케이션을 개발하고 배포할 때 더욱 그렇습니다. 버전 관리에 하드코딩하지 않고도 비밀 정보를 안전하게 저장하고 필요할 때 가져오는 것이 보안 유지에 매우 중요합니다.

그래서 저는 AWS SSM 및 CloudFormation에서 비밀 정보를 .env 파일로 직접 동적으로 가져오는 Bash 스크립트인 Secrets Loader를 만들어 로컬 개발과 배포를 더욱 쉽고 안전하며 효율적으로 만들었습니다.

---

비밀 로더란 무엇입니까?

비밀 로더는 .env 파일의 사용자 지정 구문을 기반으로 AWS SSM Parameter Store 및 AWS CloudFormation 출력에서 ​​비밀을 자동으로 가져오도록 설계된 간단한 도구입니다. 버전 관리에서 민감한 정보를 노출하지 않고 자리 표시자를 실제 비밀로 대체합니다.

예를 들어 API 키나 자격 증명을 하드코딩하는 대신 다음과 같이 .env 파일에 정의합니다.

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

단일 명령으로 Secrets Loader는 AWS에서 실제 값을 가져오고 .env 파일을 업데이트하여 중요한 정보를 안전하고 쉽게 관리할 수 있도록 유지합니다.

---

내가 그것을 만든 이유

로컬 개발 및 배포 중에 프로젝트 파일에 하드코딩하고 싶지 않은 민감한 자격 증명을 다루게 되었습니다. AWS 서비스를 광범위하게 사용하면서 저는 큰 번거로움 없이 비밀 관리를 기존 개발 워크플로우에 통합할 수 있는 방법을 원했습니다.

Secrets Loader가 해결하는 주요 과제는 다음과 같습니다.

1. 하드코딩된 비밀 방지: 더 이상 버전 관리에 비밀을 커밋하지 않습니다. 자리 표시자를 안전하게 사용하고 AWS SSM 및 CloudFormation에서 실제 값을 동적으로 가져올 수 있습니다.
2. 수동 작업 줄이기: 비밀 값을 수동으로 복사하여 붙여넣는 대신 .env 파일에 한 번 정의하고 스크립트에서 가져오기를 수행하도록 하세요.
3. 비밀 관리 단순화: 로컬 개발, 스테이징 또는 프로덕션 중 무엇을 하든 Secrets Loader는 비밀이 안전하게 자동으로 로드되도록 보장합니다.

---

특징

Secrets Loader에는 로컬 개발 및 프로덕션 환경 모두에 편리한 도구로 만드는 몇 가지 주요 기능이 포함되어 있습니다.

• 자동 비밀 로딩: .env 파일에 경로를 지정하여 AWS SSM Parameter Store 및 CloudFormation에서 비밀을 가져옵니다.
• 보안 우선 접근 방식: 민감한 데이터를 런타임에 안전하게 로드하여 버전 제어에서 보호합니다.
• 간단한 구문: .env 파일에서 사용자 지정 구문(ssm: SSM 매개변수, cf: CloudFormation 출력용)을 사용하여 보안 비밀의 출처를 지정합니다.
• 오류 처리: 한 번의 검색이 실패하더라도 스크립트는 다른 비밀을 계속 처리하여 워크플로를 중단하지 않고 경고를 기록합니다.

---

작동 방식

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 중국어 웹사이트의 기타 관련 기사를 참조하세요!