resolve conflicts

This commit is contained in:
Jerrie Pelser
2015-08-28 11:12:55 +07:00
12 changed files with 653 additions and 0 deletions

View File

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

View File

@@ -0,0 +1,29 @@
using System;
namespace Owin.Security.Providers.Fitbit
{
public static class FitbitAuthenticationExtensions
{
public static IAppBuilder UseFitbitAuthentication(this IAppBuilder app,
FitbitAuthenticationOptions options)
{
if (app == null)
throw new ArgumentNullException("app");
if (options == null)
throw new ArgumentNullException("options");
app.Use(typeof(FitbitAuthenticationMiddleware), app, options);
return app;
}
public static IAppBuilder UseFitbitAuthentication(this IAppBuilder app, string clientId, string clientSecret)
{
return app.UseFitbitAuthentication(new FitbitAuthenticationOptions
{
ClientId = clientId,
ClientSecret = clientSecret
});
}
}
}

View File

@@ -0,0 +1,233 @@
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;
using Microsoft.Owin;
using Microsoft.Owin.Infrastructure;
using Microsoft.Owin.Logging;
using Microsoft.Owin.Security;
using Microsoft.Owin.Security.DataHandler.Encoder;
using Microsoft.Owin.Security.Infrastructure;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using Owin.Security.Providers.Fitbit.Provider;
namespace Owin.Security.Providers.Fitbit
{
public class FitbitAuthenticationHandler : AuthenticationHandler<FitbitAuthenticationOptions>
{
private const string XmlSchemaString = "http://www.w3.org/2001/XMLSchema#string";
private readonly ILogger logger;
private readonly HttpClient httpClient;
public FitbitAuthenticationHandler(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);
}
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>("code", code));
body.Add(new KeyValuePair<string, string>("grant_type", "authorization_code"));
body.Add(new KeyValuePair<string, string>("client_id", Options.ClientId));
body.Add(new KeyValuePair<string, string>("redirect_uri", redirectUri));
// Request the token
var requestMessage = new HttpRequestMessage(HttpMethod.Post, Options.Endpoints.TokenEndpoint);
requestMessage.Headers.Authorization = new AuthenticationHeaderValue("Basic", new Base64TextEncoder().Encode(Encoding.ASCII.GetBytes(Options.ClientId + ":" + Options.ClientSecret)));
requestMessage.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
requestMessage.Content = new FormUrlEncodedContent(body);
HttpResponseMessage tokenResponse = await httpClient.SendAsync(requestMessage);
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;
// Get the user info
var userInfoRequest = new HttpRequestMessage(HttpMethod.Get, Options.Endpoints.UserEndpoint);
userInfoRequest.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);
userInfoRequest.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
HttpResponseMessage userInfoResponse = await httpClient.SendAsync(userInfoRequest);
userInfoResponse.EnsureSuccessStatusCode();
text = await userInfoResponse.Content.ReadAsStringAsync();
JObject user = JObject.Parse(text);
var context = new FitbitAuthenticatedContext(Context, user, accessToken, refreshToken);
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));
}
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);
// comma separated
string scope = string.Join(" ", Options.Scope);
string state = Options.StateDataFormat.Protect(properties);
string authorizationEndpoint =
Options.Endpoints.AuthorizationEndpoint +
"?client_id=" + Uri.EscapeDataString(Options.ClientId) +
"&response_type=" + Uri.EscapeDataString("code") +
"&scope=" + Uri.EscapeDataString(scope) +
"&redirect_uri=" + Uri.EscapeDataString(redirectUri) +
"&prompt=" + Uri.EscapeDataString(Options.Prompt) +
"&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 FitbitReturnEndpointContext(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;
}
}
}

View File

@@ -0,0 +1,69 @@
using System;
using System.Globalization;
using System.Net.Http;
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.Fitbit.Provider;
using Owin.Security.Providers.Properties;
namespace Owin.Security.Providers.Fitbit
{
public class FitbitAuthenticationMiddleware : AuthenticationMiddleware<FitbitAuthenticationOptions>
{
private readonly HttpClient httpClient;
private readonly ILogger logger;
public FitbitAuthenticationMiddleware(OwinMiddleware next, IAppBuilder app,
FitbitAuthenticationOptions 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<FitbitAuthenticationMiddleware>();
if (Options.Provider == null)
Options.Provider = new FitbitAuthenticationProvider();
if (Options.StateDataFormat == null)
{
IDataProtector dataProtector = app.CreateDataProtector(
typeof (FitbitAuthenticationMiddleware).FullName,
Options.AuthenticationType, "v1");
Options.StateDataFormat = new PropertiesDataFormat(dataProtector);
}
if (String.IsNullOrEmpty(Options.SignInAsAuthenticationType))
Options.SignInAsAuthenticationType = app.GetDefaultSignInAsAuthenticationType();
httpClient = new HttpClient(new WebRequestHandler())
{
Timeout = Options.BackchannelTimeout,
MaxResponseContentBufferSize = 1024*1024*10,
};
httpClient.DefaultRequestHeaders.UserAgent.ParseAdd("Microsoft Owin Fitbit middleware");
httpClient.DefaultRequestHeaders.ExpectContinue = false;
}
/// <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.Fitbit.FitbitAuthenticationOptions" /> supplied to the constructor.
/// </returns>
protected override AuthenticationHandler<FitbitAuthenticationOptions> CreateHandler()
{
return new FitbitAuthenticationHandler(httpClient, logger);
}
}
}

View File

@@ -0,0 +1,126 @@
using System;
using System.Collections.Generic;
using System.Net.Http;
using Microsoft.Owin;
using Microsoft.Owin.Security;
using Owin.Security.Providers.Fitbit.Provider;
namespace Owin.Security.Providers.Fitbit
{
public class FitbitAuthenticationOptions : AuthenticationOptions
{
public class FitbitAuthenticationEndpoints
{
/// <summary>
/// Endpoint which is used to redirect users to request Fitbit access
/// </summary>
/// <remarks>
/// Defaults to https://www.fitbit.com/oauth2/authorize
/// </remarks>
public string AuthorizationEndpoint { get; set; }
/// <summary>
/// Endpoint which is used to exchange code for access token
/// </summary>
/// <remarks>
/// Defaults to https://api.fitbit.com/oauth2/token
/// </remarks>
public string TokenEndpoint { get; set; }
public string UserEndpoint { get; set; }
}
private const string AuthorizationEndPoint = "https://www.fitbit.com/oauth2/authorize";
private const string TokenEndpoint = "https://api.fitbit.com/oauth2/token";
private const string UserEndpoint = "https://api.fitbit.com/1/user/-/profile.json";
/// <summary>
/// Gets or sets timeout value in milliseconds for back channel communications with Fitbit.
/// </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-Fitbit".
/// </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 Fitbit supplied Client ID
/// </summary>
public string ClientId { get; set; }
/// <summary>
/// Gets or sets the Fitbit supplied Client Secret
/// </summary>
public string ClientSecret { get; set; }
/// <summary>
/// Gets the sets of OAuth endpoints used to authenticate against Fitbit. Overriding these endpoints allows you to use Fitbit Enterprise for
/// authentication.
/// </summary>
public FitbitAuthenticationEndpoints Endpoints { get; set; }
/// <summary>
/// Gets or sets the <see cref="IFitbitAuthenticationProvider" /> used in the authentication events
/// </summary>
public IFitbitAuthenticationProvider 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 mode of the fitbit authentication page. Can be none, login, or consent. Defaults to none.
/// </summary>
public string Prompt { 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="FitbitAuthenticationOptions" />
/// </summary>
public FitbitAuthenticationOptions()
: base("Fitbit")
{
Caption = Constants.DefaultAuthenticationType;
CallbackPath = new PathString("/signin-fitbit");
AuthenticationMode = AuthenticationMode.Passive;
Scope = new List<string>
{
"activity", "nutrition", "profile", "settings", "sleep", "social", "weight"
};
BackchannelTimeout = TimeSpan.FromSeconds(60);
Endpoints = new FitbitAuthenticationEndpoints
{
AuthorizationEndpoint = AuthorizationEndPoint,
TokenEndpoint = TokenEndpoint,
UserEndpoint = UserEndpoint,
};
Prompt = "none";
}
}
}

View File

@@ -0,0 +1,72 @@
// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved. See License.txt in the project root for license information.
using System.Security.Claims;
using Microsoft.Owin;
using Microsoft.Owin.Security;
using Microsoft.Owin.Security.Provider;
using Newtonsoft.Json.Linq;
namespace Owin.Security.Providers.Fitbit.Provider
{
/// <summary>
/// Contains information about the login session as well as the user <see cref="System.Security.Claims.ClaimsIdentity"/>.
/// </summary>
public class FitbitAuthenticatedContext : BaseContext
{
/// <summary>
/// Initializes a <see cref="FitbitAuthenticatedContext"/>
/// </summary>
/// <param name="context">The OWIN environment</param>
/// <param name="user">The Fitbit user information</param>
/// <param name="accessToken">Fitbit Access token</param>
/// <param name="refreshToken">Fitbit Refresh token</param>
public FitbitAuthenticatedContext(IOwinContext context, JObject user, string accessToken, string refreshToken)
: base(context)
{
AccessToken = accessToken;
RefreshToken = refreshToken;
User = user;
Name = user.SelectToken("user.displayName").ToString();
Id = user.SelectToken("user.encodedId").ToString();
}
/// <summary>
/// Gets the user json object that was retrieved from Fitbit
/// during the authorization process.
/// </summary>
public JObject User { get; private set; }
/// <summary>
/// Gets the user name extracted from the Fitbit API during
/// the authorization process.
/// </summary>
public string Name { get; private set; }
/// <summary>
/// Gets the user id extracted from the FitbitAPI during the
/// authorization process.
/// </summary>
public string Id { get; private set; }
/// <summary>
/// Gets the Fitbit access token
/// </summary>
public string AccessToken { get; private set; }
/// <summary>
/// Gets the Fitbit refresh token
/// </summary>
public string RefreshToken { 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; }
}
}

View File

@@ -0,0 +1,50 @@
using System;
using System.Threading.Tasks;
namespace Owin.Security.Providers.Fitbit.Provider
{
/// <summary>
/// Default <see cref="IFitbitAuthenticationProvider"/> implementation.
/// </summary>
public class FitbitAuthenticationProvider : IFitbitAuthenticationProvider
{
/// <summary>
/// Initializes a <see cref="FitbitAuthenticationProvider"/>
/// </summary>
public FitbitAuthenticationProvider()
{
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<FitbitAuthenticatedContext, Task> OnAuthenticated { get; set; }
/// <summary>
/// Gets or sets the function that is invoked when the ReturnEndpoint method is invoked.
/// </summary>
public Func<FitbitReturnEndpointContext, Task> OnReturnEndpoint { get; set; }
/// <summary>
/// Invoked whenever Fitbit 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(FitbitAuthenticatedContext 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(FitbitReturnEndpointContext context)
{
return OnReturnEndpoint(context);
}
}
}

View File

@@ -0,0 +1,26 @@
// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved. See License.txt in the project root for license information.
using Microsoft.Owin;
using Microsoft.Owin.Security;
using Microsoft.Owin.Security.Provider;
namespace Owin.Security.Providers.Fitbit.Provider
{
/// <summary>
/// Provides context information to middleware providers.
/// </summary>
public class FitbitReturnEndpointContext : ReturnEndpointContext
{
/// <summary>
///
/// </summary>
/// <param name="context">OWIN environment</param>
/// <param name="ticket">The authentication ticket</param>
public FitbitReturnEndpointContext(
IOwinContext context,
AuthenticationTicket ticket)
: base(context, ticket)
{
}
}
}

View File

@@ -0,0 +1,24 @@
using System.Threading.Tasks;
namespace Owin.Security.Providers.Fitbit.Provider
{
/// <summary>
/// Specifies callback methods which the <see cref="FitbitAuthenticationMiddleware"></see> invokes to enable developer control over the authentication process. />
/// </summary>
public interface IFitbitAuthenticationProvider
{
/// <summary>
/// Invoked whenever Fitbit 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(FitbitAuthenticatedContext 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(FitbitReturnEndpointContext context);
}
}

View File

@@ -152,6 +152,15 @@
<Compile Include="Foursquare\Provider\FoursquareAuthenticationProvider.cs" />
<Compile Include="Foursquare\Provider\FoursquareReturnEndpointContext.cs" />
<Compile Include="Foursquare\Provider\IFoursquareAuthenticationProvider.cs" />
<Compile Include="Fitbit\Constants.cs" />
<Compile Include="Fitbit\FitbitAuthenticationExtensions.cs" />
<Compile Include="Fitbit\FitbitAuthenticationHandler.cs" />
<Compile Include="Fitbit\FitbitAuthenticationMiddleware.cs" />
<Compile Include="Fitbit\FitbitAuthenticationOptions.cs" />
<Compile Include="Fitbit\Provider\FitbitAuthenticatedContext.cs" />
<Compile Include="Fitbit\Provider\FitbitAuthenticationProvider.cs" />
<Compile Include="Fitbit\Provider\FitbitReturnEndpointContext.cs" />
<Compile Include="Fitbit\Provider\IFitbitAuthenticationProvider.cs" />
<Compile Include="GitHub\Constants.cs" />
<Compile Include="Gitter\Constants.cs" />
<Compile Include="Gitter\GitterAuthenticationExtensions.cs" />

View File

@@ -39,6 +39,7 @@ using Owin.Security.Providers.WordPress;
using Owin.Security.Providers.Yahoo;
using Owin.Security.Providers.Backlog;
using Owin.Security.Providers.Vimeo;
using Owin.Security.Providers.Fitbit;
namespace OwinOAuthProvidersDemo
{
@@ -287,6 +288,12 @@ namespace OwinOAuthProvidersDemo
//app.UseCosignAuthentication(cosignOptions);
//app.UseVimeoAuthentication("", "");
//app.UseFitbitAuthentication(new FitbitAuthenticationOptions
//{
// ClientId = "",
// ClientSecret = ""
//});
}
}
}

View File

@@ -14,6 +14,7 @@ Provides a set of extra authentication providers for OWIN ([Project Katana](http
- DeviantArt
- Dropbox
- EVEOnline
- Fitbit
- Flickr
- Foursquare
- GitHub