diff --git a/Owin.Security.Providers/Owin.Security.Providers.csproj b/Owin.Security.Providers/Owin.Security.Providers.csproj index 6a1c36b..4108ac5 100644 --- a/Owin.Security.Providers/Owin.Security.Providers.csproj +++ b/Owin.Security.Providers/Owin.Security.Providers.csproj @@ -247,6 +247,15 @@ + + + + + + + + + diff --git a/Owin.Security.Providers/Spotify/Constants.cs b/Owin.Security.Providers/Spotify/Constants.cs new file mode 100644 index 0000000..8cfc92a --- /dev/null +++ b/Owin.Security.Providers/Spotify/Constants.cs @@ -0,0 +1,7 @@ +namespace Owin.Security.Providers.Spotify +{ + internal static class Constants + { + public const string DefaultAuthenticationType = "Spotify"; + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/Spotify/Provider/ISpotifyAuthenticationProvider.cs b/Owin.Security.Providers/Spotify/Provider/ISpotifyAuthenticationProvider.cs new file mode 100644 index 0000000..46aa68f --- /dev/null +++ b/Owin.Security.Providers/Spotify/Provider/ISpotifyAuthenticationProvider.cs @@ -0,0 +1,24 @@ +using System.Threading.Tasks; + +namespace Owin.Security.Providers.Spotify.Provider +{ + /// + /// Specifies callback methods which the invokes to enable developer control over the authentication process. /> + /// + public interface ISpotifyAuthenticationProvider + { + /// + /// Invoked whenever Spotify succesfully authenticates a user + /// + /// Contains information about the login session as well as the user . + /// A representing the completed operation. + Task Authenticated(SpotifyAuthenticatedContext context); + + /// + /// Invoked prior to the being saved in a local cookie and the browser being redirected to the originally requested URL. + /// + /// + /// A representing the completed operation. + Task ReturnEndpoint(SpotifyReturnEndpointContext context); + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/Spotify/Provider/SpotifyAuthenticatedContext.cs b/Owin.Security.Providers/Spotify/Provider/SpotifyAuthenticatedContext.cs new file mode 100644 index 0000000..2be9efc --- /dev/null +++ b/Owin.Security.Providers/Spotify/Provider/SpotifyAuthenticatedContext.cs @@ -0,0 +1,99 @@ +using Microsoft.Owin; +using Microsoft.Owin.Security; +using Microsoft.Owin.Security.Provider; +using Newtonsoft.Json.Linq; +using System; +using System.Globalization; +using System.Security.Claims; + +namespace Owin.Security.Providers.Spotify.Provider +{ + public class SpotifyAuthenticatedContext: BaseContext + { + public SpotifyAuthenticatedContext(IOwinContext context, JObject user, string accessToken, string refreshToken, string expiresIn) + : base(context) + { + User = user; + AccessToken = accessToken; + RefreshToken = refreshToken; + + int expiresValue; + if (Int32.TryParse(expiresIn, NumberStyles.Integer, CultureInfo.InvariantCulture, out expiresValue)) + { + ExpiresIn = TimeSpan.FromSeconds(expiresValue); + } + + Id = TryGetValue(user, "id"); + Name = TryGetValue(user, "display_name"); + + ProfilePicture = TryGetListValue(user, "images", 0, "url"); + } + + /// + /// Gets the JSON-serialized user + /// + /// + /// Contains the Spotify user obtained from token ednpoint + /// + public JObject User { get; private set; } + + /// + /// Gets the Spotify access token + /// + public string AccessToken { get; private set; } + + /// + /// Gets Spotify refresh token + /// + public string RefreshToken { get; private set; } + + /// + /// Gets Spotify access token expiration time + /// + public TimeSpan? ExpiresIn { get; set; } + + /// + /// Gets the Spotify user ID + /// + public string Id { get; private set; } + + /// + /// Gets the user's name + /// + public string Name { get; private set; } + + /// + /// Gets the Spotify users profile picture + /// + public string ProfilePicture { get; private set; } + + /// + /// Gets the representing the user + /// + public ClaimsIdentity Identity { get; set; } + + /// + /// Gets or sets a property bag for common authentication properties + /// + public AuthenticationProperties Properties { get; set; } + + private static string TryGetValue(JObject user, string propertyName) + { + JToken value; + return user.TryGetValue(propertyName, out value) ? value.ToString() : null; + } + + private static string TryGetListValue(JObject user, string listPropertyName, int listPosition, string listEntryPropertyName) + { + JToken listValue; + bool valueExists = user.TryGetValue(listPropertyName, out listValue); + if (!valueExists) return null; + JArray list = (JArray)listValue; + + if (list.Count <= listPosition) return null; + JToken entry = list[listPosition]; + + return entry.Value(listEntryPropertyName); + } + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/Spotify/Provider/SpotifyAuthenticationProvider.cs b/Owin.Security.Providers/Spotify/Provider/SpotifyAuthenticationProvider.cs new file mode 100644 index 0000000..e8cee09 --- /dev/null +++ b/Owin.Security.Providers/Spotify/Provider/SpotifyAuthenticationProvider.cs @@ -0,0 +1,50 @@ +using System; +using System.Threading.Tasks; + +namespace Owin.Security.Providers.Spotify.Provider +{ + /// + /// Default implementation. + /// + public class SpotifyAuthenticationProvider : ISpotifyAuthenticationProvider + { + /// + /// Initializes a + /// + public SpotifyAuthenticationProvider() + { + OnAuthenticated = context => Task.FromResult(null); + OnReturnEndpoint = context => Task.FromResult(null); + } + + /// + /// Gets or sets the function that is invoked when the Authenticated method is invoked. + /// + public Func OnAuthenticated { get; set; } + + /// + /// Gets or sets the function that is invoked when the ReturnEndpoint method is invoked. + /// + public Func OnReturnEndpoint { get; set; } + + /// + /// Invoked whenever Spotify succesfully authenticates a user + /// + /// Contains information about the login session as well as the user . + /// A representing the completed operation. + public virtual Task Authenticated(SpotifyAuthenticatedContext context) + { + return OnAuthenticated(context); + } + + /// + /// Invoked prior to the being saved in a local cookie and the browser being redirected to the originally requested URL. + /// + /// + /// A representing the completed operation. + public virtual Task ReturnEndpoint(SpotifyReturnEndpointContext context) + { + return OnReturnEndpoint(context); + } + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/Spotify/Provider/SpotifyReturnEndpointContext.cs b/Owin.Security.Providers/Spotify/Provider/SpotifyReturnEndpointContext.cs new file mode 100644 index 0000000..9ae6e0f --- /dev/null +++ b/Owin.Security.Providers/Spotify/Provider/SpotifyReturnEndpointContext.cs @@ -0,0 +1,21 @@ +using Microsoft.Owin; +using Microsoft.Owin.Security; +using Microsoft.Owin.Security.Provider; + +namespace Owin.Security.Providers.Spotify.Provider +{ + public class SpotifyReturnEndpointContext : ReturnEndpointContext + { + /// + /// + /// + /// OWIN environment + /// The authentication ticket + public SpotifyReturnEndpointContext( + IOwinContext context, + AuthenticationTicket ticket) + : base(context, ticket) + { + } + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/Spotify/SpotifyAuthenticationExtensions.cs b/Owin.Security.Providers/Spotify/SpotifyAuthenticationExtensions.cs new file mode 100644 index 0000000..821ebbe --- /dev/null +++ b/Owin.Security.Providers/Spotify/SpotifyAuthenticationExtensions.cs @@ -0,0 +1,29 @@ +using System; + +namespace Owin.Security.Providers.Spotify +{ + public static class SpotifyAuthenticationExtensions + { + public static IAppBuilder UseSpotifyAuthentication(this IAppBuilder app, + SpotifyAuthenticationOptions options) + { + if (app == null) + throw new ArgumentNullException("app"); + if (options == null) + throw new ArgumentNullException("options"); + + app.Use(typeof(SpotifyAuthenticationMiddleware), app, options); + + return app; + } + + public static IAppBuilder UseSpotifyAuthentication(this IAppBuilder app, string clientId, string clientSecret) + { + return app.UseSpotifyAuthentication(new SpotifyAuthenticationOptions + { + ClientId = clientId, + ClientSecret = clientSecret + }); + } + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/Spotify/SpotifyAuthenticationHandler.cs b/Owin.Security.Providers/Spotify/SpotifyAuthenticationHandler.cs new file mode 100644 index 0000000..cd55e04 --- /dev/null +++ b/Owin.Security.Providers/Spotify/SpotifyAuthenticationHandler.cs @@ -0,0 +1,243 @@ +using Microsoft.Owin; +using Microsoft.Owin.Infrastructure; +using Microsoft.Owin.Logging; +using Microsoft.Owin.Security; +using Microsoft.Owin.Security.Infrastructure; +using Newtonsoft.Json; +using Newtonsoft.Json.Linq; +using Owin.Security.Providers.Spotify.Provider; +using System; +using System.Collections.Generic; +using System.Net.Http; +using System.Net.Http.Headers; +using System.Security.Claims; +using System.Text; +using System.Threading.Tasks; + +namespace Owin.Security.Providers.Spotify +{ + public class SpotifyAuthenticationHandler : AuthenticationHandler + { + private const string XmlSchemaString = "http://www.w3.org/2001/XMLSchema#string"; + private const string TokenEndpoint = "https://accounts.spotify.com/api/token"; + private const string UserInfoEndpoint = "https://api.spotify.com/v1/me"; + + private readonly ILogger logger; + private readonly HttpClient httpClient; + + public SpotifyAuthenticationHandler(HttpClient httpClient, ILogger logger) + { + this.httpClient = httpClient; + this.logger = logger; + } + + protected override async Task AuthenticateCoreAsync() + { + AuthenticationProperties properties = null; + + try + { + string code = null; + string state = null; + + IReadableStringCollection query = Request.Query; + IList values = query.GetValues("code"); + if (values != null && values.Count == 1) + { + code = values[0]; + } + values = query.GetValues("state"); + if (values != null && values.Count == 1) + { + state = values[0]; + } + + properties = Options.StateDataFormat.Unprotect(state); + if (properties == null) + { + return null; + } + + // OAuth2 10.12 CSRF + if (!ValidateCorrelationId(properties, logger)) + { + return new AuthenticationTicket(null, properties); + } + + // Check for error + if (Request.Query.Get("error") != null) + return new AuthenticationTicket(null, properties); + + string requestPrefix = Request.Scheme + "://" + Request.Host; + string redirectUri = requestPrefix + Request.PathBase + Options.CallbackPath; + + // Build up the body for the token request + var body = new List>(); + body.Add(new KeyValuePair("grant_type", "authorization_code")); + body.Add(new KeyValuePair("code", code)); + body.Add(new KeyValuePair("redirect_uri", redirectUri)); + + string secret = Options.ClientId + ":" + Options.ClientSecret; + var secretBase64 = Convert.ToBase64String(Encoding.UTF8.GetBytes(secret)); + + HttpRequestMessage tokenRequest = new HttpRequestMessage(HttpMethod.Post, TokenEndpoint); + tokenRequest.Headers.Authorization = new AuthenticationHeaderValue("Basic", secretBase64); + tokenRequest.Content = new FormUrlEncodedContent(body); + + // Request the token + HttpResponseMessage tokenResponse = await httpClient.SendAsync(tokenRequest); + tokenResponse.EnsureSuccessStatusCode(); + string text = await tokenResponse.Content.ReadAsStringAsync(); + + // Deserializes the token response + dynamic response = JsonConvert.DeserializeObject(text); + string accessToken = (string)response.access_token; + string refreshToken = (string)response.refresh_token; + string expiresIn = (string)response.expires_in; + + // Get the Spotify user + HttpRequestMessage graphRequest = new HttpRequestMessage(HttpMethod.Get, UserInfoEndpoint); + graphRequest.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken); + + HttpResponseMessage graphResponse = await httpClient.SendAsync(graphRequest, Request.CallCancelled); + graphResponse.EnsureSuccessStatusCode(); + text = await graphResponse.Content.ReadAsStringAsync(); + JObject user = JObject.Parse(text); + + var context = new SpotifyAuthenticatedContext(Context, user, accessToken, refreshToken, expiresIn); + context.Identity = new ClaimsIdentity( + Options.AuthenticationType, + ClaimsIdentity.DefaultNameClaimType, + ClaimsIdentity.DefaultRoleClaimType); + if (!string.IsNullOrEmpty(context.Id)) + { + context.Identity.AddClaim(new Claim(ClaimTypes.NameIdentifier, context.Id, XmlSchemaString, Options.AuthenticationType)); + } + if (!string.IsNullOrEmpty(context.Name)) + { + context.Identity.AddClaim(new Claim(ClaimsIdentity.DefaultNameClaimType, context.Name, XmlSchemaString, Options.AuthenticationType)); + } + if (!string.IsNullOrEmpty(context.ProfilePicture)) + { + context.Identity.AddClaim(new Claim("urn:spotify:profilepicture", context.ProfilePicture, XmlSchemaString, Options.AuthenticationType)); + } + context.Properties = properties; + + await Options.Provider.Authenticated(context); + + return new AuthenticationTicket(context.Identity, context.Properties); + } + catch (Exception ex) + { + logger.WriteError(ex.Message); + } + return new AuthenticationTicket(null, properties); + } + + protected override Task ApplyResponseChallengeAsync() + { + if (Response.StatusCode != 401) + { + return Task.FromResult(null); + } + + AuthenticationResponseChallenge challenge = Helper.LookupChallenge(Options.AuthenticationType, Options.AuthenticationMode); + + if (challenge != null) + { + string baseUri = + Request.Scheme + + Uri.SchemeDelimiter + + Request.Host + + Request.PathBase; + + string currentUri = + baseUri + + Request.Path + + Request.QueryString; + + string redirectUri = + baseUri + + Options.CallbackPath; + + AuthenticationProperties properties = challenge.Properties; + if (string.IsNullOrEmpty(properties.RedirectUri)) + { + properties.RedirectUri = currentUri; + } + + // OAuth2 10.12 CSRF + GenerateCorrelationId(properties); + + string scope = string.Join(" ", Options.Scope); + + string state = Options.StateDataFormat.Protect(properties); + + string authorizationEndpoint = + "https://accounts.spotify.com/authorize" + + "?response_type=code" + + "&client_id=" + Uri.EscapeDataString(Options.ClientId) + + "&redirect_uri=" + Uri.EscapeDataString(redirectUri) + + "&scope=" + Uri.EscapeDataString(scope) + + "&state=" + Uri.EscapeDataString(state); + + Response.Redirect(authorizationEndpoint); + } + + return Task.FromResult(null); + } + + public override async Task InvokeAsync() + { + return await InvokeReplyPathAsync(); + } + + private async Task InvokeReplyPathAsync() + { + if (Options.CallbackPath.HasValue && Options.CallbackPath == Request.Path) + { + // TODO: error responses + + AuthenticationTicket ticket = await AuthenticateAsync(); + if (ticket == null) + { + logger.WriteWarning("Invalid return state, unable to redirect."); + Response.StatusCode = 500; + return true; + } + + var context = new SpotifyReturnEndpointContext(Context, ticket); + context.SignInAsAuthenticationType = Options.SignInAsAuthenticationType; + context.RedirectUri = ticket.Properties.RedirectUri; + + await Options.Provider.ReturnEndpoint(context); + + if (context.SignInAsAuthenticationType != null && + context.Identity != null) + { + ClaimsIdentity grantIdentity = context.Identity; + if (!string.Equals(grantIdentity.AuthenticationType, context.SignInAsAuthenticationType, StringComparison.Ordinal)) + { + grantIdentity = new ClaimsIdentity(grantIdentity.Claims, context.SignInAsAuthenticationType, grantIdentity.NameClaimType, grantIdentity.RoleClaimType); + } + Context.Authentication.SignIn(context.Properties, grantIdentity); + } + + if (!context.IsRequestCompleted && context.RedirectUri != null) + { + string redirectUri = context.RedirectUri; + if (context.Identity == null) + { + // add a redirect hint that sign-in failed in some way + redirectUri = WebUtilities.AddQueryString(redirectUri, "error", "access_denied"); + } + Response.Redirect(redirectUri); + context.RequestCompleted(); + } + + return context.IsRequestCompleted; + } + return false; + } + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/Spotify/SpotifyAuthenticationMiddleware.cs b/Owin.Security.Providers/Spotify/SpotifyAuthenticationMiddleware.cs new file mode 100644 index 0000000..acbaaa8 --- /dev/null +++ b/Owin.Security.Providers/Spotify/SpotifyAuthenticationMiddleware.cs @@ -0,0 +1,86 @@ +using Microsoft.Owin; +using Microsoft.Owin.Logging; +using Microsoft.Owin.Security; +using Microsoft.Owin.Security.DataHandler; +using Microsoft.Owin.Security.DataProtection; +using Microsoft.Owin.Security.Infrastructure; +using Owin.Security.Providers.Properties; +using Owin.Security.Providers.Spotify.Provider; +using System; +using System.Globalization; +using System.Net.Http; + +namespace Owin.Security.Providers.Spotify +{ + public class SpotifyAuthenticationMiddleware : AuthenticationMiddleware + { + private readonly HttpClient httpClient; + private readonly ILogger logger; + + public SpotifyAuthenticationMiddleware(OwinMiddleware next, IAppBuilder app, + SpotifyAuthenticationOptions options) + : base(next, options) + { + if (String.IsNullOrWhiteSpace(Options.ClientId)) + throw new ArgumentException(String.Format(CultureInfo.CurrentCulture, + Resources.Exception_OptionMustBeProvided, "ClientId")); + if (String.IsNullOrWhiteSpace(Options.ClientSecret)) + throw new ArgumentException(String.Format(CultureInfo.CurrentCulture, + Resources.Exception_OptionMustBeProvided, "ClientSecret")); + + logger = app.CreateLogger(); + + if (Options.Provider == null) + Options.Provider = new SpotifyAuthenticationProvider(); + + if (Options.StateDataFormat == null) + { + IDataProtector dataProtector = app.CreateDataProtector( + typeof(SpotifyAuthenticationMiddleware).FullName, + Options.AuthenticationType, "v1"); + Options.StateDataFormat = new PropertiesDataFormat(dataProtector); + } + + if (String.IsNullOrEmpty(Options.SignInAsAuthenticationType)) + Options.SignInAsAuthenticationType = app.GetDefaultSignInAsAuthenticationType(); + + httpClient = new HttpClient(ResolveHttpMessageHandler(Options)) + { + Timeout = Options.BackchannelTimeout, + MaxResponseContentBufferSize = 1024 * 1024 * 10 + }; + } + + /// + /// Provides the object for processing + /// authentication-related requests. + /// + /// + /// An configured with the + /// supplied to the constructor. + /// + protected override AuthenticationHandler CreateHandler() + { + return new SpotifyAuthenticationHandler(httpClient, logger); + } + + private HttpMessageHandler ResolveHttpMessageHandler(SpotifyAuthenticationOptions options) + { + HttpMessageHandler handler = options.BackchannelHttpHandler ?? new WebRequestHandler(); + + // If they provided a validator, apply it or fail. + if (options.BackchannelCertificateValidator != null) + { + // Set the cert validate callback + var webRequestHandler = handler as WebRequestHandler; + if (webRequestHandler == null) + { + throw new InvalidOperationException(Resources.Exception_ValidatorHandlerMismatch); + } + webRequestHandler.ServerCertificateValidationCallback = options.BackchannelCertificateValidator.Validate; + } + + return handler; + } + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/Spotify/SpotifyAuthenticationOptions.cs b/Owin.Security.Providers/Spotify/SpotifyAuthenticationOptions.cs new file mode 100644 index 0000000..61460d4 --- /dev/null +++ b/Owin.Security.Providers/Spotify/SpotifyAuthenticationOptions.cs @@ -0,0 +1,100 @@ +using Microsoft.Owin; +using Microsoft.Owin.Security; +using Owin.Security.Providers.Spotify.Provider; +using System; +using System.Collections.Generic; +using System.Net.Http; + +namespace Owin.Security.Providers.Spotify +{ + public class SpotifyAuthenticationOptions : AuthenticationOptions + { + /// + /// Gets or sets the a pinned certificate validator to use to validate the endpoints used + /// in back channel communications belong to Spotify. + /// + /// + /// The pinned certificate validator. + /// + /// + /// If this property is null then the default certificate checks are performed, + /// validating the subject name and if the signing chain is a trusted party. + /// + public ICertificateValidator BackchannelCertificateValidator { get; set; } + + /// + /// The HttpMessageHandler used to communicate with Spotify. + /// This cannot be set at the same time as BackchannelCertificateValidator unless the value + /// can be downcast to a WebRequestHandler. + /// + public HttpMessageHandler BackchannelHttpHandler { get; set; } + + /// + /// Gets or sets timeout value in milliseconds for back channel communications with Spotify. + /// + /// + /// The back channel timeout in milliseconds. + /// + public TimeSpan BackchannelTimeout { get; set; } + + /// + /// The request path within the application's base path where the user-agent will be returned. + /// The middleware will process this request when it arrives. + /// Default value is "/signin-spotify". + /// + public PathString CallbackPath { get; set; } + + /// + /// Get or sets the text that the user can display on a sign in user interface. + /// + public string Caption + { + get { return Description.Caption; } + set { Description.Caption = value; } + } + + /// + /// Gets or sets the Spotify supplied Client ID + /// + public string ClientId { get; set; } + + /// + /// Gets or sets the Spotify supplied Client Secret + /// + public string ClientSecret { get; set; } + + /// + /// Gets or sets the used in the authentication events + /// + public ISpotifyAuthenticationProvider Provider { get; set; } + + /// + /// A list of permissions to request. + /// + public IList Scope { get; private set; } + + /// + /// Gets or sets the name of another authentication middleware which will be responsible for actually issuing a user + /// . + /// + public string SignInAsAuthenticationType { get; set; } + + /// + /// Gets or sets the type used to secure data handled by the middleware. + /// + public ISecureDataFormat StateDataFormat { get; set; } + + /// + /// Initializes a new + /// + public SpotifyAuthenticationOptions() + : base("Spotify") + { + Caption = Constants.DefaultAuthenticationType; + CallbackPath = new PathString("/signin-spotify"); + AuthenticationMode = AuthenticationMode.Passive; + Scope = new List(); + BackchannelTimeout = TimeSpan.FromSeconds(60); + } + } +} \ No newline at end of file diff --git a/OwinOAuthProvidersDemo/App_Start/Startup.Auth.cs b/OwinOAuthProvidersDemo/App_Start/Startup.Auth.cs index 7c3e80f..c1fe616 100755 --- a/OwinOAuthProvidersDemo/App_Start/Startup.Auth.cs +++ b/OwinOAuthProvidersDemo/App_Start/Startup.Auth.cs @@ -28,6 +28,7 @@ using Owin.Security.Providers.Twitch; using Owin.Security.Providers.Yahoo; using Owin.Security.Providers.OpenID; using Owin.Security.Providers.SoundCloud; +using Owin.Security.Providers.Spotify; using Owin.Security.Providers.Steam; using Owin.Security.Providers.Wargaming;using Owin.Security.Providers.Untappd;using Owin.Security.Providers.WordPress; @@ -225,6 +226,10 @@ namespace OwinOAuthProvidersDemo //app.UseVisualStudioAuthentication( // appId: "", // appSecret: ""); + + //app.UseSpotifyAuthentication( + // clientId: "", + // clientSecret: ""); } } } \ No newline at end of file