Django 프로젝트의 비밀 키를 보호하는 방법

한동안 Django 작업을 해왔습니다. 실수로 내 비밀 키를 내 공개 GitHub 리포지토리에 푸시했습니다.😬 그래, 초보적인 실수야! 🤷🏽‍♂️

저는 즉시 GitGuardian으로부터 관련된 보안 위험을 알리는 이메일을 받았습니다.



후속 작업 및 프로젝트에서 이 문제를 피하기 위해 몇 가지 조치를 취했습니다. 이에 도달하기 전에 몇 가지 요구 사항을 간략하게 강조하겠습니다.
추신 Windows 장치에서 VSCode를 사용합니다. 😁

요구 사항

.gitignore 파일을 사용하세요.

.gitignore 파일은 무시할 파일과 디렉터리를 git에 알려줍니다. Git은 민감한 정보를 보호하기 위해 이 파일에 있는 모든 파일이나 디렉토리를 자동으로 무시합니다.

VSCode에 git-clone하기 전에 GitHub 저장소의 루트에 .gitignore 파일을 만드십시오.

.env 또는 .venv 파일과 같은 가상 환경을 만듭니다.

#.env
py -3 -m venv .env
#.venv
py -3 -m venv .venv

저장소의 루트에 포함된 .gitignore 파일에 가상 환경을 추가하여 가상 환경을 무시하는 것이 좋습니다.

단계

명령줄에서 다음 코드를 사용하여 python-dotenv를 설치합니다.

pip install python-dotenv

settings.py 파일로 이동하여 설정 파일에 다음 두 줄을 붙여넣습니다.

from dotenv import load_dotenv
load_dotenv()

settings.py 파일에서 비밀 키를 복사하여 생성한 .env 또는 .venv 파일에 붙여넣습니다.

SECRET_KEY=ui#1j%%f5mxdojzakk72+dvftl%4&y#31_a##16s6s(6pfxy-b

등호 앞뒤 공백 제거

따옴표 제거

다음으로 settings.py 파일에서 다음과 같이 비밀 키를 검색합니다.

SECRET_KEY = str(os.getenv('SECRET_KEY'))

import os 기능을 추가해야 할 수도 있습니다.


준비 및 커밋하기 전에 서버를 실행하여 작동하는지 확인합니다.

python manage.py runserver

메모

VSCode에서 Git Bash로 전환했습니다. 일부 명령이 다른 터미널에서 예상대로 작동하지 않았습니다.

VSCode에서 제공하는 다른 터미널을 사용해 볼 수 있습니다.

이 문제를 해결하는 다른 방법을 알고 있다면 친절하게 의견을 남겨주십시오. 👇🏽

건배! 🍻

참조

https://www.freecodecamp.org/news/gitignore-what-is-it-and-how-to-add-to-repo/

https://code.visualstudio.com/docs/python/tutorial-django

표지 이미지 출처

https://www.caplinked.com/wp-content/uploads/AdobeStock_209686850.jpeg