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

Added Vimeo OAuth 2 Provider.

Browse Source
This commit is contained in:
Ben Foster
2015-08-27 16:53:36 +01:00
parent ace291da70
commit 6125132736
11 changed files with 631 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

@@ -336,6 +336,15 @@
<Compile Include="Twitch\Provider\TwitchAuthenticationProvider.cs" />
<Compile Include="Twitch\Provider\TwitchReturnEndpointContext.cs" />
<Compile Include="Twitch\Provider\ITwitchAuthenticationProvider.cs" />
<Compile Include="Vimeo\Constants.cs" />
<Compile Include="Vimeo\Provider\IVimeoAuthenticationProvider.cs" />
<Compile Include="Vimeo\Provider\VimeoAuthenticatedContext.cs" />
<Compile Include="Vimeo\Provider\VimeoAuthenticationProvider.cs" />
<Compile Include="Vimeo\Provider\VimeoReturnEndpointContext.cs" />
<Compile Include="Vimeo\VimeoAuthenticationExtensions.cs" />
<Compile Include="Vimeo\VimeoAuthenticationHandler.cs" />
<Compile Include="Vimeo\VimeoAuthenticationMiddleware.cs" />
<Compile Include="Vimeo\VimeoAuthenticationOptions.cs" />
<Compile Include="VisualStudio\Constants.cs" />
<Compile Include="VisualStudio\Provider\IVisualStudioAuthenticationProvider.cs" />
<Compile Include="VisualStudio\Provider\VisualStudioAuthenticatedContext.cs" />

8
Owin.Security.Providers/Vimeo/Constants.cs Normal file
View File

@@ -0,0 +1,8 @@

namespace Owin.Security.Providers.Vimeo
{
internal static class Constants
{
public const string DefaultAuthenticationType = "Vimeo";
}
}

24
Owin.Security.Providers/Vimeo/Provider/IVimeoAuthenticationProvider.cs Normal file
View File

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

77
Owin.Security.Providers/Vimeo/Provider/VimeoAuthenticatedContext.cs Normal file
View File

@@ -0,0 +1,77 @@
// 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;
using Newtonsoft.Json.Linq;
using System.Security.Claims;
namespace Owin.Security.Providers.Vimeo
{
/// <summary>
/// Contains information about the login session as well as the user <see cref="System.Security.Claims.ClaimsIdentity"/>.
/// </summary>
public class VimeoAuthenticatedContext : BaseContext
{
/// <summary>
/// Initializes a <see cref="VimeoAuthenticatedContext"/>
/// </summary>
/// <param name="context">The OWIN environment</param>
/// <param name="user">The JSON-serialized user</param>
/// <param name="accessToken">Vimeo Access token</param>
public VimeoAuthenticatedContext(IOwinContext context, JObject user, string accessToken)
: base(context)
{
User = user;
AccessToken = accessToken;
Name = TryGetValue(user, "name");
var uri = TryGetValue(user, "uri");
if (!string.IsNullOrEmpty(uri))
{
Id = uri.Substring(uri.LastIndexOf("/") + 1); // parse format /users/123456
}
}
/// <summary>
/// Gets the JSON-serialized user
/// </summary>
/// <remarks>
/// Contains the Vimeo user included in the Authentication response
/// https://developer.vimeo.com/api/endpoints/me
/// </remarks>
public JObject User { get; private set; }
/// <summary>
/// Gets the Vimeo OAuth access token
/// </summary>
public string AccessToken { get; private set; }
/// <summary>
/// Gets the Vimeo user ID
/// </summary>
public string Id { get; private set; }
/// <summary>
/// Get the name of the user
/// </summary>
public string Name { 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;
}
}
}

50
Owin.Security.Providers/Vimeo/Provider/VimeoAuthenticationProvider.cs Normal file
View File

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

26
Owin.Security.Providers/Vimeo/Provider/VimeoReturnEndpointContext.cs Normal file
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.Vimeo
{
/// <summary>
/// Provides context information to middleware providers.
/// </summary>
public class VimeoReturnEndpointContext : ReturnEndpointContext
{
/// <summary>
/// Initializes a <see cref="VimeoReturnEndpointContext"/>
/// </summary>
/// <param name="context">OWIN environment</param>
/// <param name="ticket">The authentication ticket</param>
public VimeoReturnEndpointContext(
IOwinContext context,
AuthenticationTicket ticket)
: base(context, ticket)
{
}
}
}

33
Owin.Security.Providers/Vimeo/VimeoAuthenticationExtensions.cs Normal file
View File

@@ -0,0 +1,33 @@
using System;
namespace Owin.Security.Providers.Vimeo
{
public static class VimeoAuthenticationExtensions
{
public static IAppBuilder UseVimeoAuthentication(this IAppBuilder app, VimeoAuthenticationOptions options)
{
if (app == null)
throw new ArgumentNullException("app");
if (options == null)
throw new ArgumentNullException("options");
app.Use(typeof(VimeoAuthenticationMiddleware), app, options);
return app;
}
public static IAppBuilder UseVimeoAuthentication(this IAppBuilder app, string clientId, string clientSecret)
{
if (string.IsNullOrEmpty(clientId))
throw new ArgumentNullException("clientId");
if (string.IsNullOrEmpty(clientSecret))
throw new ArgumentNullException("clientSecret");
return app.UseVimeoAuthentication(new VimeoAuthenticationOptions
{
ClientId = clientId,
ClientSecret = clientSecret
});
}
}
}

220
Owin.Security.Providers/Vimeo/VimeoAuthenticationHandler.cs Normal file
View File

@@ -0,0 +1,220 @@
using Microsoft.Owin;
using Microsoft.Owin.Infrastructure;
using Microsoft.Owin.Logging;
using Microsoft.Owin.Security;
using Microsoft.Owin.Security.Infrastructure;
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Security.Claims;
using System.Threading.Tasks;
namespace Owin.Security.Providers.Vimeo
{
public class VimeoAuthenticationHandler : AuthenticationHandler<VimeoAuthenticationOptions>
{
private const string XmlSchemaString = "http://www.w3.org/2001/XMLSchema#string";
private const string TokenEndpoint = "https://api.vimeo.com/oauth/access_token";
private const string AuthorizationEndpoint = "https://api.vimeo.com/oauth/authorize";
private readonly ILogger logger;
private readonly HttpClient httpClient;
public VimeoAuthenticationHandler(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>("grant_type", "authorization_code"));
body.Add(new KeyValuePair<string, string>("code", code));
body.Add(new KeyValuePair<string, string>("redirect_uri", redirectUri));
body.Add(new KeyValuePair<string, string>("client_id", Options.ClientId));
body.Add(new KeyValuePair<string, string>("client_secret", Options.ClientSecret));
// Request the token
HttpResponseMessage tokenResponse =
await httpClient.PostAsync(TokenEndpoint, new FormUrlEncodedContent(body));
tokenResponse.EnsureSuccessStatusCode();
string text = await tokenResponse.Content.ReadAsStringAsync();
// Deserializes the token response
dynamic response = JsonConvert.DeserializeObject<dynamic>(text);
string accessToken = (string)response.access_token;
// Vimeo includes the user information in the response
var context = new VimeoAuthenticatedContext(Context, response.user, accessToken);
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);
string state = Options.StateDataFormat.Protect(properties);
string authorizationEndpoint =
AuthorizationEndpoint +
"?response_type=code" +
"&client_id=" + Uri.EscapeDataString(Options.ClientId) +
"&redirect_uri=" + Uri.EscapeDataString(redirectUri) +
"&state=" + Uri.EscapeDataString(state);
if (!string.IsNullOrWhiteSpace(Options.Scope))
{
authorizationEndpoint += "&scope=" + Uri.EscapeDataString(Options.Scope);
}
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)
{
AuthenticationTicket ticket = await AuthenticateAsync();
if (ticket == null)
{
logger.WriteWarning("Invalid return state, unable to redirect.");
Response.StatusCode = 500;
return true;
}
var context = new VimeoReturnEndpointContext(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;
}
}
}

84
Owin.Security.Providers/Vimeo/VimeoAuthenticationMiddleware.cs Normal file
View File

@@ -0,0 +1,84 @@
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 System;
using System.Globalization;
using System.Net.Http;
namespace Owin.Security.Providers.Vimeo
{
public class VimeoAuthenticationMiddleware : AuthenticationMiddleware<VimeoAuthenticationOptions>
{
private readonly HttpClient httpClient;
private readonly ILogger logger;
public VimeoAuthenticationMiddleware(OwinMiddleware next, IAppBuilder app, VimeoAuthenticationOptions 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<VimeoAuthenticationMiddleware>();
if (Options.Provider == null)
Options.Provider = new VimeoAuthenticationProvider();
if (Options.StateDataFormat == null)
{
IDataProtector dataProtector = app.CreateDataProtector(
typeof(VimeoAuthenticationMiddleware).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.Vimeo.VimeoAuthenticationOptions" /> supplied to the constructor.
/// </returns>
protected override AuthenticationHandler<VimeoAuthenticationOptions> CreateHandler()
{
return new VimeoAuthenticationHandler(httpClient, logger);
}
private HttpMessageHandler ResolveHttpMessageHandler(VimeoAuthenticationOptions 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;
}
}
}

97
Owin.Security.Providers/Vimeo/VimeoAuthenticationOptions.cs Normal file
View File

@@ -0,0 +1,97 @@
using Microsoft.Owin;
using Microsoft.Owin.Security;
using System;
using System.Net.Http;
namespace Owin.Security.Providers.Vimeo
{
public class VimeoAuthenticationOptions : AuthenticationOptions
{
/// <summary>
/// Gets or sets the a pinned certificate validator to use to validate the endpoints used
/// in back channel communications belong to Vimeo
/// </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 Vimeo.
/// 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 Vimeo.
/// </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-vimeo".
/// </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 Vimeo supplied Client ID
/// </summary>
public string ClientId { get; set; }
/// <summary>
/// Gets or sets the Vimeo supplied Client Secret
/// </summary>
public string ClientSecret { get; set; }
/// <summary>
/// Gets or sets the <see cref="IVimeoAuthenticationProvider" /> used in the authentication events
/// </summary>
public IVimeoAuthenticationProvider Provider { get; set; }
/// <summary>
/// A list of permissions to request as per https://developer.vimeo.com/api/authentication
/// </summary>
public string Scope { get; 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="VimeoAuthenticationOptions" />
/// </summary>
public VimeoAuthenticationOptions()
: base("Vimeo")
{
Caption = Constants.DefaultAuthenticationType;
CallbackPath = new PathString("/signin-vimeo");
AuthenticationMode = AuthenticationMode.Passive;
BackchannelTimeout = TimeSpan.FromSeconds(60);
}
}
}

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

@@ -38,6 +38,7 @@ using Owin.Security.Providers.Wargaming;
using Owin.Security.Providers.WordPress;
using Owin.Security.Providers.Yahoo;
using Owin.Security.Providers.Backlog;
using Owin.Security.Providers.Vimeo;
namespace OwinOAuthProvidersDemo
{
@@ -284,6 +285,8 @@ namespace OwinOAuthProvidersDemo
// ClientServer = "cosignservername"
//};
//app.UseCosignAuthentication(cosignOptions);
//app.UseVimeoAuthentication("", "");
}
}
}