add setting to disable credential provider per package source (#701)

Author: JoC0de

src/NuGetForUnity/Editor/Configuration/NugetConfigFile.cs

@@ -58,6 +58,8 @@ public class NugetConfigFile
 
         private const string ProtocolVersionAttributeName = "protocolVersion";
 
+        private const string EnableCredentialProviderAttributeName = "enableCredentialProvider";
+
         private const string PasswordAttributeName = "password";
 
         private const string UpdateSearchBatchSizeAttributeName = "updateSearchBatchSize";
@@ -392,7 +394,7 @@ public static NugetConfigFile CreateDefaultFile([NotNull] string filePath)
 <configuration>
   <packageSources>
     <clear />
-    <add key=""nuget.org"" value=""https://api.nuget.org/v3/index.json"" />
+    <add key=""nuget.org"" value=""https://api.nuget.org/v3/index.json"" enableCredentialProvider=""false"" />
   </packageSources>
   <disabledPackageSources />
   <activePackageSource>
@@ -438,6 +440,12 @@ public void Save([NotNull] string filePath)
                     addElement.Add(new XAttribute(ProtocolVersionAttributeName, source.SavedProtocolVersion));
                 }
 
+                if (!source.EnableCredentialProvider)
+                {
+                    addElement.Add(
+                        new XAttribute(EnableCredentialProviderAttributeName, source.EnableCredentialProvider.ToString().ToLowerInvariant()));
+                }
+
                 if (source is NugetPackageSourceV3 sourceV3)
                 {
                     if (!string.IsNullOrEmpty(sourceV3.PackageDownloadUrlTemplateOverwrite))

src/NuGetForUnity/Editor/Helper/CredentialProviderHelper.cs

@@ -60,8 +60,15 @@ public static (string UserName, string Password)? GetCredentialFromProvider([Not
             feedUri = GetTruncatedFeedUri(feedUri);
             if (!CachedCredentialsByFeedUri.TryGetValue(feedUri, out var response))
             {
-                response = GetCredentialFromProvider_Uncached(feedUri, true);
-                CachedCredentialsByFeedUri[feedUri] = response;
+                try
+                {
+                    response = GetCredentialFromProvider_Uncached(feedUri, true);
+                    CachedCredentialsByFeedUri[feedUri] = response;
+                }
+                catch (Exception exception)
+                {
+                    Debug.LogErrorFormat("Failed to get packages source credentials from the credential provider. Error: {0}", exception);
+                }
             }
 
             if (response == null)
@@ -356,9 +363,10 @@ private struct CredentialProviderResponse
             [CanBeNull]
             public string Password;
 
-            // Ignore Spelling: Username
             [CanBeNull]
             public string Username;
+
+            // Ignore Spelling: Username
         }
 #pragma warning restore 0649 // CS0649: Field 'field' is never assigned to, and will always have its default value 'value'
     }

src/NuGetForUnity/Editor/Helper/WebRequestHelper.cs

@@ -20,9 +20,15 @@ internal static class WebRequestHelper
         /// <param name="userName">UserName that will be passed in the Authorization header or the request. If null, authorization is omitted.</param>
         /// <param name="password">Password that will be passed in the Authorization header or the request. If null, authorization is omitted.</param>
         /// <param name="timeOut">Timeout in milliseconds or null to use the default timeout values of HttpWebRequest.</param>
+        /// <param name="enableCredentialProvider">If true we invoke credential providers found on the system to receive the credentials for the NuGet feed.</param>
         /// <returns>Stream containing the result.</returns>
         [NotNull]
-        internal static Stream RequestUrl([NotNull] string url, [CanBeNull] string userName, [CanBeNull] string password, int? timeOut)
+        internal static Stream RequestUrl(
+            [NotNull] string url,
+            [CanBeNull] string userName,
+            [CanBeNull] string password,
+            int? timeOut,
+            bool enableCredentialProvider)
         {
             // Mono doesn't have a Certificate Authority, so we have to provide all validation manually. Currently just accept anything.
             // See here: http://stackoverflow.com/questions/4926676/mono-webrequest-fails-with-https
@@ -35,7 +41,7 @@ internal static Stream RequestUrl([NotNull] string url, [CanBeNull] string userN
                 getRequest.AutomaticDecompression = DecompressionMethods.GZip | DecompressionMethods.None;
                 getRequest.Timeout = timeOut ?? ConfigurationManager.NugetConfigFile.RequestTimeoutSeconds * 1000;
 
-                if (string.IsNullOrEmpty(password))
+                if (string.IsNullOrEmpty(password) && enableCredentialProvider)
                 {
                     var credentials = CredentialProviderHelper.GetCredentialFromProvider(getRequest.RequestUri);
                     if (credentials.HasValue)

src/NuGetForUnity/Editor/PackageSource/INugetPackageSource.cs

@@ -64,6 +64,13 @@ public interface INugetPackageSource : IDisposable
         /// </summary>
         bool CredentialsStoredInExternalFile { get; set; }
 
+        /// <summary>
+        ///     Gets or sets a value indicating whether to invoke credential providers found on the system to
+        ///     receive the credentials for the NuGet feed. See here for more info on NuGet Credential Providers:
+        ///     https://docs.microsoft.com/en-us/nuget/reference/extensibility/nuget-exe-credential-providers.
+        /// </summary>
+        bool EnableCredentialProvider { get; set; }
+
         /// <summary>
         ///     Download the .nupkg file and store it inside a file at <paramref name="outputFilePath" />.
         /// </summary>

src/NuGetForUnity/Editor/PackageSource/NugetApiClientV3.cs

@@ -1,5 +1,7 @@
 #pragma warning disable SA1512,SA1124 // Single-line comments should not be followed by blank line
 
+#region No ReShaper
+
 using System;
 using System.Collections.Generic;
 using System.Globalization;
@@ -18,8 +20,6 @@
 using UnityEditor;
 using UnityEngine;
 
-#region No ReShaper
-
 // ReSharper disable All
 // needed because 'JetBrains.Annotations.NotNull' and 'System.Diagnostics.CodeAnalysis.NotNull' collide if this file is compiled with a never version of Unity / C#
 using SuppressMessageAttribute = System.Diagnostics.CodeAnalysis.SuppressMessageAttribute;
@@ -778,7 +778,7 @@ private void AddHeadersToRequest(HttpRequestMessage request, NugetPackageSourceV
             var password = packageSource.ExpandedPassword;
             var userName = packageSource.ExpandedUserName;
 
-            if (string.IsNullOrEmpty(password))
+            if (string.IsNullOrEmpty(password) && packageSource.EnableCredentialProvider)
             {
                 var creds = CredentialProviderHelper.GetCredentialFromProvider(apiIndexJsonUrl);
                 if (creds.HasValue)

src/NuGetForUnity/Editor/PackageSource/NugetPackageSourceCombined.cs

@@ -118,6 +118,17 @@ public bool CredentialsStoredInExternalFile
             }
         }
 
+        /// <inheritdoc />
+        public bool EnableCredentialProvider
+        {
+            get => false;
+
+            set
+            {
+                // multiple sources can't have credentials
+            }
+        }
+
         /// <inheritdoc />
         public List<INugetPackage> FindPackagesById(INugetPackageIdentifier package)
         {

src/NuGetForUnity/Editor/PackageSource/NugetPackageSourceLocal.cs

@@ -44,7 +44,7 @@ public string SavedProtocolVersion
 
             set
             {
-                // multiple sources can't have protocol version
+                // local sources can't have protocol version
             }
         }
 
@@ -107,6 +107,17 @@ public bool CredentialsStoredInExternalFile
             }
         }
 
+        /// <inheritdoc />
+        public bool EnableCredentialProvider
+        {
+            get => false;
+
+            set
+            {
+                // local sources can't have credentials
+            }
+        }
+
         /// <summary>
         ///     Gets path, with the values of environment variables expanded.
         /// </summary>

src/NuGetForUnity/Editor/PackageSource/NugetPackageSourceV2.cs

@@ -91,6 +91,10 @@ public string ExpandedPath
         [field: SerializeField]
         public bool CredentialsStoredInExternalFile { get; set; }
 
+        /// <inheritdoc />
+        [field: SerializeField]
+        public bool EnableCredentialProvider { get; set; } = true;
+
         /// <summary>
         ///     Gets password, with the values of environment variables expanded.
         /// </summary>
@@ -400,7 +404,7 @@ public void DownloadNupkgToFile(INugetPackageIdentifier package, string outputFi
                 throw new ArgumentNullException(nameof(downloadUrlHint));
             }
 
-            using (var objStream = WebRequestHelper.RequestUrl(downloadUrlHint, ExpandedUserName, ExpandedPassword, null))
+            using (var objStream = WebRequestHelper.RequestUrl(downloadUrlHint, ExpandedUserName, ExpandedPassword, null, EnableCredentialProvider))
             {
                 using (var fileStream = File.Create(outputFilePath))
                 {
@@ -486,7 +490,7 @@ private List<INugetPackage> GetPackagesFromUrl([NotNull] string url)
             stopwatch.Start();
 
             var packages = new List<INugetPackage>();
-            using (var responseStream = WebRequestHelper.RequestUrl(url, ExpandedUserName, ExpandedPassword, 10000))
+            using (var responseStream = WebRequestHelper.RequestUrl(url, ExpandedUserName, ExpandedPassword, 10000, EnableCredentialProvider))
             {
                 using (var streamReader = new StreamReader(responseStream))
                 {

src/NuGetForUnity/Editor/PackageSource/NugetPackageSourceV3.cs

@@ -145,6 +145,10 @@ public string PackageDownloadUrlTemplateOverwrite
         [field: SerializeField]
         public bool CredentialsStoredInExternalFile { get; set; }
 
+        /// <inheritdoc />
+        [field: SerializeField]
+        public bool EnableCredentialProvider { get; set; } = true;
+
         /// <inheritdoc />
         [field: SerializeField]
         public bool IsEnabled { get; set; }

src/NuGetForUnity/Editor/Ui/NugetPreferences.cs

@@ -443,8 +443,9 @@ public override void OnGUI([CanBeNull] string searchContext)
                                 }
                             }
 
+                            const string useCredentialProviderToogleLabel = "Use credential provider (if found)";
                             biggestPackageSourceSectionLabelSize = biggestPackageSourceSectionLabelSize ??
-                                                                   EditorStyles.label.CalcSize(new GUIContent("Force use API v3")).x;
+                                                                   EditorStyles.label.CalcSize(new GUIContent(useCredentialProviderToogleLabel)).x;
                             EditorGUIUtility.labelWidth = biggestPackageSourceSectionLabelSize.Value + LabelPading;
 
                             var currentForceUseApiV3 = source.SavedProtocolVersion?.Equals("3", StringComparison.Ordinal) == true;
@@ -453,7 +454,7 @@ public override void OnGUI([CanBeNull] string searchContext)
                                 var forceUseApiV3 = EditorGUILayout.Toggle(
                                     new GUIContent(
                                         "Force use API v3",
-                                        "Normally the API version is autodetect. " +
+                                        "Normally the API version is automatically detected. " +
                                         "It defaults to version \"2\" when not pointing to a package source URL ending in .json (e.g. https://api.nuget.org/v3/index.json). " +
                                         "So if a package source uses API v3 but the URL doesn't end in .json you need to enable this setting (e.g. needed when using 'Aritfactory')."),
                                     currentForceUseApiV3);
@@ -497,6 +498,17 @@ public override void OnGUI([CanBeNull] string searchContext)
                                 else
                                 {
                                     source.SavedUserName = null;
+
+                                    var enableCredentialProvider = EditorGUILayout.Toggle(
+                                        new GUIContent(
+                                            useCredentialProviderToogleLabel,
+                                            "Whether to call the credential providers found on the system to receive the credentials for the NuGet feed. See NuGet documentation for more info on NuGet Credential Providers: https://docs.microsoft.com/en-us/nuget/reference/extensibility/nuget-exe-credential-providers."),
+                                        source.EnableCredentialProvider);
+                                    if (enableCredentialProvider != source.EnableCredentialProvider)
+                                    {
+                                        source.EnableCredentialProvider = enableCredentialProvider;
+                                        preferencesChangedThisFrame = true;
+                                    }
                                 }
                             }