dotnet user-secrets 명령어
지난 글에 이어,
dotnet ef 명령어 사용을 위한 준비
; https://www.sysnet.pe.kr/2/0/11433
이번에는 dotnet user-secrets 명령어에 대한 간단한 사용법을 기록으로 남깁니다. ^^
Safe storage of app secrets during development in ASP.NET Core
; https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?tabs=visual-studio
이 명령어의 경우 이름에서 약간 오해가 생길 수 있는 데 "secret"이라고 해서 암호화를 포함하지는 않고 단지 값에 대한 내용을 공통 소스 코드가 아닌 개발자 각자의 PC에 저장할 수 있는 정도의 기능만 포함하고 있습니다. (가령, 운영 서버에서 사용하는 암호까지 포함된 DB 연결 문자열 같은.)
사용을 위해서는 Visual Studio에서 해당 프로젝트를 마우스 우 클릭해 "Manage User Secrets" 메뉴를 선택하면 됩니다. 그럼 시스템에 다음과 같은 2가지 변화가 일어납니다.
첫 번째로 프로젝트 파일(.csproj)에 다음과 같이 UserSecretsId 항목이 생깁니다.
<PropertyGroup>
<TargetFramework>net47</TargetFramework>
<RefVersion>2.1.0-preview1-28012</RefVersion>
<UserSecretsId>2c0e055e-b285-401c-99cf-83f27128f081</UserSecretsId>
</PropertyGroup>
두 번째로 "%APPDATA%\Microsoft\UserSecrets" 폴더가 생성되고 그 하위에 .csproj 파일에 포함된 UserSecretsId 값의 서브 폴더가 생성됩니다. 예를 들어 이 글의 상황에서는 다음의 폴더가 생성됩니다.
%APPDATA%\Microsoft\UserSecrets\aad49e62-db13-4301-a0c9-d00bb910875d
이와 함께 저 폴더 하위에 "secrets.json" 파일이 다음과 같이 빈 설정을 담아 생성됩니다.
{
}
물론, 저 작업들을 Visual Studio의 메뉴 선택이 아닌 수작업으로 직접 해줘도 됩니다.
위의 준비를 해도 "dotnet user-secrets" 명령을 사용할 수 있는 것은 아닙니다. 이를 위해서는 해당 프로젝트 파일(.csproj)에 다음의 내용을 수작업으로 추가해야 합니다.
<Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup>
<TargetFramework>netcoreapp2.0</TargetFramework>
<UserSecretsId>aad49e62-db13-4301-a0c9-d00bb910875d</UserSecretsId>
</PropertyGroup>
<ItemGroup>
<Folder Include="wwwroot\" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="Microsoft.AspNetCore.All" Version="2.0.0" />
</ItemGroup>
<ItemGroup>
<DotNetCliToolReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Tools" Version="2.0.0" />
<DotNetCliToolReference Include="Microsoft.Extensions.SecretManager.Tools" Version="2.0.0" />
</ItemGroup>
</Project>
이렇게 한 후에야 "dotnet user-secrets" 명령어가 사용 가능합니다. 가령 다음과 같이 키/값을 추가할 수 있습니다.
F:\WebApplication1\WebApplication1> dotnet user-secrets set test "myValue"
Successfully saved test = myValue to the secret store.
그럼, secrets.json 파일에 이렇게 값이 추가됩니다.
{
"test": "myValue"
}
물론 저런 식으로 명령행을 통해 값을 추가하는 것도 가능하지만 단순히 %APPDATA%\Microsoft\UserSecrets\aad49e62-db13-4301-a0c9-d00bb910875d\secrets.json 파일을 직접 읽어 편집해도 무방합니다.
"user-secrets"에 설정한 값을 접근하는 것은 appsettings.json에 설정했을 때와 동일한 방법으로 이뤄집니다. 가령 ASP.NET Core 프로젝트의 Web API 방식으로 생성한 기본 예제에서 Controller 클래스에 의존성 주입으로 IConfiguration을 넘겨 받아 처리할 수 있습니다.
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using System.Collections.Generic;
namespace WebApplication1.Controllers
{
[Route("api/[controller]")]
public class ValuesController : Controller
{
IConfiguration _config;
public ValuesController(IConfiguration config)
{
_config = config;
}
// GET api/values
[HttpGet]
public IEnumerable<string> Get()
{
return new string[] { _config["test"], "value1", "value2" };
}
// ...[생략]...
}
}
이후 실 서버 배포에서는 저 정보를 "appsettings.json"에 동일한 키/값으로 포함시키면 됩니다. 가령 위의 소스 코드와 같은 상황이라면 다음과 같이 appsettings.json에 정보를 넣어줍니다.
{
"test": "myValue3",
"Logging": {
"IncludeScopes": false,
"Debug": {
"LogLevel": {
"Default": "Warning"
}
},
"Console": {
"LogLevel": {
"Default": "Warning"
}
}
}
}
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]