Fix the Twitch provider to use the correct user information endpoint and add new claims

Author: zAfLu

src/AspNet.Security.OAuth.Twitch/TwitchAuthenticationConstants.cs

@@ -0,0 +1,24 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
+ * See https://github.com/aspnet-contrib/AspNet.Security.OAuth.Providers
+ * for more information concerning the license and the contributors participating to this project.
+ */
+
+namespace AspNet.Security.OAuth.Twitch
+{
+    /// <summary>
+    /// Contains constants specific to the <see cref="TwitchAuthenticationHandler"/>.
+    /// </summary>
+    public static class TwitchAuthenticationConstants
+    {
+        public static class Claims
+        {
+            public const string BroadcasterType = "urn:twitch:broadcastertype";
+            public const string Description = "urn:twitch:description";
+            public const string DisplayName = "urn:twitch:displayname";
+            public const string OfflineImageUrl = "urn:twitch:offlineimageurl";
+            public const string ProfileImageUrl = "urn:twitch:profileimageurl";
+            public const string Type = "urn:twitch:type";
+        }
+    }
+}

src/AspNet.Security.OAuth.Twitch/TwitchAuthenticationDefaults.cs

@@ -46,6 +46,6 @@ public static class TwitchAuthenticationDefaults
         /// <summary>
         /// Default value for <see cref="OAuthOptions.UserInformationEndpoint"/>.
         /// </summary>
-        public const string UserInformationEndpoint = "https://api.twitch.tv/helix/user/";
+        public const string UserInformationEndpoint = "https://api.twitch.tv/helix/users/";
     }
 }

src/AspNet.Security.OAuth.Twitch/TwitchAuthenticationHandler.cs

@@ -15,6 +15,7 @@
 using Microsoft.AspNetCore.Http.Authentication;
 using Microsoft.Extensions.Logging;
 using Newtonsoft.Json.Linq;
+using static AspNet.Security.OAuth.Twitch.TwitchAuthenticationConstants;
 
 namespace AspNet.Security.OAuth.Twitch
 {
@@ -47,7 +48,14 @@ protected override async Task<AuthenticationTicket> CreateTicketAsync([NotNull]
             var payload = JObject.Parse(await response.Content.ReadAsStringAsync());
 
             identity.AddOptionalClaim(ClaimTypes.NameIdentifier, TwitchAuthenticationHelper.GetIdentifier(payload), Options.ClaimsIssuer)
-                    .AddOptionalClaim(ClaimTypes.Name, TwitchAuthenticationHelper.GetName(payload), Options.ClaimsIssuer);
+                    .AddOptionalClaim(ClaimTypes.Name, TwitchAuthenticationHelper.GetName(payload), Options.ClaimsIssuer)
+                    .AddOptionalClaim(Claims.DisplayName, TwitchAuthenticationHelper.GetDisplayName(payload), Options.ClaimsIssuer)
+                    .AddOptionalClaim(ClaimTypes.Email, TwitchAuthenticationHelper.GetEmail(payload), Options.ClaimsIssuer)
+                    .AddOptionalClaim(Claims.Type, TwitchAuthenticationHelper.GetType(payload), Options.ClaimsIssuer)
+                    .AddOptionalClaim(Claims.BroadcasterType, TwitchAuthenticationHelper.GetBroadcastType(payload), Options.ClaimsIssuer)
+                    .AddOptionalClaim(Claims.Description, TwitchAuthenticationHelper.GetDescription(payload), Options.ClaimsIssuer)
+                    .AddOptionalClaim(Claims.ProfileImageUrl, TwitchAuthenticationHelper.GetProfileImageUrl(payload), Options.ClaimsIssuer)
+                    .AddOptionalClaim(Claims.OfflineImageUrl, TwitchAuthenticationHelper.GetOfflineImageUrl(payload), Options.ClaimsIssuer);
 
             var principal = new ClaimsPrincipal(identity);
             var ticket = new AuthenticationTicket(principal, properties, Options.AuthenticationScheme);

src/AspNet.Security.OAuth.Twitch/TwitchAuthenticationHelper.cs

@@ -26,7 +26,7 @@ public static string GetIdentifier([NotNull] JObject user)
                 throw new ArgumentNullException(nameof(user));
             }
 
-            return user.Value<string>("_id");
+            return user["data"]?[0]?.Value<string>("id");
         }
 
         /// <summary>
@@ -39,7 +39,98 @@ public static string GetName([NotNull] JObject user)
                 throw new ArgumentNullException(nameof(user));
             }
 
-            return user.Value<string>("name");
+            return user["data"]?[0]?.Value<string>("login");
+        }
+
+        /// <summary>
+        /// Gets the display name corresponding to the authenticated user.
+        /// </summary>
+        public static string GetDisplayName([NotNull] JObject user)
+        {
+            if (user == null)
+            {
+                throw new ArgumentNullException(nameof(user));
+            }
+
+            return user["data"]?[0]?.Value<string>("display_name");
+        }
+
+        /// <summary>
+        /// Gets the email corresponding to the authenticated user.
+        /// </summary>
+        public static string GetEmail([NotNull] JObject user)
+        {
+            if (user == null)
+            {
+                throw new ArgumentNullException(nameof(user));
+            }
+
+            return user["data"]?[0]?.Value<string>("email");
+        }
+
+        /// <summary>
+        /// Gets the account type corresponding to the authenticated user.
+        /// </summary>
+        public static string GetType([NotNull] JObject user)
+        {
+            if (user == null)
+            {
+                throw new ArgumentNullException(nameof(user));
+            }
+
+            return user["data"]?[0]?.Value<string>("type");
+        }
+
+        /// <summary>
+        /// Gets the broadcaster type corresponding to the authenticated user.
+        /// </summary>
+        public static string GetBroadcastType([NotNull] JObject user)
+        {
+            if (user == null)
+            {
+                throw new ArgumentNullException(nameof(user));
+            }
+
+            return user["data"]?[0]?.Value<string>("broadcaster_type");
+        }
+
+        /// <summary>
+        /// Gets the channel description corresponding to the authenticated user.
+        /// </summary>
+        public static string GetDescription([NotNull] JObject user)
+        {
+            if (user == null)
+            {
+                throw new ArgumentNullException(nameof(user));
+            }
+
+            return user["data"]?[0]?.Value<string>("description");
+        }
+
+        /// <summary>
+        /// Gets the profile image url corresponding to the authenticated user.
+        /// </summary>
+        public static string GetProfileImageUrl([NotNull] JObject user)
+        {
+            if (user == null)
+            {
+                throw new ArgumentNullException(nameof(user));
+            }
+
+            return user["data"]?[0]?.Value<string>("profile_image_url");
+        }
+
+        /// <summary>
+        /// Gets the offline image url corresponding to the authenticated user.
+        /// </summary>
+        public static string GetOfflineImageUrl([NotNull] JObject user)
+        {
+            if (user == null)
+            {
+                throw new ArgumentNullException(nameof(user));
+            }
+
+            return user["data"]?[0]?.Value<string>("offline_image_url");
         }
     }
 }

src/AspNet.Security.OAuth.Twitch/TwitchAuthenticationOptions.cs

@@ -26,7 +26,7 @@ public TwitchAuthenticationOptions()
             TokenEndpoint = TwitchAuthenticationDefaults.TokenEndpoint;
             UserInformationEndpoint = TwitchAuthenticationDefaults.UserInformationEndpoint;
 
-            Scope.Add("user_read");
+            Scope.Add("user:read:email");
         }
     }
 }