AI Agent / 系统课时
保护密钥与敏感配置
保护密钥与敏感配置
开发项目中的密钥、令牌和环境配置一旦进入代码仓库,可能造成安全风险。本篇将介绍如何使用环境变量、配置模板和忽略规则建立基础保护机制。
学习目标
- 理解敏感配置泄露的风险来源。
- 掌握环境变量和配置模板的基本使用方式。
- 能配置忽略规则避免敏感文件进入版本库。
为什么不能直接提交敏感信息
数据库密码、API 密钥、访问令牌等信息属于运行环境数据,不应该和业务代码一起管理。
代码仓库通常会被多人访问,也可能同步到远程平台。一旦敏感信息进入历史提交,即使后来删除文件,也可能通过提交记录恢复。
使用环境变量管理配置
应用程序通常通过环境变量读取不同环境下的配置。代码只保存配置名称,不保存真实值。
例如 Node.js 项目可以通过环境变量读取数据库连接信息:
js
const databaseUrl = process.env.DATABASE_URL;
if (!databaseUrl) {
throw new Error("DATABASE_URL is required");
}
console.log("Database configuration loaded");预期输出
text
Database configuration loaded实际部署时,DATABASE_URL 的值由运行环境提供,而不是写入源码。
使用配置模板和忽略规则
团队协作中可以提交配置模板,让成员了解需要哪些参数,同时使用忽略规则保护真实配置文件。示例项目结构:
text
project/
├── .env.example
├── .gitignore
└── src/
└── app.js.env.example 保存变量名称:
env
DATABASE_URL=<your-database-url>
API_KEY=<your-api-key>.gitignore 忽略真实配置:
gitignore
.env
.env.local预期结果
text
真实环境配置不会被 Git 跟踪,团队成员可以通过模板创建自己的配置文件。检查敏感信息是否被提交
提交前应检查 Git 状态,确认敏感文件没有进入暂存区。
bash
git status --short预期输出
text
M src/app.js
?? .env.example如果发现 .env 或包含密钥的文件,应立即移除暂存并补充忽略规则。
按自己的节奏,确认真正理解。