TerribleDev/OwinOAuthProviders
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #98 from Res42/master

Browse Source 
Add Spotify provider
This commit is contained in:
Jerrie Pelser
2015-05-15 18:43:36 +07:00
parent 64955b9a0b 28ce309084
commit 55b0d7bb28
11 changed files with 673 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Owin.Security.Providers/Owin.Security.Providers.csproj
View File

@@ -247,6 +247,15 @@
<Compile Include="SoundCloud\SoundCloudAuthenticationHandler.cs" />
<Compile Include="SoundCloud\SoundCloudAuthenticationMiddleware.cs" />
<Compile Include="SoundCloud\SoundCloudAuthenticationOptions.cs" />
<Compile Include="Spotify\Constants.cs" />
<Compile Include="Spotify\Provider\ISpotifyAuthenticationProvider.cs" />
<Compile Include="Spotify\Provider\SpotifyAuthenticatedContext.cs" />
<Compile Include="Spotify\Provider\SpotifyAuthenticationProvider.cs" />
<Compile Include="Spotify\Provider\SpotifyReturnEndpointContext.cs" />
<Compile Include="Spotify\SpotifyAuthenticationExtensions.cs" />
<Compile Include="Spotify\SpotifyAuthenticationHandler.cs" />
<Compile Include="Spotify\SpotifyAuthenticationMiddleware.cs" />
<Compile Include="Spotify\SpotifyAuthenticationOptions.cs" />
<Compile Include="StackExchange\Constants.cs" />
<Compile Include="StackExchange\StackExchangeAuthenticationExtensions.cs" />
<Compile Include="StackExchange\StackExchangeAuthenticationHandler.cs" />

7
Owin.Security.Providers/Spotify/Constants.cs Normal file
View File

@@ -0,0 +1,7 @@
namespace Owin.Security.Providers.Spotify
{
internal static class Constants
{
public const string DefaultAuthenticationType = "Spotify";
}
}

24
Owin.Security.Providers/Spotify/Provider/ISpotifyAuthenticationProvider.cs Normal file
View File

@@ -0,0 +1,24 @@
using System.Threading.Tasks;
namespace Owin.Security.Providers.Spotify.Provider
{
/// <summary>
/// Specifies callback methods which the <see cref="SpotifyAuthenticationMiddleware"></see> invokes to enable developer control over the authentication process. />
/// </summary>
public interface ISpotifyAuthenticationProvider
{
/// <summary>
/// Invoked whenever Spotify succesfully authenticates a user
/// </summary>
/// <param name="context">Contains information about the login session as well as the user <see cref="System.Security.Claims.ClaimsIdentity"/>.</param>
/// <returns>A <see cref="Task"/> representing the completed operation.</returns>
Task Authenticated(SpotifyAuthenticatedContext context);
/// <summary>
/// Invoked prior to the <see cref="System.Security.Claims.ClaimsIdentity"/> being saved in a local cookie and the browser being redirected to the originally requested URL.
/// </summary>
/// <param name="context"></param>
/// <returns>A <see cref="Task"/> representing the completed operation.</returns>
Task ReturnEndpoint(SpotifyReturnEndpointContext context);
}
}

99
Owin.Security.Providers/Spotify/Provider/SpotifyAuthenticatedContext.cs Normal file
View File

@@ -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");
}
/// <summary>
/// Gets the JSON-serialized user
/// </summary>
/// <remarks>
/// Contains the Spotify user obtained from token ednpoint
/// </remarks>
public JObject User { get; private set; }
/// <summary>
/// Gets the Spotify access token
/// </summary>
public string AccessToken { get; private set; }
/// <summary>
/// Gets Spotify refresh token
/// </summary>
public string RefreshToken { get; private set; }
/// <summary>
/// Gets Spotify access token expiration time
/// </summary>
public TimeSpan? ExpiresIn { get; set; }
/// <summary>
/// Gets the Spotify user ID
/// </summary>
public string Id { get; private set; }
/// <summary>
/// Gets the user's name
/// </summary>
public string Name { get; private set; }
/// <summary>
/// Gets the Spotify users profile picture
/// </summary>
public string ProfilePicture { get; private set; }
/// <summary>
/// Gets the <see cref="ClaimsIdentity"/> representing the user
/// </summary>
public ClaimsIdentity Identity { get; set; }
/// <summary>
/// Gets or sets a property bag for common authentication properties
/// </summary>
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<string>(listEntryPropertyName);
}
}
}

50
Owin.Security.Providers/Spotify/Provider/SpotifyAuthenticationProvider.cs Normal file
View File

@@ -0,0 +1,50 @@
using System;
using System.Threading.Tasks;
namespace Owin.Security.Providers.Spotify.Provider
{
/// <summary>
/// Default <see cref="ISpotifyAuthenticationProvider"/> implementation.
/// </summary>
public class SpotifyAuthenticationProvider : ISpotifyAuthenticationProvider
{
/// <summary>
/// Initializes a <see cref="SpotifyAuthenticationProvider"/>
/// </summary>
public SpotifyAuthenticationProvider()
{
OnAuthenticated = context => Task.FromResult<object>(null);
OnReturnEndpoint = context => Task.FromResult<object>(null);
}
/// <summary>
/// Gets or sets the function that is invoked when the Authenticated method is invoked.
/// </summary>
public Func<SpotifyAuthenticatedContext, Task> OnAuthenticated { get; set; }
/// <summary>
/// Gets or sets the function that is invoked when the ReturnEndpoint method is invoked.
/// </summary>
public Func<SpotifyReturnEndpointContext, Task> OnReturnEndpoint { get; set; }
/// <summary>
/// Invoked whenever Spotify succesfully authenticates a user
/// </summary>
/// <param name="context">Contains information about the login session as well as the user <see cref="System.Security.Claims.ClaimsIdentity"/>.</param>
/// <returns>A <see cref="Task"/> representing the completed operation.</returns>
public virtual Task Authenticated(SpotifyAuthenticatedContext context)
{
return OnAuthenticated(context);
}
/// <summary>
/// Invoked prior to the <see cref="System.Security.Claims.ClaimsIdentity"/> being saved in a local cookie and the browser being redirected to the originally requested URL.
/// </summary>
/// <param name="context"></param>
/// <returns>A <see cref="Task"/> representing the completed operation.</returns>
public virtual Task ReturnEndpoint(SpotifyReturnEndpointContext context)
{
return OnReturnEndpoint(context);
}
}
}

21
Owin.Security.Providers/Spotify/Provider/SpotifyReturnEndpointContext.cs Normal file
View File

@@ -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
{
/// <summary>
///
/// </summary>
/// <param name="context">OWIN environment</param>
/// <param name="ticket">The authentication ticket</param>
public SpotifyReturnEndpointContext(
IOwinContext context,
AuthenticationTicket ticket)
: base(context, ticket)
{
}
}
}

29
Owin.Security.Providers/Spotify/SpotifyAuthenticationExtensions.cs Normal file
View File

@@ -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
});
}
}
}

243
Owin.Security.Providers/Spotify/SpotifyAuthenticationHandler.cs Normal file
View File

@@ -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<SpotifyAuthenticationOptions>
{
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<AuthenticationTicket> AuthenticateCoreAsync()
{
AuthenticationProperties properties = null;
try
{
string code = null;
string state = null;
IReadableStringCollection query = Request.Query;
IList<string> 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<KeyValuePair<string, string>>();
body.Add(new KeyValuePair<string, string>("grant_type", "authorization_code"));
body.Add(new KeyValuePair<string, string>("code", code));
body.Add(new KeyValuePair<string, string>("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<dynamic>(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<object>(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<object>(null);
}
public override async Task<bool> InvokeAsync()
{
return await InvokeReplyPathAsync();
}
private async Task<bool> 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;
}
}
}

86
Owin.Security.Providers/Spotify/SpotifyAuthenticationMiddleware.cs Normal file
View File

@@ -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<SpotifyAuthenticationOptions>
{
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<SpotifyAuthenticationMiddleware>();
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
};
}
/// <summary>
/// Provides the <see cref="T:Microsoft.Owin.Security.Infrastructure.AuthenticationHandler" /> object for processing
/// authentication-related requests.
/// </summary>
/// <returns>
/// An <see cref="T:Microsoft.Owin.Security.Infrastructure.AuthenticationHandler" /> configured with the
/// <see cref="T:Owin.Security.Providers.Spotify.SpotifyAuthenticationOptions" /> supplied to the constructor.
/// </returns>
protected override AuthenticationHandler<SpotifyAuthenticationOptions> 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;
}
}
}

100
Owin.Security.Providers/Spotify/SpotifyAuthenticationOptions.cs Normal file
View File

@@ -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
{
/// <summary>
/// Gets or sets the a pinned certificate validator to use to validate the endpoints used
/// in back channel communications belong to Spotify.
/// </summary>
/// <value>
/// The pinned certificate validator.
/// </value>
/// <remarks>
/// 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.
/// </remarks>
public ICertificateValidator BackchannelCertificateValidator { get; set; }
/// <summary>
/// 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.
/// </summary>
public HttpMessageHandler BackchannelHttpHandler { get; set; }
/// <summary>
/// Gets or sets timeout value in milliseconds for back channel communications with Spotify.
/// </summary>
/// <value>
/// The back channel timeout in milliseconds.
/// </value>
public TimeSpan BackchannelTimeout { get; set; }
/// <summary>
/// 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".
/// </summary>
public PathString CallbackPath { get; set; }
/// <summary>
/// Get or sets the text that the user can display on a sign in user interface.
/// </summary>
public string Caption
{
get { return Description.Caption; }
set { Description.Caption = value; }
}
/// <summary>
/// Gets or sets the Spotify supplied Client ID
/// </summary>
public string ClientId { get; set; }
/// <summary>
/// Gets or sets the Spotify supplied Client Secret
/// </summary>
public string ClientSecret { get; set; }
/// <summary>
/// Gets or sets the <see cref="ISpotifyAuthenticationProvider" /> used in the authentication events
/// </summary>
public ISpotifyAuthenticationProvider Provider { get; set; }
/// <summary>
/// A list of permissions to request.
/// </summary>
public IList<string> Scope { get; private set; }
/// <summary>
/// Gets or sets the name of another authentication middleware which will be responsible for actually issuing a user
/// <see cref="System.Security.Claims.ClaimsIdentity" />.
/// </summary>
public string SignInAsAuthenticationType { get; set; }
/// <summary>
/// Gets or sets the type used to secure data handled by the middleware.
/// </summary>
public ISecureDataFormat<AuthenticationProperties> StateDataFormat { get; set; }
/// <summary>
/// Initializes a new <see cref="SpotifyAuthenticationOptions" />
/// </summary>
public SpotifyAuthenticationOptions()
: base("Spotify")
{
Caption = Constants.DefaultAuthenticationType;
CallbackPath = new PathString("/signin-spotify");
AuthenticationMode = AuthenticationMode.Passive;
Scope = new List<string>();
BackchannelTimeout = TimeSpan.FromSeconds(60);
}
}
}

5
OwinOAuthProvidersDemo/App_Start/Startup.Auth.cs
View File

@@ -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: "");
}
}
}