.NET 5+로 포팅 시 플랫폼 호환성 경고 메시지(SYSLIB0006, SYSLIB0011, CA1416)
우선 SYSLIB0006 경고를 보면,
using System;
internal class Program
{
static void Main(string[] args)
{
Thread t = new Thread(() =>
{
for (int i = 0; ;i ++)
{
Console.Write(".");
Thread.Sleep(1000);
}
});
t.Start();
Console.ReadLine();
t.Abort();
Console.ReadLine();
}
}
위의 코드에서 Thread.Abort 호출에 대해 다음과 같은 경고가 발생합니다.
1>C:\Console1\Program.cs(19,9,19,18): warning SYSLIB0006: 'Thread.Abort()' is obsolete: 'Thread.Abort is not supported and throws PlatformNotSupportedException.'
비록 저것이 "경고(warning)"로 분류되었지만 반드시 저 코드는 수정되어야 합니다. 왜냐하면 실행 시에 .NET5+ 환경에서는 윈도우 환경일지라도 다음과 같이 예외가 발생하기 때문입니다. (.NET Core 3.1 이전에는 윈도우 환경에서 동작했던 코드입니다.)
Unhandled exception. System.PlatformNotSupportedException: Thread abort is not supported on this platform.
at System.Threading.Thread.Abort()
at Program.Main(String[] args) in C:\Console1\Program.cs:line 19
만약 소스 코드를 프로젝트(.NET Framework/.NET Core/.NET5+) 간에 공유하고 있다면, .NET 5.0 이후의 코드에서는 아예 빌드에서 누락시키는 것이 좋습니다.
#if !NET5_0_OR_GREATER
_thread.Abort(objValue);
#endif
이와 유사하게
SYSLIB0011 경고가, 예를 들어 BinaryFormatter를 사용하면 발생하는데요,
using System;
using System.Runtime.Serialization.Formatters.Binary;
using System.Runtime.Serialization;
internal class Program
{
static void Main(string[] args)
{
MemoryStream ms = new MemoryStream();
IFormatter formatter = new BinaryFormatter();
string text = "Hello World!";
formatter.Serialize(ms, text);
ms.Position = 0;
text = formatter.Deserialize(ms) as string;
Console.WriteLine(text);
}
}
1>C:\Console2\Program.cs(15,9,15,38): warning SYSLIB0011: 'IFormatter.Serialize(Stream, object)' is obsolete: 'BinaryFormatter serialization is obsolete and should not be used. See https://aka.ms/binaryformatter for more information.'
1>C:\Console2\Program.cs(18,16,18,41): warning SYSLIB0011: 'IFormatter.Deserialize(Stream)' is obsolete: 'BinaryFormatter serialization is obsolete and should not be used. See https://aka.ms/binaryformatter for more information.'
경고는 발생하지만, 아직 사용은 가능합니다. 따라서 이에 대해서는 경고를 suppress하는 정도의 표시를 해도 좋습니다.
#pragma warning disable SYSLIB0011
formatter.Serialize(ms, text);
#pragma warning restore SYSLIB0011
하지만, 마이크로소프트의 문서를 보면,
BinaryFormatter security guide
; https://learn.microsoft.com/en-us/dotnet/standard/serialization/binaryformatter-security-guide
The BinaryFormatter type is dangerous and is not recommended for data processing. Applications should stop using BinaryFormatter as soon as possible, even if they believe the data they're processing to be trustworthy. BinaryFormatter is insecure and can't be made secure.
보안 경고가 나옵니다. 제가 Log4j의 보안 결함에 대해 제대로 살펴본 것은 아니지만, 아마도 역직렬화 관련한 과정에서 코드 실행을 유발할 수 있게 되는 BinaryFormatter도 유사한 보안 문제를 일으키는 듯합니다.
따라서, 이참에 경고를 피하기 보다는 다른 직렬화/역직렬화 클래스로 변경하는 것이 좋겠습니다.
마지막으로 다음의 글에서 든 예제를,
C# - CoCreateInstance 관련 Inteop 오류 정리
; https://www.sysnet.pe.kr/2/0/12678
재사용해 이렇게 코드를 작성하면,
int hr = CoCreateInstance(CLSID_FolderInitHandler, IntPtr.Zero /* 0 */, CLSCTX.INPROC_SERVER, IID_IUnknown, ref pUnknown);
object obj = Marshal.GetTypedObjectForIUnknown(pUnknown, typeof(object));
Marshal.ReleaseComObject(obj);
GetTypedObjectForIUnknown, ReleaseComObject 호출에 대해 다음과 같은 CA1416 경고가 뜹니다.
1>C:\Console3\Program.cs(53,26,53,85): warning CA1416: This call site is reachable on all platforms. 'Marshal.GetTypedObjectForIUnknown(IntPtr, Type)' is only supported on: 'windows'.
1>C:\Console3\Program.cs(54,13,54,42): warning CA1416: This call site is reachable on all platforms. 'Marshal.ReleaseComObject(object)' is only supported on: 'windows'.
이에 대해서는 예전에 설명했지만,
C# - .NET 5+에서 warning CA1416: This call site is reachable on all platforms. '...' is only supported on: 'windows' 경고 발생
; https://www.sysnet.pe.kr/2/0/12901
가끔은, 해당 프로젝트가 Linux에서도, Windows에서도 실행돼야 할 때가 있을 것입니다. 그럴 때,
SupportedOSPlatform으로 제약하기보다는 단순히 윈도우 환경이 아니면 코드를 실행하지 않도록 하는 것도 방법입니다.
int hr = CoCreateInstance(CLSID_FolderInitHandler, IntPtr.Zero /* 0 */, CLSCTX.INPROC_SERVER, IID_IUnknown, ref pUnknown);
if (System.Runtime.InteropServices.RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
object obj = Marshal.GetTypedObjectForIUnknown(pUnknown, typeof(object));
Marshal.ReleaseComObject(obj);
}
/*
public readonly struct OSPlatform
{
public static OSPlatform FreeBSD { get; };
public static OSPlatform Linux { get; };
public static OSPlatform OSX { get; };
public static OSPlatform Windows { get; };
}
*/
재미있는 것은, Nullable Context에서 if 문으로 null 체크를 했던 것이 효력을 발휘했던 것처럼, 저렇게 OS를 구분하는 코드의 if 문을 감싸면 해당 코드에 대해 C# 컴파일 경고가 없어집니다. 마이크로소프트가... 엄청 신경썼군요. ^^ 하지만, 약간의 변화를 주면,
if (System.Runtime.InteropServices.RuntimeInformation.IsOSPlatform(OSPlatform.Windows) == false)
{
// ...
}
else
{
// 이런 경우에는 다시 CA1416 경고 발생
object obj = Marshal.GetTypedObjectForIUnknown(pUnknown, typeof(object));
Marshal.ReleaseComObject(obj);
}
따라서 저런 상황에서는 경고를 제거하는 코드까지 함께 곁들여야 합니다.
#pragma warning disable CA1416
object obj = Marshal.GetTypedObjectForIUnknown(pUnknown, typeof(object));
Marshal.ReleaseComObject(obj);
#pragma warning restore CA1416
(첨부 파일은 이 글의 3가지 상황에 대한 예제를 담고 있습니다.)
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]