DEV Community
·
如何在GitHub上仅保护API密钥而非整个文件及其提交历史
💡
原文英文，约700词，阅读约需3分钟。
📝
内容提要
在软件项目中，保护API密钥非常重要。将API密钥存储在.env文件中，并通过环境变量导入，避免硬编码敏感信息。同时，确保将.env文件添加到.gitignore，以防推送到GitHub。如果密钥已提交，使用git filter-repo命令清理提交历史，以确保敏感数据安全，支持源代码协作。
🎯
关键要点
- 在软件项目中，保护API密钥非常重要，以避免安全漏洞。
- API密钥授予对服务和数据的访问，公开它们可能导致未授权访问和财务损失。
- 将API密钥存储在项目根目录的.env文件中，而不是硬编码在源代码中。
- 如果使用React或Vite，API密钥需要使用REACT_或VITE_前缀。
- 更新代码以从环境变量中导入API密钥，确保代码安全。
- 将.env文件添加到.gitignore，以防止其被推送到GitHub。
- 如果API密钥已提交，使用git filter-repo命令清理提交历史。
- 在重写历史后，强制推送更改以更新远程仓库。
- 如果意外暴露API密钥，立即撤销并生成新的密钥。
- 使用工具监控仓库中的敏感信息，以确保数据安全。
❓
延伸问答
如何在GitHub上保护API密钥而不暴露整个文件？
将API密钥存储在项目根目录的.env文件中，并通过环境变量导入，确保将.env文件添加到.gitignore。
如果API密钥已经提交到GitHub，该怎么办？
使用git filter-repo命令清理提交历史，并强制推送更改以更新远程仓库。
为什么需要保护API密钥？
API密钥授予对服务和数据的访问，公开它们可能导致未授权访问和财务损失。
如何将API密钥从代码中提取到环境变量？
更新代码以从环境变量中导入API密钥，例如使用import.meta.env.VITE_API_KEY。
在使用React或Vite时，API密钥需要什么前缀？
在使用React时，API密钥需要REACT_前缀；在使用Vite时，需要VITE_前缀。
如何监控GitHub仓库中的敏感信息？
可以使用工具如GitHub Dependabot或git-secrets来监控仓库中的敏感信息。
➡️
