♻️ Changes to improve tests

Author: bernardbr

src/DigestAuthenticator/DigestAuthenticator.cs

@@ -1,52 +1,47 @@
+using System.Net;
+
 namespace RestSharp.Authenticators.Digest
 {
-    using System.Net;
-
-    using RestSharp.Authenticators;
-    using RestSharp;
-
     /// <summary>
-    /// Digest midleware for <see cref="IRestClient"/>.
+    ///     Digest middleware for <see cref="IRestClient" />.
     /// </summary>
     public class DigestAuthenticator : IAuthenticator
     {
-        /// <summary>
-        /// The username.
-        /// </summary>
-        private readonly string username;
-
-        /// <summary>
-        /// The password.
-        /// </summary>
-        private readonly string password;
+        private const int DEFAULT_TIMEOUT = 100000;
+        private readonly string _password;
 
+        private readonly string _username;
 
         /// <summary>
-        /// The timeout.
-        /// </summary>
-        public int Timeout { get; set; } = 100000; //default WebRequest timeout
-
-        /// <summary>
-        /// Creates a new instance of <see cref="DigestAuthenticator"/> class.
+        ///     Creates a new instance of <see cref="DigestAuthenticator" /> class.
         /// </summary>
         /// <param name="username">The username.</param>
         /// <param name="password">The password.</param>
         public DigestAuthenticator(string username, string password)
         {
-            this.username = username;
-            this.password = password;
-        } 
+            _username = username;
+            _password = password;
+            Timeout = DEFAULT_TIMEOUT;
+        }
+
+        /// <summary>
+        ///     The web request timeout (default 100000).
+        /// </summary>
+        public int Timeout { get; set; }
 
-        /// <inheritdoc cref="IAuthenticator" />.
+        /// <inheritdoc cref="IAuthenticator" />
         public void Authenticate(IRestClient client, IRestRequest request)
         {
-            request.Credentials = new NetworkCredential(username, this.password); 
+            // TODO: We must check this to use the new way.
+#pragma warning disable CS0618
+            request.Credentials = new NetworkCredential(_username, _password);
+#pragma warning restore CS0618
 
             var uri = client.BuildUri(request);
-            var manager = new DigestAuthenticatorManager(client.BaseUrl, this.username, this.password, Timeout);
+            var manager = new DigestAuthenticatorManager(client.BaseUrl, _username, _password, Timeout);
             manager.GetDigestAuthHeader(uri.PathAndQuery, request.Method);
             var digestHeader = manager.GetDigestHeader(uri.PathAndQuery, request.Method);
             request.AddParameter("Authorization", digestHeader, ParameterType.HttpHeader);
         }
-    } 
-}
+    }
+}

src/DigestAuthenticator/DigestAuthenticator.csproj

@@ -8,7 +8,6 @@
     <OutputType>Library</OutputType>
     <IsPackable>true</IsPackable>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
-    <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0</TargetFrameworks>

src/DigestAuthenticator/DigestAuthenticatorManager.cs

@@ -1,88 +1,48 @@
-namespace RestSharp.Authenticators.Digest
+using System;
+using System.Diagnostics;
+using System.Globalization;
+using System.Linq;
+using System.Net;
+using System.Security.Cryptography;
+using System.Text;
+
+namespace RestSharp.Authenticators.Digest
 {
-    using System.Collections.Generic;
-    using System.Globalization;
-    using System.Linq;
-    using System.Net;
-    using System.Security.Cryptography;
-    using System.Text;
-    using System.Text.RegularExpressions;
-    using System;
-
-    using RestSharp;
-
     /// <summary>
-    /// DigestAuthenticatorManager class.
+    ///     DigestAuthenticatorManager class.
     /// </summary>
     internal class DigestAuthenticatorManager
     {
-        /// <summary>
-        /// Header Realm.
-        /// </summary>
-        private const string DIGEST_REALM = "Digest realm";
-
-        /// <summary>
-        /// Header Realm.
-        /// </summary>
-        private const string REALM = "realm";
-
-        /// <summary>
-        /// Header nonce.
-        /// </summary>
-        private const string NONCE = "nonce";
-
-        /// <summary>
-        /// Header qop.
-        /// </summary>
-        private const string QOP = "qop";
-
-        /// <summary>
-        /// The host.
-        /// </summary>
         private readonly Uri _host;
 
-        /// <summary>
-        /// The user.
-        /// </summary>
-        private readonly string _username;
-
-        /// <summary>
-        /// The password.
-        /// </summary>
         private readonly string _password;
 
-        /// <summary>
-        /// The timeout.
-        /// </summary>
         private readonly int _timeout;
 
+        private readonly string _username;
+
         /// <summary>
-        /// The Realm that is returned by the first digest request (without the data).
+        ///     The cnounce that is generated randomly by the application.
         /// </summary>
-        private string _realm;
+        private string _cnonce;
 
         /// <summary>
-        /// The nonce that is returned by the first digest request (without the data).
+        ///     The nonce that is returned by the first digest request (without the data).
         /// </summary>
         private string _nonce;
 
         /// <summary>
-        /// The qop that is returned by the first digest request (without the data).
+        ///     The qop that is returned by the first digest request (without the data).
         /// </summary>
         private string _qop;
 
         /// <summary>
-        /// The cnounce that is generated randomly by the application.
+        ///     The Realm that is returned by the first digest request (without the data).
         /// </summary>
-        private string _cnonce;
-
-        /// <summary>
-        /// The nounce count (usually 000001)
-        /// </summary>
-        private const int NONCE_COUNT = 1;
+        private string _realm;
 
         /// <summary>
-        /// Creates a new instance of <see cref="DigestAuthenticatorManager"/> class.
+        ///     Creates a new instance of <see cref="DigestAuthenticatorManager" /> class.
         /// </summary>
         /// <param name="host">The host.</param>
         /// <param name="username">The username.</param>
@@ -97,58 +57,22 @@ public DigestAuthenticatorManager(Uri host, string username, string password, in
         }
 
         /// <summary>
-        /// Generate the MD5 Hash.
-        /// </summary>
-        /// <param name="input">The input.</param>
-        /// <returns>The MD5.</returns>
-        private static string GenerateMD5(string input)
-        {
-            var inputBytes = Encoding.ASCII.GetBytes(input);
-            var hash = MD5.Create().ComputeHash(inputBytes);
-            var stringBuilder = new StringBuilder();
-            hash.ToList().ForEach(b => stringBuilder.Append(b.ToString("x2")));
-            return stringBuilder.ToString();
-        }
-
-        /// <summary>
-        /// Gets the digest header.
-        /// </summary>
-        /// <param name="digestUri">The digest uri.</param>
-        /// <param name="method">The method.</param>
-        /// <returns>The digest header.</returns>
-        public string GetDigestHeader(string digestUri, Method method)
-        {
-            var hash1 = GenerateMD5($"{_username}:{_realm}:{_password}");
-            var hash2 = GenerateMD5($"{method}:{digestUri}");
-            var digestResponse = GenerateMD5($"{hash1}:{_nonce}:{NONCE_COUNT:00000000}:{_cnonce}:{_qop}:{hash2}");
-            return $"Digest username=\"{_username}\"," +
-                $"realm=\"{_realm}\"," +
-                $"nonce=\"{_nonce}\"," +
-                $"uri=\"{digestUri}\"," +
-                "algorithm=MD5," +
-                $"response=\"{digestResponse}\"," +
-                $"qop={_qop}," +
-                $"nc={NONCE_COUNT:00000000}," +
-                $"cnonce=\"{_cnonce}\"";
-        }
-
-        /// <summary>
-        /// Gets the digest auth header.
+        ///     Gets the digest auth header.
         /// </summary>
         /// <param name="path">The request path.</param>
         /// <param name="method">The request method.</param>
         public void GetDigestAuthHeader(string path, Method method)
         {
             var uri = new Uri(_host, path);
-            var request = (HttpWebRequest)WebRequest.Create(uri);
+            var request = (HttpWebRequest) WebRequest.Create(uri);
             request.Method = method.ToString();
             request.ContentLength = 0;
             request.Timeout = _timeout;
 
             try
             {
-                var response = (HttpWebResponse)request.GetResponse();
-                System.Diagnostics.Debug.WriteLine(response);
+                var response = (HttpWebResponse) request.GetResponse();
+                Debug.WriteLine(response);
             }
             catch (WebException ex)
             {
@@ -157,105 +81,58 @@ public void GetDigestAuthHeader(string path, Method method)
         }
 
         /// <summary>
-        /// Gets the digest data from exception.
+        ///     Gets the digest header.
         /// </summary>
-        /// <param name="ex">The exception.</param>
-        private void GetDigestDataFromException(WebException ex)
+        /// <param name="digestUri">The digest uri.</param>
+        /// <param name="method">The method.</param>
+        /// <returns>The digest header.</returns>
+        public string GetDigestHeader(string digestUri, Method method)
         {
-            if (ex.Response == null || ((HttpWebResponse)ex.Response).StatusCode != HttpStatusCode.Unauthorized)
-            {
-                throw ex;
-            }
-
-            var wwwAuthenticateHeader = TransformHeaderToDictionary(
-                ex.Response.Headers["WWW-Authenticate"]
-            );
-
-            _cnonce = new Random()
-                .Next(123400, 9999999)
-                .ToString(CultureInfo.InvariantCulture);
-
-            _realm = wwwAuthenticateHeader.GetHeader(REALM);
-            _nonce = wwwAuthenticateHeader.GetHeader(NONCE);
-            _qop = wwwAuthenticateHeader.GetHeader(QOP);
+            var hash1 = GenerateMD5($"{_username}:{_realm}:{_password}");
+            var hash2 = GenerateMD5($"{method}:{digestUri}");
+            var digestResponse =
+                GenerateMD5($"{hash1}:{_nonce}:{DigestHeader.NONCE_COUNT:00000000}:{_cnonce}:{_qop}:{hash2}");
+            return $"Digest username=\"{_username}\"," +
+                   $"realm=\"{_realm}\"," +
+                   $"nonce=\"{_nonce}\"," +
+                   $"uri=\"{digestUri}\"," +
+                   "algorithm=MD5," +
+                   $"response=\"{digestResponse}\"," +
+                   $"qop={_qop}," +
+                   $"nc={DigestHeader.NONCE_COUNT:00000000}," +
+                   $"cnonce=\"{_cnonce}\"";
         }
 
         /// <summary>
-        /// Transform the header to dictionary.
+        ///     Generate the MD5 Hash.
         /// </summary>
-        /// <param name="wwwAuthenticateHeader">The header</param>
-        /// <returns>A instance of <see cref="IDictionary{K,V}"/>.</returns>
-        private static IDictionary<string, string> TransformHeaderToDictionary(string wwwAuthenticateHeader)
+        /// <param name="input">The input.</param>
+        /// <returns>The MD5.</returns>
+        private static string GenerateMD5(string input)
         {
-            var regex = new Regex("realm=\"(?<realm>.*?)\"|qop=\"(?<qop>.*?)\"|nonce=\"(?<nonce>.*?)\"|stale=\"(?<stale>.*?)\"|opaque=\"(?<opaque>.*?)\"|domain=\"(?<domain>.*?)\"", RegexOptions.IgnoreCase | RegexOptions.Compiled);
-            var matches = regex.Matches(wwwAuthenticateHeader);
-
-            var dict = new Dictionary<string, string>();
-
-            // There should be 6 matches
-            foreach (Match m in matches)
-            {
-                if (!m.Success)
-                {
-                    continue;
-                }
-
-                if (m.Groups[QOP].Success)
-                {
-                    dict.Add(QOP, m.Groups[QOP].Value);
-                }
-                if (m.Groups[REALM].Success)
-                {
-                    dict.Add(REALM, m.Groups[REALM].Value);
-                }
-                if (m.Groups[NONCE].Success)
-                {
-                    dict.Add(NONCE, m.Groups[NONCE].Value);
-                }
-                //if (m.Groups[STALE].Success)
-                //{
-                //    dict.Add(STALE, m.Groups[STALE].Value);
-                //}
-                //if (m.Groups[OPAQUE].Success)
-                //{
-                //    dict.Add(OPAQUE, m.Groups[OPAQUE].Value);
-                //}
-                //if (m.Groups[DOMAIN].Success)
-                //{
-                //    dict.Add(DOMAIN, m.Groups[DOMAIN].Value);
-                //}
-            }
-
-            return dict;
+            var inputBytes = Encoding.ASCII.GetBytes(input);
+            var hash = MD5.Create().ComputeHash(inputBytes);
+            var stringBuilder = new StringBuilder();
+            hash.ToList().ForEach(b => stringBuilder.Append(b.ToString("x2")));
+            return stringBuilder.ToString();
         }
-    }
 
-    /// <summary>
-    /// Dictionary extension.
-    /// </summary>
-    internal static class DictionaryHeaderExtension
-    {
-        internal static string GetHeader(this IDictionary<string, string> header, string key)
+        private void GetDigestDataFromException(WebException ex)
         {
-            if (header.TryGetValue(key, out var value))
+            if (ex.Response == null || ((HttpWebResponse) ex.Response).StatusCode != HttpStatusCode.Unauthorized)
             {
-                return value;
+                throw ex;
             }
 
-            throw new ApplicationException($"Header not found: {key}");
-        }
+            var digestHeader = new DigestHeader(ex.Response.Headers["WWW-Authenticate"]);
 
-        internal static string GetFirstHeader(this IDictionary<string, string> header, params string[] keys)
-        {
-            foreach (var key in keys)
-            {
-                if (header.TryGetValue(key, out var value))
-                {
-                    return value;
-                }
-            }
+            _cnonce = new Random()
+                .Next(123400, 9999999)
+                .ToString(CultureInfo.InvariantCulture);
 
-            throw new ApplicationException($"No Headers found with following keys: {string.Join(",", keys)}");
+            _realm = digestHeader.Realm;
+            _nonce = digestHeader.Nonce;
+            _qop = digestHeader.Qop;
         }
     }
 }