Set DisplayName for auth

HaoK · HaoK · commit 4f206558505b · 2017-04-20T14:19:32.000-07:00
diff --git a/samples/SocialSample/Startup.cs b/samples/SocialSample/Startup.cs
@@ -238,7 +238,7 @@ public void Configure(IApplicationBuilder app, ILoggerFactory loggerfactory)
                     foreach (var provider in await schemeProvider.GetAllSchemesAsync())
                     {
                         // REVIEW: we lost access to display name (which is buried in the handler options)
-                        await context.Response.WriteAsync("<a href=\"?authscheme=" + provider.Name + "\">" + (provider.Name ?? "(suppressed)") + "</a><br>");
+                        await context.Response.WriteAsync("<a href=\"?authscheme=" + provider.Name + "\">" + (provider.DisplayName ?? "(suppressed)") + "</a><br>");
                     }
                     await context.Response.WriteAsync("</body></html>");
                 });
diff --git a/src/Microsoft.AspNetCore.Authentication.Facebook/FacebookExtensions.cs b/src/Microsoft.AspNetCore.Authentication.Facebook/FacebookExtensions.cs
@@ -26,7 +26,7 @@ public static IServiceCollection AddFacebookAuthentication(this IServiceCollecti
 
         public static IServiceCollection AddFacebookAuthentication(this IServiceCollection services, string authenticationScheme, Action<FacebookOptions> configureOptions)
         {
-            return services.AddScheme<FacebookOptions, FacebookHandler>(authenticationScheme, configureOptions);
+            return services.AddScheme<FacebookOptions, FacebookHandler>(authenticationScheme, authenticationScheme, configureOptions);
         }
     }
 }
diff --git a/src/Microsoft.AspNetCore.Authentication.Google/GoogleExtensions.cs b/src/Microsoft.AspNetCore.Authentication.Google/GoogleExtensions.cs
@@ -26,7 +26,7 @@ public static IServiceCollection AddGoogleAuthentication(this IServiceCollection
 
         public static IServiceCollection AddGoogleAuthentication(this IServiceCollection services, string authenticationScheme, Action<GoogleOptions> configureOptions)
         {
-            return services.AddScheme<GoogleOptions, GoogleHandler>(authenticationScheme, configureOptions);
+            return services.AddScheme<GoogleOptions, GoogleHandler>(authenticationScheme, authenticationScheme, configureOptions);
         }
     }
 }
diff --git a/src/Microsoft.AspNetCore.Authentication.MicrosoftAccount/MicrosoftAccountExtensions.cs b/src/Microsoft.AspNetCore.Authentication.MicrosoftAccount/MicrosoftAccountExtensions.cs
@@ -26,7 +26,7 @@ public static IServiceCollection AddMicrosoftAccountAuthentication(this IService
 
         public static IServiceCollection AddMicrosoftAccountAuthentication(this IServiceCollection services, string authenticationScheme, Action<MicrosoftAccountOptions> configureOptions)
         {
-            return services.AddScheme<MicrosoftAccountOptions, MicrosoftAccountHandler>(authenticationScheme, configureOptions);
+            return services.AddScheme<MicrosoftAccountOptions, MicrosoftAccountHandler>(authenticationScheme, authenticationScheme, configureOptions);
         }
     }
 }
diff --git a/src/Microsoft.AspNetCore.Authentication.OAuth/OAuthExtensions.cs b/src/Microsoft.AspNetCore.Authentication.OAuth/OAuthExtensions.cs
@@ -10,6 +10,6 @@ namespace Microsoft.AspNetCore.Builder
     public static class OAuthExtensions
     {
         public static IServiceCollection AddOAuthAuthentication(this IServiceCollection services, string authenticationScheme, Action<OAuthOptions> configureOptions) =>
-            services.AddScheme<OAuthOptions, OAuthHandler<OAuthOptions>>(authenticationScheme, configureOptions);
+            services.AddScheme<OAuthOptions, OAuthHandler<OAuthOptions>>(authenticationScheme, authenticationScheme, configureOptions);
     }
 }
diff --git a/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectExtensions.cs b/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectExtensions.cs
@@ -26,7 +26,7 @@ public static IServiceCollection AddOpenIdConnectAuthentication(this IServiceCol
 
         public static IServiceCollection AddOpenIdConnectAuthentication(this IServiceCollection services, string authenticationScheme, Action<OpenIdConnectOptions> configureOptions)
         {
-            return services.AddScheme<OpenIdConnectOptions, OpenIdConnectHandler>(authenticationScheme, configureOptions);
+            return services.AddScheme<OpenIdConnectOptions, OpenIdConnectHandler>(authenticationScheme, authenticationScheme, configureOptions);
         }
     }
 }
diff --git a/src/Microsoft.AspNetCore.Authentication.Twitter/TwitterExtensions.cs b/src/Microsoft.AspNetCore.Authentication.Twitter/TwitterExtensions.cs
@@ -26,7 +26,7 @@ public static IServiceCollection AddTwitterAuthentication(this IServiceCollectio
 
         public static IServiceCollection AddTwitterAuthentication(this IServiceCollection services, string authenticationScheme, Action<TwitterOptions> configureOptions)
         {
-            return services.AddScheme<TwitterOptions, TwitterHandler>(authenticationScheme, configureOptions);
+            return services.AddScheme<TwitterOptions, TwitterHandler>(authenticationScheme, authenticationScheme, configureOptions);
         }
     }
 }
diff --git a/src/Microsoft.AspNetCore.Authentication/AuthenticationServiceCollectionExtensions.cs b/src/Microsoft.AspNetCore.Authentication/AuthenticationServiceCollectionExtensions.cs
@@ -45,14 +45,15 @@ public static IServiceCollection AddAuthentication(this IServiceCollection servi
             return services;
         }
 
-        public static IServiceCollection AddScheme<TOptions, THandler>(this IServiceCollection services, string authenticationScheme, Action<AuthenticationSchemeBuilder> configureScheme, Action<TOptions> configureOptions)
+        public static IServiceCollection AddScheme<TOptions, THandler>(this IServiceCollection services, string authenticationScheme, string displayName, Action<AuthenticationSchemeBuilder> configureScheme, Action<TOptions> configureOptions)
             where TOptions : AuthenticationSchemeOptions, new()
             where THandler : AuthenticationHandler<TOptions>
         {
             services.AddAuthentication(o =>
             {
                 o.AddScheme(authenticationScheme, scheme => {
                     scheme.HandlerType = typeof(THandler);
+                    scheme.DisplayName = displayName;
                     configureScheme?.Invoke(scheme);
                 });
             });
@@ -67,6 +68,11 @@ public static IServiceCollection AddScheme<TOptions, THandler>(this IServiceColl
         public static IServiceCollection AddScheme<TOptions, THandler>(this IServiceCollection services, string authenticationScheme, Action<TOptions> configureOptions)
             where TOptions : AuthenticationSchemeOptions, new()
             where THandler : AuthenticationHandler<TOptions>
-            => services.AddScheme<TOptions, THandler>(authenticationScheme, configureScheme: null, configureOptions: configureOptions);
+            => services.AddScheme<TOptions, THandler>(authenticationScheme, displayName: null, configureScheme: null, configureOptions: configureOptions);
+
+        public static IServiceCollection AddScheme<TOptions, THandler>(this IServiceCollection services, string authenticationScheme, string displayName, Action<TOptions> configureOptions)
+            where TOptions : AuthenticationSchemeOptions, new()
+            where THandler : AuthenticationHandler<TOptions>
+            => services.AddScheme<TOptions, THandler>(authenticationScheme, displayName, configureScheme: null, configureOptions: configureOptions);
     }
 }
diff --git a/test/Microsoft.AspNetCore.Authentication.Test/CookieTests.cs b/test/Microsoft.AspNetCore.Authentication.Test/CookieTests.cs
@@ -26,6 +26,18 @@ public class CookieTests
     {
         private TestClock _clock = new TestClock();
 
+        [Fact]
+        public async Task VerifySchemeDefaults()
+        {
+            var services = new ServiceCollection().AddCookieAuthentication();
+            var sp = services.BuildServiceProvider();
+            var schemeProvider = sp.GetRequiredService<IAuthenticationSchemeProvider>();
+            var scheme = await schemeProvider.GetSchemeAsync(CookieAuthenticationDefaults.AuthenticationScheme);
+            Assert.NotNull(scheme);
+            Assert.Equal("CookieAuthenticationHandler", scheme.HandlerType.Name);
+            Assert.Null(scheme.DisplayName);
+        }
+
         [Fact]
         public async Task NormalRequestPassesThrough()
         {
diff --git a/test/Microsoft.AspNetCore.Authentication.Test/DynamicSchemeTests.cs b/test/Microsoft.AspNetCore.Authentication.Test/DynamicSchemeTests.cs
@@ -99,7 +99,7 @@ private static TestServer CreateServer(Action<AuthenticationOptions> configureAu
                         {
                             var name = remainder.Value.Substring(1);
                             var auth = context.RequestServices.GetRequiredService<IAuthenticationSchemeProvider>();
-                            var scheme = new AuthenticationScheme(name, typeof(TestHandler));
+                            var scheme = new AuthenticationScheme(name, name, typeof(TestHandler));
                             auth.AddScheme(scheme);
                         }
                         else if (req.Path.StartsWithSegments(new PathString("/auth"), out remainder))
diff --git a/test/Microsoft.AspNetCore.Authentication.Test/FacebookTests.cs b/test/Microsoft.AspNetCore.Authentication.Test/FacebookTests.cs
@@ -27,6 +27,18 @@ namespace Microsoft.AspNetCore.Authentication.Facebook
 {
     public class FacebookTests
     {
+        [Fact]
+        public async Task VerifySchemeDefaults()
+        {
+            var services = new ServiceCollection().AddFacebookAuthentication().AddSingleton<IConfiguration>(new ConfigurationBuilder().Build());
+            var sp = services.BuildServiceProvider();
+            var schemeProvider = sp.GetRequiredService<IAuthenticationSchemeProvider>();
+            var scheme = await schemeProvider.GetSchemeAsync(FacebookDefaults.AuthenticationScheme);
+            Assert.NotNull(scheme);
+            Assert.Equal("FacebookHandler", scheme.HandlerType.Name);
+            Assert.Equal(FacebookDefaults.AuthenticationScheme, scheme.DisplayName);
+        }
+
         [Fact]
         public void AddCanBindAgainstDefaultConfig()
         {
diff --git a/test/Microsoft.AspNetCore.Authentication.Test/GoogleTests.cs b/test/Microsoft.AspNetCore.Authentication.Test/GoogleTests.cs
@@ -26,6 +26,18 @@ namespace Microsoft.AspNetCore.Authentication.Google
 {
     public class GoogleTests
     {
+        [Fact]
+        public async Task VerifySchemeDefaults()
+        {
+            var services = new ServiceCollection().AddGoogleAuthentication().AddSingleton<IConfiguration>(new ConfigurationBuilder().Build());
+            var sp = services.BuildServiceProvider();
+            var schemeProvider = sp.GetRequiredService<IAuthenticationSchemeProvider>();
+            var scheme = await schemeProvider.GetSchemeAsync(GoogleDefaults.AuthenticationScheme);
+            Assert.NotNull(scheme);
+            Assert.Equal("GoogleHandler", scheme.HandlerType.Name);
+            Assert.Equal(GoogleDefaults.AuthenticationScheme, scheme.DisplayName);
+        }
+
         [Fact]
         public void AddCanBindAgainstDefaultConfig()
         {
diff --git a/test/Microsoft.AspNetCore.Authentication.Test/JwtBearerTests.cs b/test/Microsoft.AspNetCore.Authentication.Test/JwtBearerTests.cs
@@ -26,6 +26,18 @@ namespace Microsoft.AspNetCore.Authentication.JwtBearer
 {
     public class JwtBearerTests
     {
+        [Fact]
+        public async Task VerifySchemeDefaults()
+        {
+            var services = new ServiceCollection().AddJwtBearerAuthentication().AddSingleton<IConfiguration>(new ConfigurationBuilder().Build());
+            var sp = services.BuildServiceProvider();
+            var schemeProvider = sp.GetRequiredService<IAuthenticationSchemeProvider>();
+            var scheme = await schemeProvider.GetSchemeAsync(JwtBearerDefaults.AuthenticationScheme);
+            Assert.NotNull(scheme);
+            Assert.Equal("JwtBearerHandler", scheme.HandlerType.Name);
+            Assert.Null(scheme.DisplayName);
+        }
+
         [Fact]
         public void AddCanBindAgainstDefaultConfig()
         {
diff --git a/test/Microsoft.AspNetCore.Authentication.Test/MicrosoftAccountTests.cs b/test/Microsoft.AspNetCore.Authentication.Test/MicrosoftAccountTests.cs
@@ -27,6 +27,18 @@ namespace Microsoft.AspNetCore.Authentication.Tests.MicrosoftAccount
 {
     public class MicrosoftAccountTests
     {
+        [Fact]
+        public async Task VerifySchemeDefaults()
+        {
+            var services = new ServiceCollection().AddMicrosoftAccountAuthentication().AddSingleton<IConfiguration>(new ConfigurationBuilder().Build());
+            var sp = services.BuildServiceProvider();
+            var schemeProvider = sp.GetRequiredService<IAuthenticationSchemeProvider>();
+            var scheme = await schemeProvider.GetSchemeAsync(MicrosoftAccountDefaults.AuthenticationScheme);
+            Assert.NotNull(scheme);
+            Assert.Equal("MicrosoftAccountHandler", scheme.HandlerType.Name);
+            Assert.Equal(MicrosoftAccountDefaults.AuthenticationScheme, scheme.DisplayName);
+        }
+
         [Fact]
         public void AddCanBindAgainstDefaultConfig()
         {
diff --git a/test/Microsoft.AspNetCore.Authentication.Test/OAuthTests.cs b/test/Microsoft.AspNetCore.Authentication.Test/OAuthTests.cs
@@ -15,6 +15,18 @@ namespace Microsoft.AspNetCore.Authentication.OAuth
 {
     public class OAuthTests
     {
+        [Fact]
+        public async Task VerifySchemeDefaults()
+        {
+            var services = new ServiceCollection().AddOAuthAuthentication("oauth", o => { });
+            var sp = services.BuildServiceProvider();
+            var schemeProvider = sp.GetRequiredService<IAuthenticationSchemeProvider>();
+            var scheme = await schemeProvider.GetSchemeAsync("oauth");
+            Assert.NotNull(scheme);
+            Assert.Equal("OAuthHandler`1", scheme.HandlerType.Name);
+            Assert.Equal("oauth", scheme.DisplayName);
+        }
+
         [Fact]
         public async Task ThrowsIfClientIdMissing()
         {
diff --git a/test/Microsoft.AspNetCore.Authentication.Test/TwitterTests.cs b/test/Microsoft.AspNetCore.Authentication.Test/TwitterTests.cs
@@ -20,6 +20,18 @@ namespace Microsoft.AspNetCore.Authentication.Twitter
 {
     public class TwitterTests
     {
+        [Fact]
+        public async Task VerifySchemeDefaults()
+        {
+            var services = new ServiceCollection().AddTwitterAuthentication().AddSingleton<IConfiguration>(new ConfigurationBuilder().Build());
+            var sp = services.BuildServiceProvider();
+            var schemeProvider = sp.GetRequiredService<IAuthenticationSchemeProvider>();
+            var scheme = await schemeProvider.GetSchemeAsync(TwitterDefaults.AuthenticationScheme);
+            Assert.NotNull(scheme);
+            Assert.Equal("TwitterHandler", scheme.HandlerType.Name);
+            Assert.Equal(TwitterDefaults.AuthenticationScheme, scheme.DisplayName);
+        }
+
         [Fact]
         public void AddCanBindAgainstDefaultConfig()
         {

Original file line number	Diff line number	Diff line change
`@@ -238,7 +238,7 @@ public void Configure(IApplicationBuilder app, ILoggerFactory loggerfactory)`
`238`	`238`	`foreach (var provider in await schemeProvider.GetAllSchemesAsync())`
`239`	`239`	`{`
`240`	`240`	`// REVIEW: we lost access to display name (which is buried in the handler options)`
`241`		`- await context.Response.WriteAsync("<a href=\"?authscheme=" + provider.Name + "\">" + (provider.Name ?? "(suppressed)") + "</a><br>");`
	`241`	`+ await context.Response.WriteAsync("<a href=\"?authscheme=" + provider.Name + "\">" + (provider.DisplayName ?? "(suppressed)") + "</a><br>");`
`242`	`242`	`}`
`243`	`243`	`await context.Response.WriteAsync("</body></html>");`
`244`	`244`	`});`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public static IServiceCollection AddFacebookAuthentication(this IServiceCollecti`
`26`	`26`
`27`	`27`	`public static IServiceCollection AddFacebookAuthentication(this IServiceCollection services, string authenticationScheme, Action<FacebookOptions> configureOptions)`
`28`	`28`	`{`
`29`		`- return services.AddScheme<FacebookOptions, FacebookHandler>(authenticationScheme, configureOptions);`
	`29`	`+ return services.AddScheme<FacebookOptions, FacebookHandler>(authenticationScheme, authenticationScheme, configureOptions);`
`30`	`30`	`}`
`31`	`31`	`}`
`32`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,6 @@ namespace Microsoft.AspNetCore.Builder`
`10`	`10`	`public static class OAuthExtensions`
`11`	`11`	`{`
`12`	`12`	`public static IServiceCollection AddOAuthAuthentication(this IServiceCollection services, string authenticationScheme, Action<OAuthOptions> configureOptions) =>`
`13`		`- services.AddScheme<OAuthOptions, OAuthHandler<OAuthOptions>>(authenticationScheme, configureOptions);`
	`13`	`+ services.AddScheme<OAuthOptions, OAuthHandler<OAuthOptions>>(authenticationScheme, authenticationScheme, configureOptions);`
`14`	`14`	`}`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,14 +45,15 @@ public static IServiceCollection AddAuthentication(this IServiceCollection servi`
`45`	`45`	`return services;`
`46`	`46`	`}`
`47`	`47`
`48`		`- public static IServiceCollection AddScheme<TOptions, THandler>(this IServiceCollection services, string authenticationScheme, Action<AuthenticationSchemeBuilder> configureScheme, Action<TOptions> configureOptions)`
	`48`	`+ public static IServiceCollection AddScheme<TOptions, THandler>(this IServiceCollection services, string authenticationScheme, string displayName, Action<AuthenticationSchemeBuilder> configureScheme, Action<TOptions> configureOptions)`
`49`	`49`	`where TOptions : AuthenticationSchemeOptions, new()`
`50`	`50`	`where THandler : AuthenticationHandler<TOptions>`
`51`	`51`	`{`
`52`	`52`	`services.AddAuthentication(o =>`
`53`	`53`	`{`
`54`	`54`	`o.AddScheme(authenticationScheme, scheme => {`
`55`	`55`	`scheme.HandlerType = typeof(THandler);`
	`56`	`+ scheme.DisplayName = displayName;`
`56`	`57`	`configureScheme?.Invoke(scheme);`
`57`	`58`	`});`
`58`	`59`	`});`
`@@ -67,6 +68,11 @@ public static IServiceCollection AddScheme<TOptions, THandler>(this IServiceColl`
`67`	`68`	`public static IServiceCollection AddScheme<TOptions, THandler>(this IServiceCollection services, string authenticationScheme, Action<TOptions> configureOptions)`
`68`	`69`	`where TOptions : AuthenticationSchemeOptions, new()`
`69`	`70`	`where THandler : AuthenticationHandler<TOptions>`
`70`		`- => services.AddScheme<TOptions, THandler>(authenticationScheme, configureScheme: null, configureOptions: configureOptions);`
	`71`	`+ => services.AddScheme<TOptions, THandler>(authenticationScheme, displayName: null, configureScheme: null, configureOptions: configureOptions);`
	`72`	`+`
	`73`	`+ public static IServiceCollection AddScheme<TOptions, THandler>(this IServiceCollection services, string authenticationScheme, string displayName, Action<TOptions> configureOptions)`
	`74`	`+ where TOptions : AuthenticationSchemeOptions, new()`
	`75`	`+ where THandler : AuthenticationHandler<TOptions>`
	`76`	`+ => services.AddScheme<TOptions, THandler>(authenticationScheme, displayName, configureScheme: null, configureOptions: configureOptions);`
`71`	`77`	`}`
`72`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ private static TestServer CreateServer(Action<AuthenticationOptions> configureAu`
`99`	`99`	`{`
`100`	`100`	`var name = remainder.Value.Substring(1);`
`101`	`101`	`var auth = context.RequestServices.GetRequiredService<IAuthenticationSchemeProvider>();`
`102`		`- var scheme = new AuthenticationScheme(name, typeof(TestHandler));`
	`102`	`+ var scheme = new AuthenticationScheme(name, name, typeof(TestHandler));`
`103`	`103`	`auth.AddScheme(scheme);`
`104`	`104`	`}`
`105`	`105`	`else if (req.Path.StartsWithSegments(new PathString("/auth"), out remainder))`