当前位置：首页 > news >正文

Scaffolding安全最佳实践：保护生成代码中的敏感信息的完整指南

news 2026/6/17 6:23:59

Scaffolding安全最佳实践：保护生成代码中的敏感信息的完整指南

【免费下载链接】ScaffoldingCode generators to speed up development.项目地址: https://gitcode.com/gh_mirrors/sc/Scaffolding

在快速开发ASP.NET应用程序时，Scaffolding代码生成工具能显著提升效率，但随之而来的安全风险也不容忽视。本文将分享Scaffolding安全最佳实践，帮助开发者在享受代码生成便利的同时，有效保护敏感信息。💡

🔐 为什么Scaffolding安全至关重要？

Scaffolding工具如dotnet scaffold和dotnet msidentity能够自动生成身份验证、数据库访问等核心功能代码。然而，这些生成的代码中可能包含API密钥、数据库连接字符串、客户端密钥等敏感信息。如果不采取适当的安全措施，这些信息可能被意外提交到版本控制系统，导致严重的安全漏洞。

敏感信息的常见藏身之处：

appsettings.json配置文件
用户机密(User Secrets) 存储
环境变量配置
Azure Key Vault集成代码
身份验证配置中的客户端ID和密钥

🛡️ 核心安全原则

1.永不提交敏感信息到版本控制

这是Scaffolding安全的第一条黄金法则！🚫

# 在.gitignore中添加以下内容 *.user *.suo *.userosscache *.sln.docstates .vs/ appsettings.*.json secrets.json

关键实践：

使用dotnet user-secrets管理本地开发机密
为不同的环境创建不同的配置文件：appsettings.Development.json、appsettings.Production.json
确保.gitignore文件包含所有敏感文件模式

2.使用环境变量和用户机密

Scaffolding生成的代码通常支持多种配置源。最佳实践是：

// 在Program.cs或Startup.cs中配置 builder.Configuration.AddUserSecrets<Program>(); builder.Configuration.AddEnvironmentVariables();

实施步骤：

初始化用户机密：dotnet user-secrets init
设置机密：dotnet user-secrets set "ConnectionStrings:Default" "your-connection-string"
在代码中通过IConfiguration访问：configuration["ConnectionStrings:Default"]

3.Azure Key Vault集成

对于生产环境，强烈推荐使用Azure Key Vault：

# 使用Scaffolding生成Key Vault集成代码 dotnet scaffold aspnet keyvault --project MyProject.csproj

优势：

集中管理所有机密
自动轮换密钥
细粒度的访问控制
审计日志记录

🔧 Scaffolding工具的安全配置

Microsoft Identity Scaffolding安全实践

dotnet msidentity工具生成的身份验证代码需要特别注意：

客户端密钥管理：
- 定期轮换客户端密钥（建议每90天）
- 使用证书认证代替客户端密钥（更安全）
- 为不同环境使用不同的应用注册
权限最小化原则：
- 只授予应用所需的最小权限
- 定期审查和清理未使用的权限
- 使用条件访问策略增强安全性

项目文件安全配置

在Directory.Packages.props中，确保使用安全版本：

<PackageVersion Include="System.Security.Cryptography.ProtectedData" Version="10.0.3" />

📁 安全文件结构示例

MyProject/ ├── src/ │ ├── MyProject.csproj │ ├── Program.cs │ ├── appsettings.json # 不包含敏感信息 │ ├── appsettings.Development.json # 开发配置（不提交） │ └── Properties/ │ └── launchSettings.json ├── .gitignore # 包含敏感文件模式 └── README.md # 包含安全说明

🚨 常见安全陷阱及避免方法

陷阱1：硬编码连接字符串

错误示例：

var connectionString = "Server=.;Database=MyDB;User Id=sa;Password=P@ssw0rd!";

正确做法：

var connectionString = configuration.GetConnectionString("Default");

陷阱2：提交用户机密文件

风险：secrets.json文件被意外提交解决方案：确保.gitignore包含：

**/secrets.json **/appsettings.*.json

陷阱3：使用弱加密

避免：自定义加密算法推荐：使用.NET内置的加密库：

using System.Security.Cryptography;

🔍 安全检查清单

在每次使用Scaffolding生成代码后，执行以下安全检查：

✅配置文件检查：

确认appsettings.json不包含真实密码
敏感配置已移至用户机密或环境变量
开发和生产配置已分离

✅版本控制检查：

运行git status查看是否有敏感文件被跟踪
使用git check-ignore验证.gitignore规则
检查git历史中是否有敏感信息泄露

✅依赖安全检查：

确保所有NuGet包来自可信源
使用最新安全版本的包
定期运行dotnet list package --outdated

✅身份验证配置：

客户端密钥已安全存储
重定向URI配置正确
权限范围最小化

🛠️ 实用安全命令

1. 安全初始化项目

# 创建新项目 dotnet new webapp -n SecureApp # 初始化用户机密 cd SecureApp dotnet user-secrets init # 添加Scaffolding工具 dotnet tool install --global dotnet-aspnet-codegenerator

2. 安全生成身份验证代码

# 使用Microsoft Identity Scaffolding dotnet scaffold aspnet entra-id --project SecureApp.csproj # 交互式模式（推荐） dotnet scaffold aspnet entra-id

3. 安全配置检查

# 检查git忽略规则 git check-ignore -v appsettings.Development.json # 列出用户机密 dotnet user-secrets list # 扫描项目中的硬编码密码 grep -r "Password=" --include="*.cs" --include="*.json" .