Enabling CA1416: Validate platform compatibility (#41760)

tannergooding · web-flow · commit 23919a4b58d8 · 2020-09-10T10:51:09.000-07:00
* Enabling CA1416

* Resolving PR feedback

* Updating the .NET analyzers to 5.0.0-rc2.20458.2

* Resolving compilation errors on full framework

* Fixing two more tfm issues with the platform compat checks

* Adjusting various platform compat checks to work with netstandard and netfx
diff --git a/eng/Analyzers.props b/eng/Analyzers.props
@@ -6,7 +6,7 @@
   </PropertyGroup>
   <ItemGroup Condition="'$(EnableAnalyzers)' == 'true'">
     <PackageReference Include="Microsoft.DotNet.CodeAnalysis" Version="$(MicrosoftDotNetCodeAnalysisVersion)" PrivateAssets="all" IsImplicitlyDefined="true" />
-    <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="5.0.0-rc1.20413.9" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="5.0.0-rc2.20458.2" PrivateAssets="all" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.164" PrivateAssets="all" />
   </ItemGroup>
 </Project>
diff --git a/eng/CodeAnalysis.ruleset b/eng/CodeAnalysis.ruleset
@@ -64,7 +64,7 @@
       <Rule Id="CA1308" Action="None" />             <!-- Normalize strings to uppercase -->
       <Rule Id="CA1309" Action="None" />             <!-- Use ordinal stringcomparison -->
       <Rule Id="CA1401" Action="Warning" />          <!-- P/Invokes should not be visible -->
-      <Rule Id="CA1416" Action="None" />             <!-- Validate platform compatibility; https://github.com/dotnet/runtime/issues/41354 -->
+      <Rule Id="CA1416" Action="Warning" />          <!-- Validate platform compatibility -->
       <Rule Id="CA1417" Action="Warning" />          <!-- Do not use 'OutAttribute' on string parameters for P/Invokes -->
       <Rule Id="CA1501" Action="None" />             <!-- Avoid excessive inheritance -->
       <Rule Id="CA1502" Action="None" />             <!-- Avoid excessive complexity -->
diff --git a/src/libraries/Common/src/Interop/Windows/NCrypt/Interop.Properties.cs b/src/libraries/Common/src/Interop/Windows/NCrypt/Interop.Properties.cs
@@ -1,9 +1,11 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System;
+using System.Diagnostics;
 using System.Runtime.InteropServices;
+using System.Runtime.Versioning;
 using System.Security.Cryptography;
-using System.Diagnostics;
 
 using Microsoft.Win32.SafeHandles;
 
@@ -17,6 +19,7 @@ internal static partial class NCrypt
         [DllImport(Interop.Libraries.NCrypt, CharSet = CharSet.Unicode)]
         internal static extern unsafe ErrorCode NCryptSetProperty(SafeNCryptHandle hObject, string pszProperty, [In] void* pbInput, int cbInput, CngPropertyOptions dwFlags);
 
+        [SupportedOSPlatform("windows")]
         internal static ErrorCode NCryptGetByteProperty(SafeNCryptHandle hObject, string pszProperty, ref byte result, CngPropertyOptions options = CngPropertyOptions.None)
         {
             int cbResult;
@@ -53,6 +56,10 @@ internal static ErrorCode NCryptGetIntProperty(SafeNCryptHandle hObject, string
             {
                 fixed (int* pResult = &result)
                 {
+#if NETSTANDARD || NETCOREAPP
+                    Debug.Assert(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
+#endif
+
                     errorCode = Interop.NCrypt.NCryptGetProperty(
                         hObject,
                         pszProperty,
diff --git a/src/libraries/Common/src/Interop/Windows/WinSock/SafeNativeOverlapped.cs b/src/libraries/Common/src/Interop/Windows/WinSock/SafeNativeOverlapped.cs
@@ -57,6 +57,7 @@ private void FreeNativeOverlapped()
             {
                 unsafe
                 {
+                    Debug.Assert(OperatingSystem.IsWindows());
                     Debug.Assert(_socketHandle != null, "_socketHandle is null.");
 
                     ThreadPoolBoundHandle? boundHandle = _socketHandle.IOCPBoundHandle;
diff --git a/src/libraries/Common/src/System/Net/ContextAwareResult.Windows.cs b/src/libraries/Common/src/System/Net/ContextAwareResult.Windows.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 #nullable enable
+using System.Diagnostics;
 using System.Security.Principal;
 
 namespace System.Net
@@ -13,13 +14,15 @@ internal partial class ContextAwareResult
         // Security: We need an assert for a call into WindowsIdentity.GetCurrent.
         private void SafeCaptureIdentity()
         {
+            Debug.Assert(OperatingSystem.IsWindows());
             _windowsIdentity = WindowsIdentity.GetCurrent();
         }
 
         private void CleanupInternal()
         {
             if (_windowsIdentity != null)
             {
+                Debug.Assert(OperatingSystem.IsWindows());
                 _windowsIdentity.Dispose();
                 _windowsIdentity = null;
             }
diff --git a/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogLogger.cs b/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogLogger.cs
@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.Runtime.InteropServices;
 using System.Text;
 
 namespace Microsoft.Extensions.Logging.EventLog
@@ -166,6 +167,10 @@ private void WriteMessage(string message, EventLogEntryType eventLogEntryType, i
 
         private EventLogEntryType GetEventLogEntryType(LogLevel level)
         {
+#if NETSTANDARD
+            Debug.Assert(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
+#endif
+
             switch (level)
             {
                 case LogLevel.Information:
diff --git a/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogLoggerProvider.cs b/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogLoggerProvider.cs
@@ -2,6 +2,8 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System;
+using System.Diagnostics;
+using System.Runtime.InteropServices;
 using Microsoft.Extensions.Options;
 
 namespace Microsoft.Extensions.Logging.EventLog
@@ -53,6 +55,9 @@ public void Dispose()
         {
             if (_settings.EventLog is WindowsEventLog windowsEventLog)
             {
+#if NETSTANDARD
+                Debug.Assert(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
+#endif
                 windowsEventLog.DiagnosticsEventLog.Dispose();
             }
         }
diff --git a/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogSettings.cs b/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogSettings.cs
@@ -2,6 +2,8 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System;
+using System.Diagnostics;
+using System.Runtime.InteropServices;
 
 namespace Microsoft.Extensions.Logging.EventLog
 {
@@ -53,6 +55,9 @@ private IEventLog CreateDefaultEventLog()
                 defaultEventId = 1000;
             }
 
+#if NETSTANDARD
+            Debug.Assert(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
+#endif
             return new WindowsEventLog(logName, machineName, sourceName) { DefaultEventId = defaultEventId };
         }
     }
diff --git a/src/libraries/Microsoft.Extensions.Logging.EventLog/src/Microsoft.Extensions.Logging.EventLog.csproj b/src/libraries/Microsoft.Extensions.Logging.EventLog/src/Microsoft.Extensions.Logging.EventLog.csproj
@@ -3,6 +3,7 @@
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0;net461</TargetFrameworks>
     <EnableDefaultItems>true</EnableDefaultItems>
+    <IncludePlatformAttributes>true</IncludePlatformAttributes>
   </PropertyGroup>
 
   <ItemGroup>
@@ -18,7 +19,7 @@
     <ProjectReference Include="$(LibrariesProjectRoot)Microsoft.Extensions.Logging.Abstractions\src\Microsoft.Extensions.Logging.Abstractions.csproj" />
     <ProjectReference Include="$(LibrariesProjectRoot)Microsoft.Extensions.Options\src\Microsoft.Extensions.Options.csproj" />
   </ItemGroup>
-  
+
   <ItemGroup Condition="!$(TargetFramework.StartsWith('net4'))">
     <ProjectReference Include="$(LibrariesProjectRoot)System.Diagnostics.EventLog\src\System.Diagnostics.EventLog.csproj" />
   </ItemGroup>
diff --git a/src/libraries/Microsoft.Extensions.Logging.EventLog/src/WindowsEventLog.cs b/src/libraries/Microsoft.Extensions.Logging.EventLog/src/WindowsEventLog.cs
@@ -4,9 +4,11 @@
 using System;
 using System.Diagnostics;
 using System.Security;
+using System.Runtime.Versioning;
 
 namespace Microsoft.Extensions.Logging.EventLog
 {
+    [SupportedOSPlatform("windows")]
     internal class WindowsEventLog : IEventLog
     {
         // https://msdn.microsoft.com/EN-US/library/windows/desktop/aa363679.aspx
diff --git a/src/libraries/System.Drawing.Common/src/System/Drawing/Icon.Windows.cs b/src/libraries/System.Drawing.Common/src/System/Drawing/Icon.Windows.cs
@@ -657,6 +657,7 @@ public void Save(Stream outputStream)
                     }
                     finally
                     {
+                        Debug.Assert(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
                         Marshal.ReleaseComObject(picture);
                     }
                 }
diff --git a/src/libraries/System.Drawing.Common/src/System/Drawing/Internal/SystemColorTracker.cs b/src/libraries/System.Drawing.Common/src/System/Drawing/Internal/SystemColorTracker.cs
@@ -39,6 +39,7 @@ internal static void Add(ISystemColorTracker obj)
 
                 if (!addedTracker)
                 {
+                    Debug.Assert(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
                     addedTracker = true;
                     SystemEvents.UserPreferenceChanged += new UserPreferenceChangedEventHandler(OnUserPreferenceChanged);
                 }
@@ -131,6 +132,7 @@ private static void GarbageCollectList()
 
         private static void OnUserPreferenceChanged(object sender, UserPreferenceChangedEventArgs e)
         {
+            Debug.Assert(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
 
             // Update pens and brushes
             if (e.Category == UserPreferenceCategory.Color)
diff --git a/src/libraries/System.IO.Ports/src/System/IO/Ports/SerialPort.Win32.cs b/src/libraries/System.IO.Ports/src/System/IO/Ports/SerialPort.Win32.cs
@@ -3,6 +3,8 @@
 
 using Microsoft.Win32;
 using System.ComponentModel;
+using System.Diagnostics;
+using System.Runtime.InteropServices;
 
 namespace System.IO.Ports
 {
@@ -17,6 +19,10 @@ public static string[] GetPortNames()
             //
             // QueryDosDevice involves finding any ports that map to \Device\Serialx (call with null to get all, then iterate to get the actual device name)
 
+#if NETSTANDARD
+            Debug.Assert(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
+#endif
+
             using (RegistryKey serialKey = Registry.LocalMachine.OpenSubKey(@"HARDWARE\DEVICEMAP\SERIALCOMM"))
             {
                 if (serialKey != null)
diff --git a/src/libraries/System.Net.Sockets/src/System/Net/Sockets/BaseOverlappedAsyncResult.Windows.cs b/src/libraries/System.Net.Sockets/src/System/Net/Sockets/BaseOverlappedAsyncResult.Windows.cs
@@ -50,6 +50,7 @@ internal void SetUnmanagedStructures(object? objectsToPin)
 
             unsafe
             {
+                Debug.Assert(OperatingSystem.IsWindows());
                 NativeOverlapped* overlapped = boundHandle.AllocateNativeOverlapped(s_ioCallback, this, objectsToPin);
                 _nativeOverlapped = new SafeNativeOverlapped(s.SafeHandle, overlapped);
             }
@@ -59,6 +60,7 @@ internal void SetUnmanagedStructures(object? objectsToPin)
 
         private static unsafe void CompletionPortCallback(uint errorCode, uint numBytes, NativeOverlapped* nativeOverlapped)
         {
+            Debug.Assert(OperatingSystem.IsWindows());
             BaseOverlappedAsyncResult asyncResult = (BaseOverlappedAsyncResult)ThreadPoolBoundHandle.GetNativeOverlappedState(nativeOverlapped)!;
 
             if (asyncResult.InternalPeekCompleted)
diff --git a/src/libraries/System.Net.Sockets/src/System/Net/Sockets/SafeSocketHandle.Windows.cs b/src/libraries/System.Net.Sockets/src/System/Net/Sockets/SafeSocketHandle.Windows.cs
@@ -48,6 +48,7 @@ internal ThreadPoolBoundHandle GetOrAllocateThreadPoolBoundHandle(bool trySkipCo
 
                     try
                     {
+                        Debug.Assert(OperatingSystem.IsWindows());
                         // The handle (this) may have been already released:
                         // E.g.: The socket has been disposed in the main thread. A completion callback may
                         //       attempt starting another operation.
@@ -105,6 +106,7 @@ private bool OnHandleClose()
             // ThreadPoolBoundHandle allows FreeNativeOverlapped even after it has been disposed.
             if (_iocpBoundHandle != null)
             {
+                Debug.Assert(OperatingSystem.IsWindows());
                 _iocpBoundHandle.Dispose();
             }
 
diff --git a/src/libraries/System.Net.Sockets/src/System/Net/Sockets/SocketAsyncEventArgs.Windows.cs b/src/libraries/System.Net.Sockets/src/System/Net/Sockets/SocketAsyncEventArgs.Windows.cs
@@ -56,6 +56,7 @@ private void InitializeInternals()
             bool suppressFlow = !ExecutionContext.IsFlowSuppressed();
             try
             {
+                Debug.Assert(OperatingSystem.IsWindows());
                 if (suppressFlow) ExecutionContext.SuppressFlow();
                 _preAllocatedOverlapped = new PreAllocatedOverlapped(s_completionPortCallback, _strongThisRef, null);
             }
@@ -75,6 +76,7 @@ private void FreeInternals()
 
         private unsafe NativeOverlapped* AllocateNativeOverlapped()
         {
+            Debug.Assert(OperatingSystem.IsWindows());
             Debug.Assert(_operating == InProgress, $"Expected {nameof(_operating)} == {nameof(InProgress)}, got {_operating}");
             Debug.Assert(_currentSocket != null, "_currentSocket is null");
             Debug.Assert(_currentSocket.SafeHandle != null, "_currentSocket.SafeHandle is null");
@@ -86,6 +88,7 @@ private void FreeInternals()
 
         private unsafe void FreeNativeOverlapped(NativeOverlapped* overlapped)
         {
+            Debug.Assert(OperatingSystem.IsWindows());
             Debug.Assert(overlapped != null, "overlapped is null");
             Debug.Assert(_operating == InProgress, $"Expected _operating == InProgress, got {_operating}");
             Debug.Assert(_currentSocket != null, "_currentSocket is null");
@@ -904,6 +907,7 @@ private void FreeOverlapped()
             // any pinned buffers.
             if (_preAllocatedOverlapped != null)
             {
+                Debug.Assert(OperatingSystem.IsWindows());
                 _preAllocatedOverlapped.Dispose();
                 _preAllocatedOverlapped = null!;
             }
@@ -1219,7 +1223,9 @@ private void FinishOperationSendPackets()
 
         private static readonly unsafe IOCompletionCallback s_completionPortCallback = delegate (uint errorCode, uint numBytes, NativeOverlapped* nativeOverlapped)
         {
-            var saeaBox = (StrongBox<SocketAsyncEventArgs>)ThreadPoolBoundHandle.GetNativeOverlappedState(nativeOverlapped)!;
+            Debug.Assert(OperatingSystem.IsWindows());
+            var saeaBox = (StrongBox<SocketAsyncEventArgs>)(ThreadPoolBoundHandle.GetNativeOverlappedState(nativeOverlapped)!);
+
             Debug.Assert(saeaBox.Value != null);
             SocketAsyncEventArgs saea = saeaBox.Value;
 
diff --git a/src/libraries/System.Security.Cryptography.Pkcs/src/Internal/Cryptography/Pal/Windows/PkcsPalWindows.cs b/src/libraries/System.Security.Cryptography.Pkcs/src/Internal/Cryptography/Pal/Windows/PkcsPalWindows.cs
@@ -129,6 +129,10 @@ public sealed override byte[] GetSubjectKeyIdentifier(X509Certificate2 certifica
 
                 if (keySpec == CryptKeySpec.CERT_NCRYPT_KEY_SPEC)
                 {
+#if NETSTANDARD || NETCOREAPP
+                    Debug.Assert(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
+#endif
+
                     using (SafeNCryptKeyHandle keyHandle = new SafeNCryptKeyHandle(handle.DangerousGetHandle(), handle))
                     {
                         CngKeyHandleOpenOptions options = CngKeyHandleOpenOptions.None;

Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,7 @@ private void FreeNativeOverlapped()`
`57`	`57`	`{`
`58`	`58`	`unsafe`
`59`	`59`	`{`
	`60`	`+ Debug.Assert(OperatingSystem.IsWindows());`
`60`	`61`	`Debug.Assert(_socketHandle != null, "_socketHandle is null.");`
`61`	`62`
`62`	`63`	`ThreadPoolBoundHandle? boundHandle = _socketHandle.IOCPBoundHandle;`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`// The .NET Foundation licenses this file to you under the MIT license.`
`3`	`3`
`4`	`4`	`#nullable enable`
	`5`	`+using System.Diagnostics;`
`5`	`6`	`using System.Security.Principal;`
`6`	`7`
`7`	`8`	`namespace System.Net`
`@@ -13,13 +14,15 @@ internal partial class ContextAwareResult`
`13`	`14`	`// Security: We need an assert for a call into WindowsIdentity.GetCurrent.`
`14`	`15`	`private void SafeCaptureIdentity()`
`15`	`16`	`{`
	`17`	`+ Debug.Assert(OperatingSystem.IsWindows());`
`16`	`18`	`_windowsIdentity = WindowsIdentity.GetCurrent();`
`17`	`19`	`}`
`18`	`20`
`19`	`21`	`private void CleanupInternal()`
`20`	`22`	`{`
`21`	`23`	`if (_windowsIdentity != null)`
`22`	`24`	`{`
	`25`	`+ Debug.Assert(OperatingSystem.IsWindows());`
`23`	`26`	`_windowsIdentity.Dispose();`
`24`	`27`	`_windowsIdentity = null;`
`25`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@`
`2`	`2`	`// The .NET Foundation licenses this file to you under the MIT license.`
`3`	`3`
`4`	`4`	`using System;`
	`5`	`+using System.Diagnostics;`
	`6`	`+using System.Runtime.InteropServices;`
`5`	`7`	`using Microsoft.Extensions.Options;`
`6`	`8`
`7`	`9`	`namespace Microsoft.Extensions.Logging.EventLog`
`@@ -53,6 +55,9 @@ public void Dispose()`
`53`	`55`	`{`
`54`	`56`	`if (_settings.EventLog is WindowsEventLog windowsEventLog)`
`55`	`57`	`{`
	`58`	`+#if NETSTANDARD`
	`59`	`+ Debug.Assert(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));`
	`60`	`+#endif`
`56`	`61`	`windowsEventLog.DiagnosticsEventLog.Dispose();`
`57`	`62`	`}`
`58`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,11 @@`
`4`	`4`	`using System;`
`5`	`5`	`using System.Diagnostics;`
`6`	`6`	`using System.Security;`
	`7`	`+using System.Runtime.Versioning;`
`7`	`8`
`8`	`9`	`namespace Microsoft.Extensions.Logging.EventLog`
`9`	`10`	`{`
	`11`	`+ [SupportedOSPlatform("windows")]`
`10`	`12`	`internal class WindowsEventLog : IEventLog`
`11`	`13`	`{`
`12`	`14`	`// https://msdn.microsoft.com/EN-US/library/windows/desktop/aa363679.aspx`