Cleanup code for StyleCop

kirkone · kirkone · commit be2638d45e87 · 2018-12-11T01:22:58.000+01:00
diff --git a/StyleCop.ruleset b/StyleCop.ruleset
@@ -17,6 +17,8 @@
     <Rule Id="SA1623" Action="None" /> <!-- The property's documentation summary text should begin with : 'Gets or sets' -->
     <Rule Id="SA1650" Action="None" /> <!-- The documentation header contains invalidly spelled words. -->
     <Rule Id="SA1602" Action="None" /> <!-- Enumeration items should be documented. -->
+    <Rule Id="SA1009" Action="None" /> <!-- Closing parenthesis should not be preceded by a space. -->
+    <Rule Id="SA1111" Action="None" /> <!-- Closing Parenthesis Must Be On Line Of Last Parameter. -->
     <Rule Id="SA1128" Action="None" /> <!-- Put constructor initializers on their own line. -->
   </Rules>
 </RuleSet>
diff --git a/src/KK.AspNetCore.EasyAuthAuthentication/AuthTokenHeaderNames.cs b/src/KK.AspNetCore.EasyAuthAuthentication/AuthTokenHeaderNames.cs
@@ -2,36 +2,34 @@ namespace KK.AspNetCore.EasyAuthAuthentication
 {
     /// <summary>
     /// This class contains all header names that are possible to make an authentication.
-    /// The source of the list can find here: https://docs.microsoft.com/en-us/azure/app-service/app-service-authentication-how-to#retrieve-tokens-in-app-code
+    /// The source of the list can find here: https://docs.microsoft.com/en-us/azure/app-service/app-service-authentication-how-to#retrieve-tokens-in-app-code .
     /// </summary>
-    public static class AuthTokenHeaderNames
+    internal static class AuthTokenHeaderNames
     {
-        #region AzureAd
+        // AzureAd
         public const string AADIdToken = "X-MS-TOKEN-AAD-ID-TOKEN";
         public const string AADAccessToken = "X-MS-TOKEN-AAD-ACCESS-TOKEN";
         public const string AADExpiresOn = "X-MS-TOKEN-AAD-EXPIRES-ON";
         public const string AADRefreshToken = "X-MS-TOKEN-AAD-REFRESH-TOKEN";
-        #endregion
-        #region Facebook
+
+        // Facebook
         public const string FacebookAccessToken = "X-MS-TOKEN-FACEBOOK-ACCESS-TOKEN";
         public const string FacebookExpiresOn = "X-MS-TOKEN-FACEBOOK-EXPIRES-ON";
-        #endregion
-        #region Google
+
+        // Google
         public const string GoogleIdToken = "X-MS-TOKEN-GOOGLE-ID-TOKEN";
         public const string GoogleAccessToken = "X-MS-TOKEN-GOOGLE-ACCESS-TOKEN";
         public const string GoogleExpiresOn = "X-MS-TOKEN-GOOGLE-EXPIRES-ON";
         public const string GoogleRefreshToken = "X-MS-TOKEN-GOOGLE-REFRESH-TOKEN";
 
-        #endregion
-        #region Microsoft Account
+        // Microsoft Account
         public const string MicrosoftAccessToken = "X-MS-TOKEN-MICROSOFTACCOUNT-ACCESS-TOKEN";
         public const string MicrosoftExpiresOn = "X-MS-TOKEN-MICROSOFTACCOUNT-EXPIRES-ON";
         public const string MicrosoftAuthenticationToken = "X-MS-TOKEN-MICROSOFTACCOUNT-AUTHENTICATION-TOKEN";
         public const string MicrosoftRefreshToken = "X-MS-TOKEN-MICROSOFTACCOUNT-REFRESH-TOKEN";
-        #endregion
-        #region Twitter
+
+        // Twitter
         public const string TwitterAccessToken = "X-MS-TOKEN-TWITTER-ACCESS-TOKEN";
         public const string TwitterAccessTokenSecret = "X-MS-TOKEN-TWITTER-ACCESS-TOKEN-SECRET";
-        #endregion
     }
 }
diff --git a/src/KK.AspNetCore.EasyAuthAuthentication/AuthenticationTicketBuilder.cs b/src/KK.AspNetCore.EasyAuthAuthentication/AuthenticationTicketBuilder.cs
@@ -1,36 +1,35 @@
-using System.Collections.Generic;
-using System.Linq;
-using System.Security.Claims;
-using System.Security.Principal;
-using Microsoft.AspNetCore.Authentication;
-using Newtonsoft.Json.Linq;
-
 namespace KK.AspNetCore.EasyAuthAuthentication
 {
-    public static class AuthenticationTicketBuilder
+    using System.Collections.Generic;
+    using System.Linq;
+    using System.Security.Claims;
+    using Microsoft.AspNetCore.Authentication;
+    using Newtonsoft.Json.Linq;
+
+    internal static class AuthenticationTicketBuilder
     {
         /// <summary>
-        /// Build a `AuthenticationTicket` from the given payload, the principal name and the provider name
+        /// Build a `AuthenticationTicket` from the given payload, the principal name and the provider name.
         /// </summary>
-        /// <param name="claimsPayload">A array of JObjects that have a `type` and a `val` property</param>
+        /// <param name="claimsPayload">A array of JObjects that have a `type` and a `val` property.</param>
         /// <param name="providerName">The provider name of the current auth provider.</param>
-        /// <returns>A `AuthenticationTicket`</returns>
+        /// <returns>A `AuthenticationTicket`.</returns>
         public static AuthenticationTicket Build(IEnumerable<JObject> claimsPayload, string providerName)
         {
+            // setting ClaimsIdentity.AuthenticationType to value that Azure AD non-EasyAuth setups use
             var identity = new ClaimsIdentity(
-                createClaims(claimsPayload),
-                // setting ClaimsIdentity.AuthenticationType to value that Azure AD non-EasyAuth setups use
+                CreateClaims(claimsPayload),
                 AuthenticationTypesNames.Federation
             );
 
-            addScopeClaim(identity);
-            addProviderNameClaim(identity, providerName);
+            AddScopeClaim(identity);
+            AddProviderNameClaim(identity, providerName);
             var genericPrincipal = new ClaimsPrincipal(identity);
 
             return new AuthenticationTicket(genericPrincipal, EasyAuthAuthenticationDefaults.AuthenticationScheme);
         }
 
-        private static IEnumerable<Claim> createClaims(IEnumerable<JObject> claimsAsJson)
+        private static IEnumerable<Claim> CreateClaims(IEnumerable<JObject> claimsAsJson)
         {
             foreach (var claim in claimsAsJson)
             {
@@ -42,12 +41,14 @@ private static IEnumerable<Claim> createClaims(IEnumerable<JObject> claimsAsJson
                         {
                             yield return new Claim(ClaimTypes.Authentication, item);
                         }
+
                         break;
                     case "roles":
                         foreach (var item in claim["val"].ToString().Split(','))
                         {
                             yield return new Claim(ClaimTypes.Role, item);
                         }
+
                         break;
                     default:
                         yield return new Claim(claimType, claim["val"].ToString());
@@ -56,7 +57,7 @@ private static IEnumerable<Claim> createClaims(IEnumerable<JObject> claimsAsJson
             }
         }
 
-        private static void addScopeClaim(ClaimsIdentity identity)
+        private static void AddScopeClaim(ClaimsIdentity identity)
         {
             if (!identity.Claims.Any(claim => claim.Type == "scp"))
             {
@@ -66,7 +67,7 @@ private static void addScopeClaim(ClaimsIdentity identity)
             }
         }
 
-        private static void addProviderNameClaim(ClaimsIdentity identity, string providerName)
+        private static void AddProviderNameClaim(ClaimsIdentity identity, string providerName)
         {
             if (!identity.Claims.Any(claim => claim.Type == "provider_name"))
             {
diff --git a/src/KK.AspNetCore.EasyAuthAuthentication/AuthenticationTypesNames.cs b/src/KK.AspNetCore.EasyAuthAuthentication/AuthenticationTypesNames.cs
@@ -2,9 +2,9 @@ namespace KK.AspNetCore.EasyAuthAuthentication
 {
     /// <summary>
     /// This class contains all Authentication type names.
-    /// Source of this is: https://docs.microsoft.com/en-us/dotnet/api/system.security.claims.authenticationtypes?view=netframework-4.7.2
+    /// Source of this is: https://docs.microsoft.com/en-us/dotnet/api/system.security.claims.authenticationtypes?view=netframework-4.7.2 .
     /// </summary>
-    public class AuthenticationTypesNames
+    internal class AuthenticationTypesNames
     {
         public const string Basic = "AuthenticationTypes.Basic";
         public const string Federation = "AuthenticationTypes.Federation";
diff --git a/src/KK.AspNetCore.EasyAuthAuthentication/EasyAuthAuthenticationHandler.cs b/src/KK.AspNetCore.EasyAuthAuthentication/EasyAuthAuthenticationHandler.cs
@@ -1,29 +1,36 @@
 namespace KK.AspNetCore.EasyAuthAuthentication
 {
     using System;
-    using System.Collections.Generic;
-    using System.IdentityModel.Tokens.Jwt;
-    using System.Linq; // required by Children<JObject>.FirstOrDefault requires using System.Linq;
-    using System.Net;
-    using System.Net.Http;
     using System.Security.Claims;
-    using System.Security.Principal;
-    using System.Text;
     using System.Text.Encodings.Web;
     using System.Threading.Tasks;
     using KK.AspNetCore.EasyAuthAuthentication.Services;
     using Microsoft.AspNetCore.Authentication;
     using Microsoft.AspNetCore.Http;
     using Microsoft.Extensions.Logging;
     using Microsoft.Extensions.Options;
-    using Newtonsoft.Json;
-    using Newtonsoft.Json.Linq;
 
     /// <summary>
     /// Enables the handler in an Easy Auth context.
     /// </summary>
     public class EasyAuthAuthenticationHandler : AuthenticationHandler<EasyAuthAuthenticationOptions>
     {
+        private static readonly Func<ClaimsPrincipal, bool> IsContextUserNotAuthenticated =
+            user => user == null || user.Identity == null || user.Identity.IsAuthenticated == false;
+
+        private static readonly Func<IHeaderDictionary, string, bool> IsHeaderSet =
+            (headers, headerName) => !string.IsNullOrEmpty(headers[headerName].ToString());
+
+        private static readonly Func<IHeaderDictionary, ClaimsPrincipal, HttpRequest, string, bool> CanUseEasyAuthJson =
+            (headers, user, request, authEndpoint) =>
+                IsContextUserNotAuthenticated(user)
+                && !IsHeaderSet(headers, AuthTokenHeaderNames.AADIdToken)
+                && request.Path != "/" + $"{authEndpoint}";
+
+        private readonly Func<IHeaderDictionary, ClaimsPrincipal, bool> canUseHeaderAuth =
+            (headers, user) => IsContextUserNotAuthenticated(user) &&
+            IsHeaderSet(headers, AuthTokenHeaderNames.AADIdToken);
+
         /// <summary>
         /// Initializes a new instance of the <see cref="EasyAuthAuthenticationHandler"/> class.
         /// </summary>
@@ -39,42 +46,30 @@ public EasyAuthAuthenticationHandler(
         {
         }
 
-        private static Func<ClaimsPrincipal, bool> isContextUserNotAuthenticated =
-            user => (user == null || user.Identity == null || user.Identity.IsAuthenticated == false);
-        private static Func<IHeaderDictionary, string, bool> isHeaderSet =
-            (headers, headerName) => !string.IsNullOrEmpty(headers[headerName].ToString());
-        private Func<IHeaderDictionary, ClaimsPrincipal, bool> canUseHeaderAuth =
-            (headers, user) => isContextUserNotAuthenticated(user) &&
-            isHeaderSet(headers, AuthTokenHeaderNames.AADIdToken);
-        private static Func<IHeaderDictionary, ClaimsPrincipal, HttpRequest, string, bool> canUseEasyAuthJson =
-            (headers, user, request, authEndpoint) =>
-                isContextUserNotAuthenticated(user)
-                && !isHeaderSet(headers, AuthTokenHeaderNames.AADIdToken)
-                && request.Path != "/" + $"{authEndpoint}";
-
         /// <inheritdoc/>
         protected override async Task<AuthenticateResult> HandleAuthenticateAsync()
         {
             this.Logger.LogInformation("starting authentication handler for app service authentication");
 
-            if (canUseHeaderAuth(this.Context.Request.Headers, this.Context.User))
+            if (this.canUseHeaderAuth(this.Context.Request.Headers, this.Context.User))
             {
                 return EasyAuthWithHeaderService.AuthUser(this.Logger, this.Context);
             }
-            else if (canUseEasyAuthJson(this.Context.Request.Headers, this.Context.User, this.Context.Request, this.Options.AuthEndpoint))
+            else if (CanUseEasyAuthJson(this.Context.Request.Headers, this.Context.User, this.Context.Request, this.Options.AuthEndpoint))
             {
                 return await EasyAuthWithAuthMeService.AuthUser(this.Logger, this.Context, this.Options.AuthEndpoint);
             }
             else
             {
-                if (isContextUserNotAuthenticated(this.Context.User))
+                if (IsContextUserNotAuthenticated(this.Context.User))
                 {
                     this.Logger.LogInformation("The identity isn't set by easy auth.");
                 }
                 else
                 {
                     this.Logger.LogInformation("identity already set, skipping middleware");
                 }
+
                 return AuthenticateResult.NoResult();
             }
         }
diff --git a/src/KK.AspNetCore.EasyAuthAuthentication/Schemas.cs b/src/KK.AspNetCore.EasyAuthAuthentication/Schemas.cs
@@ -1,6 +1,6 @@
 namespace KK.AspNetCore.EasyAuthAuthentication
 {
-    public class Schemas
+    internal class Schemas
     {
         public const string AuthMethod = "http://schemas.microsoft.com/claims/authnmethodsreferences";
     }
diff --git a/src/KK.AspNetCore.EasyAuthAuthentication/Services/EasyAuthWithAuthMeService.cs b/src/KK.AspNetCore.EasyAuthAuthentication/Services/EasyAuthWithAuthMeService.cs
@@ -1,27 +1,18 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Net;
-using System.Net.Http;
-using System.Security.Claims;
-using System.Security.Principal;
-using System.Threading.Tasks;
-using Microsoft.AspNetCore.Authentication;
-using Microsoft.AspNetCore.Http;
-using Microsoft.Extensions.Logging;
-using Newtonsoft.Json;
-using Newtonsoft.Json.Linq;
-
 namespace KK.AspNetCore.EasyAuthAuthentication.Services
 {
-    public class EasyAuthWithAuthMeService
+    using System;
+    using System.Net;
+    using System.Net.Http;
+    using System.Security.Principal;
+    using System.Threading.Tasks;
+    using Microsoft.AspNetCore.Authentication;
+    using Microsoft.AspNetCore.Http;
+    using Microsoft.Extensions.Logging;
+    using Newtonsoft.Json;
+    using Newtonsoft.Json.Linq;
+
+    internal class EasyAuthWithAuthMeService
     {
-        private string Host { get; }
-        private IRequestCookieCollection Cookies { get; }
-        private IHeaderDictionary Headers { get; }
-        private string AuthEndPoint { get; }
-        private ILogger Logger { get; }
-        private string HttpSchema { get; }
         private EasyAuthWithAuthMeService(
             ILogger logger,
             string httpSchema,
@@ -32,20 +23,32 @@ private EasyAuthWithAuthMeService(
         {
             this.HttpSchema = httpSchema;
             this.Host = host;
-            Cookies = cookies;
-            Headers = headers;
-            AuthEndPoint = authEndPoint;
+            this.Cookies = cookies;
+            this.Headers = headers;
+            this.AuthEndPoint = authEndPoint;
             this.Logger = logger;
         }
 
+        private string Host { get; }
+
+        private IRequestCookieCollection Cookies { get; }
+
+        private IHeaderDictionary Headers { get; }
+
+        private string AuthEndPoint { get; }
+
+        private ILogger Logger { get; }
+
+        private string HttpSchema { get; }
+
         /// <summary>
         /// Use this method to authenticate a user with easy auth.
         /// This will set the `context.User` of your HttpContext.
         /// </summary>
-        /// <param name="logger"></param>
+        /// <param name="logger">An instance of <see cref="ILogger"/>.</param>
         /// <param name="context">The http context with the missing user claim.</param>
-        /// <param name="authEndpoint">The auth endpoint where we find the easy auth json</param>
-        /// <returns></returns>
+        /// <param name="authEndpoint">The auth endpoint where we find the easy auth json.</param>
+        /// <returns>An <see cref="AuthenticateResult" />.</returns>
         public static async Task<AuthenticateResult> AuthUser(ILogger logger, HttpContext context, string authEndpoint)
         {
             try
@@ -146,8 +149,14 @@ private HttpRequestMessage CreateAuthRequest(ref CookieContainer cookieContainer
 
             // fetch value from endpoint
             var authMeEndpoint = string.Empty;
-            if (this.AuthEndPoint.StartsWith("http")) authMeEndpoint = this.AuthEndPoint; // enable pulling from places like storage account private blob container
-            else authMeEndpoint = $"{uriString}/{this.AuthEndPoint}"; // localhost relative path, e.g. wwwroot/.auth/me.json
+            if (this.AuthEndPoint.StartsWith("http"))
+            {
+                authMeEndpoint = this.AuthEndPoint; // enable pulling from places like storage account private blob container
+            }
+            else
+            {
+                authMeEndpoint = $"{uriString}/{this.AuthEndPoint}"; // localhost relative path, e.g. wwwroot/.auth/me.json
+            }
 
             var request = new HttpRequestMessage(HttpMethod.Get, authMeEndpoint);
             foreach (var header in this.Headers)
diff --git a/src/KK.AspNetCore.EasyAuthAuthentication/Services/EasyAuthWithHeaderService.cs b/src/KK.AspNetCore.EasyAuthAuthentication/Services/EasyAuthWithHeaderService.cs

Original file line number	Diff line number	Diff line change
`@@ -1,36 +1,35 @@`
`1`		`-using System.Collections.Generic;`
`2`		`-using System.Linq;`
`3`		`-using System.Security.Claims;`
`4`		`-using System.Security.Principal;`
`5`		`-using Microsoft.AspNetCore.Authentication;`
`6`		`-using Newtonsoft.Json.Linq;`
`7`		`-`
`8`	`1`	`namespace KK.AspNetCore.EasyAuthAuthentication`
`9`	`2`	`{`
`10`		`- public static class AuthenticationTicketBuilder`
	`3`	`+ using System.Collections.Generic;`
	`4`	`+ using System.Linq;`
	`5`	`+ using System.Security.Claims;`
	`6`	`+ using Microsoft.AspNetCore.Authentication;`
	`7`	`+ using Newtonsoft.Json.Linq;`
	`8`	`+`
	`9`	`+ internal static class AuthenticationTicketBuilder`
`11`	`10`	`{`
`12`	`11`	`/// <summary>`
`13`		- /// Build a `AuthenticationTicket` from the given payload, the principal name and the provider name
	`12`	+ /// Build a `AuthenticationTicket` from the given payload, the principal name and the provider name.
`14`	`13`	`/// </summary>`
`15`		- /// <param name="claimsPayload">A array of JObjects that have a `type` and a `val` property</param>
	`14`	+ /// <param name="claimsPayload">A array of JObjects that have a `type` and a `val` property.</param>
`16`	`15`	`/// <param name="providerName">The provider name of the current auth provider.</param>`
`17`		- /// <returns>A `AuthenticationTicket`</returns>
	`16`	+ /// <returns>A `AuthenticationTicket`.</returns>
`18`	`17`	`public static AuthenticationTicket Build(IEnumerable<JObject> claimsPayload, string providerName)`
`19`	`18`	`{`
	`19`	`+ // setting ClaimsIdentity.AuthenticationType to value that Azure AD non-EasyAuth setups use`
`20`	`20`	`var identity = new ClaimsIdentity(`
`21`		`- createClaims(claimsPayload),`
`22`		`- // setting ClaimsIdentity.AuthenticationType to value that Azure AD non-EasyAuth setups use`
	`21`	`+ CreateClaims(claimsPayload),`
`23`	`22`	`AuthenticationTypesNames.Federation`
`24`	`23`	`);`
`25`	`24`
`26`		`- addScopeClaim(identity);`
`27`		`- addProviderNameClaim(identity, providerName);`
	`25`	`+ AddScopeClaim(identity);`
	`26`	`+ AddProviderNameClaim(identity, providerName);`
`28`	`27`	`var genericPrincipal = new ClaimsPrincipal(identity);`
`29`	`28`
`30`	`29`	`return new AuthenticationTicket(genericPrincipal, EasyAuthAuthenticationDefaults.AuthenticationScheme);`
`31`	`30`	`}`
`32`	`31`
`33`		`- private static IEnumerable<Claim> createClaims(IEnumerable<JObject> claimsAsJson)`
	`32`	`+ private static IEnumerable<Claim> CreateClaims(IEnumerable<JObject> claimsAsJson)`
`34`	`33`	`{`
`35`	`34`	`foreach (var claim in claimsAsJson)`
`36`	`35`	`{`
`@@ -42,12 +41,14 @@ private static IEnumerable<Claim> createClaims(IEnumerable<JObject> claimsAsJson`
`42`	`41`	`{`
`43`	`42`	`yield return new Claim(ClaimTypes.Authentication, item);`
`44`	`43`	`}`
	`44`	`+`
`45`	`45`	`break;`
`46`	`46`	`case "roles":`
`47`	`47`	`foreach (var item in claim["val"].ToString().Split(','))`
`48`	`48`	`{`
`49`	`49`	`yield return new Claim(ClaimTypes.Role, item);`
`50`	`50`	`}`
	`51`	`+`
`51`	`52`	`break;`
`52`	`53`	`default:`
`53`	`54`	`yield return new Claim(claimType, claim["val"].ToString());`
`@@ -56,7 +57,7 @@ private static IEnumerable<Claim> createClaims(IEnumerable<JObject> claimsAsJson`
`56`	`57`	`}`
`57`	`58`	`}`
`58`	`59`
`59`		`- private static void addScopeClaim(ClaimsIdentity identity)`
	`60`	`+ private static void AddScopeClaim(ClaimsIdentity identity)`
`60`	`61`	`{`
`61`	`62`	`if (!identity.Claims.Any(claim => claim.Type == "scp"))`
`62`	`63`	`{`
`@@ -66,7 +67,7 @@ private static void addScopeClaim(ClaimsIdentity identity)`
`66`	`67`	`}`
`67`	`68`	`}`
`68`	`69`
`69`		`- private static void addProviderNameClaim(ClaimsIdentity identity, string providerName)`
	`70`	`+ private static void AddProviderNameClaim(ClaimsIdentity identity, string providerName)`
`70`	`71`	`{`
`71`	`72`	`if (!identity.Claims.Any(claim => claim.Type == "provider_name"))`
`72`	`73`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,9 @@ namespace KK.AspNetCore.EasyAuthAuthentication`
`2`	`2`	`{`
`3`	`3`	`/// <summary>`
`4`	`4`	`/// This class contains all Authentication type names.`
`5`		`- /// Source of this is: https://docs.microsoft.com/en-us/dotnet/api/system.security.claims.authenticationtypes?view=netframework-4.7.2`
	`5`	`+ /// Source of this is: https://docs.microsoft.com/en-us/dotnet/api/system.security.claims.authenticationtypes?view=netframework-4.7.2 .`
`6`	`6`	`/// </summary>`
`7`		`- public class AuthenticationTypesNames`
	`7`	`+ internal class AuthenticationTypesNames`
`8`	`8`	`{`
`9`	`9`	`public const string Basic = "AuthenticationTypes.Basic";`
`10`	`10`	`public const string Federation = "AuthenticationTypes.Federation";`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`namespace KK.AspNetCore.EasyAuthAuthentication`
`2`	`2`	`{`
`3`		`- public class Schemas`
	`3`	`+ internal class Schemas`
`4`	`4`	`{`
`5`	`5`	`public const string AuthMethod = "http://schemas.microsoft.com/claims/authnmethodsreferences";`
`6`	`6`	`}`