密钥分离，.Net程序猿不再背锅 - 好文

引言

　　互联网每隔一段时间就会爆出【某程序猿在代码托管平台上传了公司机密配置信息，导致公司核心数据被黑客获取或修改】，一茬又一茬背锅侠层出不穷。拯救自我
<https://help.github.com/en/articles/removing-sensitive-data-from-a-repository>

　　软件工程理论早以加粗字体给出经典原则：Never store production passwords or other sensitive data
in source code
依据这个原则，我们来说一些.Net 开发生涯几种敏感信息分离的方案。
头脑风暴
常规思路是【外部文件方式托管敏感信息】，外部是相对于代码托管仓库。
.Net Framework
　　可尝试在appSettings配置节启用file属性，file属性可引用外部配置文件，具备为原appSetttings新增或重写同名设置的能力。
<configuration>
<appSettings file="appsecrets.config">
　　<add key="FtpUserId" value="test_userid" /><add key="FtpPwd" value="test-pwd
">
</appSettings>
</configuration>
====appsecrets.config====================
<?xml version="1.0" encoding="utf-8" ?> <appSettings> <add key="FtpUrl"
value="sftp.rategain.com" /> <add key="FtpUserId" value="RateGain_M&C" /> <add
key="FtpPwd" value="RateGain@123" /> <add key="RemotePath" value="/M&C/" />
　　　　　　 </appSettings>
https://docs.microsoft.com/en-us/dotnet/framework/configure-apps/file-schema/appsettings/appsettings-element-for-configuration

<https://docs.microsoft.com/en-us/dotnet/framework/configure-apps/file-schema/appsettings/appsettings-element-for-configuration>
.NetCore 可在程序启动时加载 appsetting.secrets.json文件，该文件也排除在代码管理仓库之外，
部署时手动将该文件拷贝到发布目录。 var hostBuilder = WebHost.CreateDefaultBuilder(args)
.ConfigureAppConfiguration((context, builder)=> { builder.AddJsonFile($"
appsettings.secrets.json", optional: true); if
(context.HostingEnvironment.IsDevelopment()) { builder.AddUserSecrets<Startup>(
true); } builder.AddEnvironmentVariables(); }) .UseStartup<Startup>();
据此思路，可将敏感信息叫由其他组件托管，.NetCore开发者还有其他3种实践：

- 适用于Dev的 Secrets manager tool 托管

Asp.NETCore 在开发环境下保存密钥的方式，总体思路是使用一个匿名GUID引用存储在系统文件夹下同名配置Json.

https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-2.2&tabs=windows

- 适用于Azure云的 Azure Key Vault 托管

https://azure.microsoft.com/en-us/resources/samples/key-vault-dotnet-core-quickstart/

- 适用于General Deploy的环境变量托管

下面对环境变量方式分离敏感信息做进一步说明。

环境变量托管

环境变量能在进程创建时被导入/注入，因此可作为一种敏感信息分离的思路，环境变量来自 3个级别：系统，用户，进程。

介绍几种修改环境变量的方式：

①Window机器CMD命令行： setx命令， Powershell也可操作

②系统控制面板-我的电脑-属性-高级设置-环境变量

以上两种形式可理解为 AspNetCore进程启动时导入系统环境变量。

③在Visual Studio launchsettings.json设定进程启动时要注入的环境变量
{ "iisSettings": { "windowsAuthentication": false, "anonymousAuthentication":
true, "iisExpress": { "applicationUrl": "http://localhost:11761/", "sslPort": 0
} },"profiles": { "IIS Express": { "commandName": "IISExpress", "launchBrowser":
true, "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } }, "
JumpServer": { "commandName": "Project", "launchBrowser": true, "applicationUrl"
:"http://localhost:5020", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "
production" , "ASPNETCORE_URLS": "http://localhost:5020" } } } }
launchSettings.json
④在VScode launchsettings.json设定进程启动时要注入的环境变量
{ "version": "0.2.0", "configurations": [ { "name": ".NET Core Launch (web)", "
type": "coreclr", "request": "launch", "preLaunchTask": "build", "program": "
${workspaceRoot}/bin/Debug/netcoreapp1.0/TestApp.dll", "args": [], "cwd": "
${workspaceRoot}", "stopAtEntry": false, "launchBrowser": { "enabled": true, "
args": "${auto-detect-url}", "windows": { "command": "cmd.exe", "args": "/C
start ${auto-detect-url}" }, "osx": { "command": "open" }, "linux": { "command":
"xdg-open" } }, "env": { "ASPNETCORE_ENVIRONMENT": "Development" }, "
sourceFileMap": { "/Views": "${workspaceRoot}/Views" } } ] } launchsettings.json
⑤ 在进程启动时通过命令行参数注入
public static IWebHost BuildWebHost(string[] args) { var webHostBuilder =
WebHost.CreateDefaultBuilder(args) .ConfigureAppConfiguration((hostingContext,
configBuilder)=> { // 默认会加载工作目录下 appsettings.*.json配置文件　　　　
configBuilder.AddCommandLine(args).AddEnvironmentVariables(); if
(hostingContext.HostingEnvironment.IsDevelopment()) configBuilder.AddUserSecrets
<Startup>(true); }) .ConfigureLogging((hostingContext, logging) => {
logging.AddAzureWebAppDiagnostics(); }) .UseStartup<Startup>(); return
webHostBuilder.Build(); }
--------------
dotnet run --environment "development"

⑥ 若使用IIS托管AspNetCore，可在部署机器IIS的配置编辑器新增/重写环境变量

在.NetCore生产部署实践中，比较常用的方式是使用独立的appsettings.secrets.json，环境变量来分离敏感信息。

掌握这些，.Net程序猿应该就不会因为在git上传机密信息而背锅了。

~~~~~~~~~更多方式，欢迎大家留言补充。~~~~

热门工具换一换