diff --git a/Owin.Security.Providers/OnShape/Constants.cs b/Owin.Security.Providers/OnShape/Constants.cs new file mode 100644 index 0000000..799fc53 --- /dev/null +++ b/Owin.Security.Providers/OnShape/Constants.cs @@ -0,0 +1,7 @@ +namespace Owin.Security.Providers.OnShape +{ + internal static class Constants + { + public const string DefaultAuthenticationType = "OnShape"; + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/OnShape/OnShapeAuthenticationExtensions.cs b/Owin.Security.Providers/OnShape/OnShapeAuthenticationExtensions.cs new file mode 100644 index 0000000..c915cba --- /dev/null +++ b/Owin.Security.Providers/OnShape/OnShapeAuthenticationExtensions.cs @@ -0,0 +1,29 @@ +using System; + +namespace Owin.Security.Providers.OnShape +{ + public static class OnShapeAuthenticationExtensions + { + public static IAppBuilder UseOnShapeAuthentication(this IAppBuilder app, + OnShapeAuthenticationOptions options) + { + if (app == null) + throw new ArgumentNullException("app"); + if (options == null) + throw new ArgumentNullException("options"); + + app.Use(typeof(OnShapeAuthenticationMiddleware), app, options); + + return app; + } + + public static IAppBuilder UseOnShapeAuthentication(this IAppBuilder app, string appKey, string appSecret) + { + return app.UseOnShapeAuthentication(new OnShapeAuthenticationOptions + { + AppKey = appKey, + AppSecret = appSecret + }); + } + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/OnShape/OnShapeAuthenticationHandler.cs b/Owin.Security.Providers/OnShape/OnShapeAuthenticationHandler.cs new file mode 100644 index 0000000..22c0473 --- /dev/null +++ b/Owin.Security.Providers/OnShape/OnShapeAuthenticationHandler.cs @@ -0,0 +1,247 @@ +using System; +using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; +using System.Net.Http; +using System.Security.Claims; +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 System.Net.Http.Headers; + +namespace Owin.Security.Providers.OnShape +{ + public class OnShapeAuthenticationHandler : AuthenticationHandler + { + private const string StateCookie = "_OnShapeState"; + private const string XmlSchemaString = "http://www.w3.org/2001/XMLSchema#string"; + private const string TokenEndpoint = "https://partner.dev.onshape.com/oauth/token"; + private const string UserInfoEndpoint = "https://partner.dev.onshape.com/api/users/current"; + + private readonly ILogger logger; + private readonly HttpClient httpClient; + + public OnShapeAuthenticationHandler(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]; + } + + state = Request.Cookies[StateCookie]; + 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)); + body.Add(new KeyValuePair("client_id", Options.AppKey)); + body.Add(new KeyValuePair("client_secret", Options.AppSecret)); + + // Request the token + //HttpResponseMessage tokenResponse = + // await httpClient.PostAsync(TokenEndpoint, new FormUrlEncodedContent(body)); + + // Get token + var tokenRequest = new HttpRequestMessage(HttpMethod.Post, TokenEndpoint); + tokenRequest.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json")); + tokenRequest.Content = new FormUrlEncodedContent(body); + + HttpResponseMessage tokenResponse = await httpClient.SendAsync(tokenRequest, Request.CallCancelled); + + tokenResponse.EnsureSuccessStatusCode(); + string text = await tokenResponse.Content.ReadAsStringAsync(); + + // Deserializes the token response + dynamic response = JsonConvert.DeserializeObject(text); + string accessToken = (string)response.access_token; + + // Get the OnShape user + //HttpResponseMessage graphResponse = await httpClient.GetAsync( + // UserInfoEndpoint + "?access_token=" + Uri.EscapeDataString(accessToken), Request.CallCancelled); + + string tokenType = (string)response.token_type; + + var userRequest = new HttpRequestMessage(HttpMethod.Get, UserInfoEndpoint); + userRequest.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json")); + //userRequest.Headers.Authorization = new AuthenticationHeaderValue(tokenType, Uri.EscapeDataString(accessToken)); + userRequest.Headers.Authorization = new AuthenticationHeaderValue(tokenType, accessToken); + HttpResponseMessage graphResponse = await httpClient.SendAsync(userRequest, Request.CallCancelled); + + graphResponse.EnsureSuccessStatusCode(); + text = await graphResponse.Content.ReadAsStringAsync(); + JObject user = JObject.Parse(text); + + var context = new OnShapeAuthenticatedContext(Context, 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(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 authorizationEndpoint = + "https://partner.dev.onshape.com/oauth/authorize" + + "?response_type=code" + + "&client_id=" + Uri.EscapeDataString(Options.AppKey) + + "&redirect_uri=" + Uri.EscapeDataString(redirectUri); + + var cookieOptions = new CookieOptions + { + HttpOnly = true, + Secure = Request.IsSecure + }; + + Response.StatusCode = 302; + Response.Cookies.Append(StateCookie, Options.StateDataFormat.Protect(properties), cookieOptions); + Response.Headers.Set("Location", 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 OnShapeReturnEndpointContext(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/OnShape/OnShapeAuthenticationMiddleware.cs b/Owin.Security.Providers/OnShape/OnShapeAuthenticationMiddleware.cs new file mode 100644 index 0000000..ca2f053 --- /dev/null +++ b/Owin.Security.Providers/OnShape/OnShapeAuthenticationMiddleware.cs @@ -0,0 +1,82 @@ +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; + +namespace Owin.Security.Providers.OnShape +{ + public class OnShapeAuthenticationMiddleware : AuthenticationMiddleware + { + private readonly HttpClient httpClient; + private readonly ILogger logger; + + public OnShapeAuthenticationMiddleware(OwinMiddleware next, IAppBuilder app, + OnShapeAuthenticationOptions options) + : base(next, options) + { + if (String.IsNullOrWhiteSpace(Options.AppKey)) + throw new ArgumentException("AppKey must be provided"); + if (String.IsNullOrWhiteSpace(Options.AppSecret)) + throw new ArgumentException("AppSecret must be provided"); + + logger = app.CreateLogger(); + + if (Options.Provider == null) + Options.Provider = new OnShapeAuthenticationProvider(); + + if (Options.StateDataFormat == null) + { + IDataProtector dataProtector = app.CreateDataProtector( + typeof (OnShapeAuthenticationMiddleware).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 OnShapeAuthenticationHandler(httpClient, logger); + } + + private HttpMessageHandler ResolveHttpMessageHandler(OnShapeAuthenticationOptions 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("Validator Handler Mismatch"); + } + webRequestHandler.ServerCertificateValidationCallback = options.BackchannelCertificateValidator.Validate; + } + + return handler; + } + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/OnShape/OnShapeAuthenticationOptions.cs b/Owin.Security.Providers/OnShape/OnShapeAuthenticationOptions.cs new file mode 100644 index 0000000..c67b3d7 --- /dev/null +++ b/Owin.Security.Providers/OnShape/OnShapeAuthenticationOptions.cs @@ -0,0 +1,92 @@ +using System; +using System.Net.Http; +using Microsoft.Owin; +using Microsoft.Owin.Security; + +namespace Owin.Security.Providers.OnShape +{ + public class OnShapeAuthenticationOptions : AuthenticationOptions + { + /// + /// Gets or sets the a pinned certificate validator to use to validate the endpoints used + /// in back channel communications belong to OnShape + /// + /// + /// 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 OnShape. + /// 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 OnShape. + /// + /// + /// 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-OnShape". + /// + 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 OnShape supplied Application Key + /// + public string AppKey { get; set; } + + /// + /// Gets or sets the OnShape supplied Application Secret + /// + public string AppSecret { get; set; } + + /// + /// Gets or sets the used in the authentication events + /// + public IOnShapeAuthenticationProvider Provider { get; 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 OnShapeAuthenticationOptions() + : base("OnShape") + { + Caption = Constants.DefaultAuthenticationType; + CallbackPath = new PathString("/oauthRedirect"); + AuthenticationMode = AuthenticationMode.Passive; + BackchannelTimeout = TimeSpan.FromSeconds(60); + } + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/OnShape/Provider/IOnShapeAuthenticationProvider.cs b/Owin.Security.Providers/OnShape/Provider/IOnShapeAuthenticationProvider.cs new file mode 100644 index 0000000..a919286 --- /dev/null +++ b/Owin.Security.Providers/OnShape/Provider/IOnShapeAuthenticationProvider.cs @@ -0,0 +1,24 @@ +using System.Threading.Tasks; + +namespace Owin.Security.Providers.OnShape +{ + /// + /// Specifies callback methods which the invokes to enable developer control over the authentication process. /> + /// + public interface IOnShapeAuthenticationProvider + { + /// + /// Invoked whenever OnShape successfully authenticates a user + /// + /// Contains information about the login session as well as the user . + /// A representing the completed operation. + Task Authenticated(OnShapeAuthenticatedContext 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(OnShapeReturnEndpointContext context); + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/OnShape/Provider/OnShapeAuthenticatedContext.cs b/Owin.Security.Providers/OnShape/Provider/OnShapeAuthenticatedContext.cs new file mode 100644 index 0000000..746a584 --- /dev/null +++ b/Owin.Security.Providers/OnShape/Provider/OnShapeAuthenticatedContext.cs @@ -0,0 +1,73 @@ +// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved. See License.txt in the project root for license information. + +using System; +using System.Globalization; +using System.Security.Claims; +using Microsoft.Owin; +using Microsoft.Owin.Security; +using Microsoft.Owin.Security.Provider; +using Newtonsoft.Json.Linq; + +namespace Owin.Security.Providers.OnShape +{ + /// + /// Contains information about the login session as well as the user . + /// + public class OnShapeAuthenticatedContext : BaseContext + { + /// + /// Initializes a + /// + /// The OWIN environment + /// The JSON-serialized user + /// OnShape Access token + public OnShapeAuthenticatedContext(IOwinContext context, JObject user, string accessToken) + : base(context) + { + AccessToken = accessToken; + User = user; + + Id = TryGetValue(user, "id"); + Name = TryGetValue(user, "name"); + } + + /// + /// Gets the JSON-serialized user + /// + /// + /// Contains the OnShape user obtained from the endpoint https://api.OnShape.com/1/account/info + /// + public JObject User { get; private set; } + + /// + /// Gets the OnShape OAuth access token + /// + public string AccessToken { get; private set; } + + /// + /// Gets the OnShape user ID + /// + public string Id { get; private set; } + + /// + /// The name of the user + /// + public string Name { 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; + } + } +} diff --git a/Owin.Security.Providers/OnShape/Provider/OnShapeAuthenticationProvider.cs b/Owin.Security.Providers/OnShape/Provider/OnShapeAuthenticationProvider.cs new file mode 100644 index 0000000..c313e6e --- /dev/null +++ b/Owin.Security.Providers/OnShape/Provider/OnShapeAuthenticationProvider.cs @@ -0,0 +1,50 @@ +using System; +using System.Threading.Tasks; + +namespace Owin.Security.Providers.OnShape +{ + /// + /// Default implementation. + /// + public class OnShapeAuthenticationProvider : IOnShapeAuthenticationProvider + { + /// + /// Initializes a + /// + public OnShapeAuthenticationProvider() + { + 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 OnShape successfully authenticates a user + /// + /// Contains information about the login session as well as the user . + /// A representing the completed operation. + public virtual Task Authenticated(OnShapeAuthenticatedContext 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(OnShapeReturnEndpointContext context) + { + return OnReturnEndpoint(context); + } + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/OnShape/Provider/OnShapeReturnEndpointContext.cs b/Owin.Security.Providers/OnShape/Provider/OnShapeReturnEndpointContext.cs new file mode 100644 index 0000000..3829cfa --- /dev/null +++ b/Owin.Security.Providers/OnShape/Provider/OnShapeReturnEndpointContext.cs @@ -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.OnShape +{ + /// + /// Provides context information to middleware providers. + /// + public class OnShapeReturnEndpointContext : ReturnEndpointContext + { + /// + /// + /// + /// OWIN environment + /// The authentication ticket + public OnShapeReturnEndpointContext( + IOwinContext context, + AuthenticationTicket ticket) + : base(context, ticket) + { + } + } +} diff --git a/Owin.Security.Providers/Owin.Security.Providers.csproj b/Owin.Security.Providers/Owin.Security.Providers.csproj index 18aa908..5b7122b 100644 --- a/Owin.Security.Providers/Owin.Security.Providers.csproj +++ b/Owin.Security.Providers/Owin.Security.Providers.csproj @@ -223,6 +223,15 @@ + + + + + + + + + diff --git a/OwinOAuthProvidersDemo/App_Start/Startup.Auth.cs b/OwinOAuthProvidersDemo/App_Start/Startup.Auth.cs index dbdf065..94b70aa 100755 --- a/OwinOAuthProvidersDemo/App_Start/Startup.Auth.cs +++ b/OwinOAuthProvidersDemo/App_Start/Startup.Auth.cs @@ -40,6 +40,7 @@ using Owin.Security.Providers.Yahoo; using Owin.Security.Providers.Backlog; using Owin.Security.Providers.Vimeo; using Owin.Security.Providers.Fitbit; +using Owin.Security.Providers.OnShape; namespace OwinOAuthProvidersDemo { @@ -294,6 +295,10 @@ namespace OwinOAuthProvidersDemo // ClientId = "", // ClientSecret = "" //}); + + //app.UseOnShapeAuthentication( + // appKey: "", + // appSecret: ""); } } }