C# - 컴파일러 옵션 OSS signing / Public Signing
지난 글에서 설명한 옵션과 함께,
C# - 재현 가능한 빌드(reproducible builds) == Deterministic builds
; https://www.sysnet.pe.kr/2/0/11624
비주얼 스튜디오 2015 업데이트 2(엄밀히 Roslyn 컴파일러)에 추가된 기능으로,
New C# and VB features in Visual Studio 2015 Update 2
; https://devblogs.microsoft.com/dotnet/whats-new-for-c-and-vb-in-visual-studio/
publicSign 옵션이 있습니다.
Public Signing
; https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/public-signing.md
말 그대로, publicKey로만 서명된 것으로,
publicSign: Supports a new method of signing that is similar to delay signing except it doesn’t need to add skip verification entries to your machine. Binaries can be public signed with only the public key and load into contexts necessary for development and testing. This is also known as OSS signing.
당연히 개인키 없이 서명하는 것이므로 누구에 의해 만들어졌음을 보증할 수는 없습니다. 이 옵션이 어떤 것인지는, 그것이 나오게 된 이유를 들여다보면 쉽게 알 수 있습니다.
.NET Full Framework의 경우, 마이크로소프트가 만들고 배포를 했으며 이는 GAC에 등록이 됩니다. 따라서 기존의 강력한 이름 서명으로 만족할 수 있었고, 별 문제가 없었습니다. 하지만, .NET Core가 나오면서 이런 상황이 바뀝니다. .NET Core는 누구나 빌드해서 배포할 수 있는 오픈 소스 프로젝트이기 때문에 마이크로소프트가 해당 어셈블리들을 서명하기 위해 개인키를 함께 노출할 수는 없는 상황입니다. (다시 말해, 개인키 파일까지 github에 올릴 수는 없습니다.) 물론, 마이크로소프트가 배포하는 .NET Core 모듈만 개인키 서명을 하면 되고, 직접 빌드한 경우에는 서명 작업을 아예 안할 수도 있습니다. 그런데 이런 경우 문제가 발생합니다.
가령, 기존에 만들어진 프로그램이 마이크로소프트가 배포한 .NET Core를 참조했다고 가정해 보겠습니다. 즉, 프로그램에는 이미 마이크로소프트가 서명한 .NET Core를 강력한 이름의 어셈블리로 참조를 추가하고 있는 것입니다. 그런데 이 프로그램을 자신이 빌드한 .NET Core 환경에서 실행시키는 경우, 서명이 없으므로 해당 프로그램은 서명이 있는 어셈블리와 바인딩을 시도하므로 실패하게 되는 것입니다.
따라서, 자신이 빌드를 주도할 수 없는 오픈 소스 프로젝트의 경우라면 기존의 "강력한 이름 서명" 방식이 어울리지 않게 된 것입니다. 이를 위해 보완된 것이 바로 "공개 서명(Public Signing)"이고 이것이 오픈 소스 프로젝트와 어울리다 보니 한때 "
오픈 소스 서명(OSS - Open Source Signing)"이라고도 불렸던 것입니다.
어찌 보면, 개인 키 서명을 미뤄두는 "delay signing"과 유사하지만 차이점이라면 별도의 서명하지 않은 어셈블리에 대한 "보안 생략 설정(Skip Verification)"을 하지 않아도 된다는 것입니다.
지연 서명된 DLL과 서명된 DLL의 차이점
; https://www.sysnet.pe.kr/2/0/11258
지연 서명된 어셈블리를 sn.exe -Vr 등록 없이 사용하는 방법
; https://www.sysnet.pe.kr/2/0/11259
이런 특징 덕분에 개발자의 환경뿐만 아니라 일반 사용자의 환경에서도 실행에 아무런 불편함이 없게 되었습니다.
결국, 이 기능으로 인해 마이크로소프트는 닷넷 관련 오픈 소스 프로젝트에 "공개키"만을 포함시켜도 되었고 여전히 어셈블리의 이름을 "강력한 이름(strong name)"으로 부여할 수 있게 되었습니다.
여러분들도, github에 올릴 오픈 소스가 있는데 그것에 서명하고 싶다면 (혹은, 은근히 PublicKeyToken을 자신의 개인키로 서명하던 것들과 일치시키고 싶다면) Public Signing을 이용하시면 됩니다. 방법은, 간단하게 csproj 파일에 다음의 옵션을 추가하는 것입니다.
<PublicSign>True</PublicSign>
하지만, 이 옵션만 주고 빌드하면 다음의 에러가 떨어집니다.
error CS8102: Public signing was specified and requires a public key, but no public key was specified.
아무리 그래도 공개키는 있어야 하는 것입니다. ^^ 이를 위해 비주얼 스튜디오의 "Developer Command Prompt for VS 2017"에서 다음과 같이 sn.exe를 실행시켜 공개키를 담은 파일을 구할 수 있습니다.
c:\temp>sn -k test.snk
Microsoft (R) .NET Framework Strong Name Utility Version 4.0.30319.0
Copyright (c) Microsoft Corporation. All rights reserved.
Key pair written to test.snk
c:\temp>sn -p test.snk public.snk
Microsoft (R) .NET Framework Strong Name Utility Version 4.0.30319.0
Copyright (c) Microsoft Corporation. All rights reserved.
Public key written to public.snk
위에서 보면, -k 옵션으로 개인키/공개키를 함께 담은 test.snk 파일을 생성하고 -p 옵션을 이용해 그 파일로부터 공개키만을 담은 별도의 public.snk 파일을 생성했습니다. 이제 public.snk 파일만 솔루션 폴더에 복사한 후 공개 서명할 어셈블리의 프로젝트 파일에 다음의 설정을 추가합니다.
<SignAssembly>True</SignAssembly>
<AssemblyOriginatorKeyFile>$(SolutionDir)public.snk</AssemblyOriginatorKeyFile>
빌드 후, 출력된 바이너리(dll/exe) 파일을 .NET Reflector 같은 도구를 이용해 열어 보면 다음과 같이 강력한 이름이 지정된 것을 볼 수 있습니다.
ClassLibrary1, Version=1.0.0.0, Culture=neutral, PublicKeyToken=fd4372d50df8504c
또한, 이 파일을 참조하는 다른 어셈블리가 있다면 이에 대한 참조에 강력한 이름 형식으로 바인딩하고 있는 것을 ildasm.exe를 통해 확인할 수 있습니다.
.assembly extern ClassLibrary1
{
.publickeytoken = (FD 43 72 D5 0D F8 50 4C ) // .Cr...PL
.ver 1:0:0:0
}
"
Public Signing" 글에서도 설명하고 있지만, 어셈블리에 지정된 CorFlags 값도,
[Flags]
public enum CorFlags
{
ILOnly = 0x00000001,
Requires32Bit = 0x00000002,
ILLibrary = 0x00000004,
StrongNameSigned = 0x00000008,
NativeEntryPoint = 0x00000010,
TrackDebugData = 0x00010000,
Prefers32Bit = 0x00020000,
}
여느 강력한 이름으로 서명된 어셈블리와 다를 바 없게 지정되어 있습니다.
[서명 전]
E:\ConsoleApp1\bin\Debug>corflags ClassLibrary1.dll
Microsoft (R) .NET Framework CorFlags Conversion Tool. Version 4.6.1055.0
Copyright (c) Microsoft Corporation. All rights reserved.
Version : v4.0.30319
CLR Header: 2.5
PE : PE32
CorFlags : 0x1
ILONLY : 1
32BITREQ : 0
32BITPREF : 0
Signed : 0
[서명 후]
E:\ConsoleApp1\bin\Debug>corflags ClassLibrary1.dll
Microsoft (R) .NET Framework CorFlags Conversion Tool. Version 4.6.1055.0
Copyright (c) Microsoft Corporation. All rights reserved.
Version : v4.0.30319
CLR Header: 2.5
PE : PE32
CorFlags : 0x9 ( == ILOnly | StrongNameSigned)
ILONLY : 1
32BITREQ : 0
32BITPREF : 0
Signed : 1
참고로, 빌드 시에 다음과 같은 오류가 발생한다면?
Error CS8102 Public signing was specified and requires a public key, but no public key was specified.
다음의 옵션을 누락시켰기 때문입니다.
<SignAssembly>True</SignAssembly>
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]