diff --git a/Owin.Security.Providers/Owin.Security.Providers.csproj b/Owin.Security.Providers/Owin.Security.Providers.csproj index f91a14e..655c7e5 100644 --- a/Owin.Security.Providers/Owin.Security.Providers.csproj +++ b/Owin.Security.Providers/Owin.Security.Providers.csproj @@ -90,6 +90,15 @@ True Resources.resx + + + + + + + + + diff --git a/Owin.Security.Providers/Reddit/Constants.cs b/Owin.Security.Providers/Reddit/Constants.cs new file mode 100644 index 0000000..296c178 --- /dev/null +++ b/Owin.Security.Providers/Reddit/Constants.cs @@ -0,0 +1,7 @@ +namespace Owin.Security.Providers.Reddit +{ + internal static class Constants + { + public const string DefaultAuthenticationType = "Reddit"; + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/Reddit/Provider/IRedditAuthenticationProvider.cs b/Owin.Security.Providers/Reddit/Provider/IRedditAuthenticationProvider.cs new file mode 100644 index 0000000..ae79a09 --- /dev/null +++ b/Owin.Security.Providers/Reddit/Provider/IRedditAuthenticationProvider.cs @@ -0,0 +1,24 @@ +using System.Threading.Tasks; + +namespace Owin.Security.Providers.Reddit.Provider +{ + /// + /// Specifies callback methods which the invokes to enable developer control over the authentication process. /> + /// + public interface IRedditAuthenticationProvider + { + /// + /// Invoked whenever Reddit succesfully authenticates a user + /// + /// Contains information about the login session as well as the user . + /// A representing the completed operation. + Task Authenticated(RedditAuthenticatedContext 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(RedditReturnEndpointContext context); + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/Reddit/Provider/RedditAuthenticatedContext.cs b/Owin.Security.Providers/Reddit/Provider/RedditAuthenticatedContext.cs new file mode 100644 index 0000000..2e0c564 --- /dev/null +++ b/Owin.Security.Providers/Reddit/Provider/RedditAuthenticatedContext.cs @@ -0,0 +1,107 @@ +// 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.Reddit.Provider +{ + /// + /// Contains information about the login session as well as the user . + /// + public class RedditAuthenticatedContext : BaseContext + { + /// + /// Initializes a + /// + /// The OWIN environment + /// The JSON-serialized user + /// Reddit Access token + /// Seconds until expiration + public RedditAuthenticatedContext(IOwinContext context, JObject user, string accessToken, string expires, string refreshToken) + : base(context) + { + User = user; + AccessToken = accessToken; + RefreshToken = refreshToken; + int expiresValue; + if (Int32.TryParse(expires, NumberStyles.Integer, CultureInfo.InvariantCulture, out expiresValue)) + { + ExpiresIn = TimeSpan.FromSeconds(expiresValue); + } + + /*{ + "has_mail": false, + "name": "************", + "created": 1313605620.0, + "created_utc": 1313602020.0, + "link_karma": 344, + "comment_karma": 1782, + "over_18": true, + "is_gold": false, + "is_mod": true, + "has_verified_email": true, + "id": "5omjg", + "has_mod_mail": false + }*/ + Id = TryGetValue(user, "id"); + UserName = TryGetValue(user, "name"); + OverEighteen = bool.Parse(TryGetValue(user, "over_18")); + + } + + public bool OverEighteen { get; set; } + + public string RefreshToken { get; set; } + + /// + /// Gets the JSON-serialized user + /// + /// + /// Contains the Reddit user + /// + public JObject User { get; private set; } + + /// + /// Gets the Reddit access token + /// + public string AccessToken { get; private set; } + + /// + /// Gets the Reddit access token expiration time + /// + public TimeSpan? ExpiresIn { get; set; } + + /// + /// Gets the Reddit user ID + /// + public string Id { get; private set; } + + public string Link { get; private set; } + + /// + /// Gets the Reddit username + /// + public string UserName { 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/Reddit/Provider/RedditAuthenticationProvider.cs b/Owin.Security.Providers/Reddit/Provider/RedditAuthenticationProvider.cs new file mode 100644 index 0000000..39f87c4 --- /dev/null +++ b/Owin.Security.Providers/Reddit/Provider/RedditAuthenticationProvider.cs @@ -0,0 +1,50 @@ +using System; +using System.Threading.Tasks; + +namespace Owin.Security.Providers.Reddit.Provider +{ + /// + /// Default implementation. + /// + public class RedditAuthenticationProvider : IRedditAuthenticationProvider + { + /// + /// Initializes a + /// + public RedditAuthenticationProvider() + { + 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 Reddit succesfully authenticates a user + /// + /// Contains information about the login session as well as the user . + /// A representing the completed operation. + public virtual Task Authenticated(RedditAuthenticatedContext 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(RedditReturnEndpointContext context) + { + return OnReturnEndpoint(context); + } + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/Reddit/Provider/RedditReturnEndpointContext.cs b/Owin.Security.Providers/Reddit/Provider/RedditReturnEndpointContext.cs new file mode 100644 index 0000000..7238db4 --- /dev/null +++ b/Owin.Security.Providers/Reddit/Provider/RedditReturnEndpointContext.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.Reddit.Provider +{ + /// + /// Provides context information to middleware providers. + /// + public class RedditReturnEndpointContext : ReturnEndpointContext + { + /// + /// + /// + /// OWIN environment + /// The authentication ticket + public RedditReturnEndpointContext( + IOwinContext context, + AuthenticationTicket ticket) + : base(context, ticket) + { + } + } +} diff --git a/Owin.Security.Providers/Reddit/RedditAuthenticationExtensions.cs b/Owin.Security.Providers/Reddit/RedditAuthenticationExtensions.cs new file mode 100644 index 0000000..70f2f8a --- /dev/null +++ b/Owin.Security.Providers/Reddit/RedditAuthenticationExtensions.cs @@ -0,0 +1,29 @@ +using System; + +namespace Owin.Security.Providers.Reddit +{ + public static class RedditAuthenticationExtensions + { + public static IAppBuilder UseRedditAuthentication(this IAppBuilder app, + RedditAuthenticationOptions options) + { + if (app == null) + throw new ArgumentNullException("app"); + if (options == null) + throw new ArgumentNullException("options"); + + app.Use(typeof(RedditAuthenticationMiddleware), app, options); + + return app; + } + + public static IAppBuilder UseRedditAuthentication(this IAppBuilder app, string clientId, string clientSecret) + { + return app.UseRedditAuthentication(new RedditAuthenticationOptions + { + ClientId = clientId, + ClientSecret = clientSecret + }); + } + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/Reddit/RedditAuthenticationHandler.cs b/Owin.Security.Providers/Reddit/RedditAuthenticationHandler.cs new file mode 100644 index 0000000..cbf5f0c --- /dev/null +++ b/Owin.Security.Providers/Reddit/RedditAuthenticationHandler.cs @@ -0,0 +1,247 @@ +using System; +using System.Collections.Generic; +using System.Net; +using System.Net.Http; +using System.Net.Http.Headers; +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.Infrastructure; +using Newtonsoft.Json; +using Newtonsoft.Json.Linq; +using Owin.Security.Providers.Reddit.Provider; + +namespace Owin.Security.Providers.Reddit +{ + public class RedditAuthenticationHandler : AuthenticationHandler + { + private const string XmlSchemaString = "http://www.w3.org/2001/XMLSchema#string"; + private const string TokenEndpoint = "https://ssl.reddit.com/api/v1/access_token"; + private const string UserInfoEndpoint = "https://oauth.reddit.com/api/v1/me"; + + private readonly ILogger logger; + private readonly HttpClient httpClient; + + public RedditAuthenticationHandler(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); + } + + 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("state", state)); + body.Add(new KeyValuePair("scope", string.Join(",", Options.Scope))); + var request = new HttpRequestMessage(HttpMethod.Post, TokenEndpoint); + request.Content = new FormUrlEncodedContent(body); + + // 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(text); + string accessToken = (string)response.access_token; + string expires = (string) response.expires_in; + string refreshToken = (string) response.refresh_token; + + // Get the Reddit user + HttpRequestMessage userRequest = new HttpRequestMessage(HttpMethod.Get, UserInfoEndpoint); + userRequest.Headers.Add("Authorization", "bearer " + Uri.EscapeDataString(accessToken) + ""); + HttpResponseMessage graphResponse = await httpClient.SendAsync(userRequest, Request.CallCancelled); + graphResponse.EnsureSuccessStatusCode(); + text = await graphResponse.Content.ReadAsStringAsync(); + JObject user = JObject.Parse(text); + + var context = new RedditAuthenticatedContext(Context, user, accessToken, expires, refreshToken); + context.Identity = new ClaimsIdentity( + Options.AuthenticationType, + ClaimsIdentity.DefaultNameClaimType, + ClaimsIdentity.DefaultRoleClaimType); + if (!string.IsNullOrEmpty(context.Id)) + { + context.Identity.AddClaim(new Claim(ClaimTypes.NameIdentifier, context.UserName, XmlSchemaString, Options.AuthenticationType)); + } + if (!string.IsNullOrEmpty(context.UserName)) + { + context.Identity.AddClaim(new Claim(ClaimsIdentity.DefaultNameClaimType, context.UserName, XmlSchemaString, Options.AuthenticationType)); + } + + // Not sure if this is correct, but used this as an example of accessing more reddit data + context.Identity.AddClaim(new Claim("OverEighteen", context.OverEighteen.ToString())); + + if (!string.IsNullOrEmpty(context.Link)) + { + context.Identity.AddClaim(new Claim("urn:reddit:url", context.Link, XmlSchemaString, Options.AuthenticationType)); + } + if (!string.IsNullOrEmpty(context.AccessToken)) + { + context.Identity.AddClaim(new Claim("urn:reddit:accesstoken", context.AccessToken, 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); + + // comma separated + string scope = string.Join(",", Options.Scope); + + string state = Options.StateDataFormat.Protect(properties); + + string authorizationEndpoint = + "https://ssl.reddit.com/api/v1/authorize" + + "?response_type=code" + + "&client_id=" + Uri.EscapeDataString(Options.ClientId) + + "&redirect_uri=" + Uri.EscapeDataString(redirectUri) + + "&scope=" + Uri.EscapeDataString(scope) + + "&state=" + Uri.EscapeDataString(state) + + "&duration=permanent"; + + 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 RedditReturnEndpointContext(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/Reddit/RedditAuthenticationMiddleware.cs b/Owin.Security.Providers/Reddit/RedditAuthenticationMiddleware.cs new file mode 100644 index 0000000..6fb9dd8 --- /dev/null +++ b/Owin.Security.Providers/Reddit/RedditAuthenticationMiddleware.cs @@ -0,0 +1,75 @@ +using System; +using System.Globalization; +using System.Net; +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.Reddit.Provider; + +namespace Owin.Security.Providers.Reddit +{ + public class RedditAuthenticationMiddleware : AuthenticationMiddleware + { + private readonly HttpClient httpClient; + private readonly ILogger logger; + + public RedditAuthenticationMiddleware(OwinMiddleware next, IAppBuilder app, + RedditAuthenticationOptions options) + : base(next, options) + { + if (String.IsNullOrWhiteSpace(Options.ClientId)) + throw new ArgumentException(String.Format(CultureInfo.CurrentCulture, + "Option must be provided {0}", "ClientId")); + if (String.IsNullOrWhiteSpace(Options.ClientSecret)) + throw new ArgumentException(String.Format(CultureInfo.CurrentCulture, + "Option must be provided {0}", "ClientSecret")); + + logger = app.CreateLogger(); + + if (Options.Provider == null) + Options.Provider = new RedditAuthenticationProvider(); + + if (Options.StateDataFormat == null) + { + IDataProtector dataProtector = app.CreateDataProtector( + typeof (RedditAuthenticationMiddleware).FullName, + Options.AuthenticationType, "v1"); + Options.StateDataFormat = new PropertiesDataFormat(dataProtector); + } + + if (String.IsNullOrEmpty(Options.SignInAsAuthenticationType)) + Options.SignInAsAuthenticationType = app.GetDefaultSignInAsAuthenticationType(); + + httpClient = new HttpClient(ResolveHttpMessageHandler()) + { + 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 RedditAuthenticationHandler(httpClient, logger); + } + + private HttpClientHandler ResolveHttpMessageHandler() + { + return new HttpClientHandler + { + Credentials = new NetworkCredential(Options.ClientId, Options.ClientSecret) + }; + } + } +} \ No newline at end of file diff --git a/Owin.Security.Providers/Reddit/RedditAuthenticationOptions.cs b/Owin.Security.Providers/Reddit/RedditAuthenticationOptions.cs new file mode 100644 index 0000000..262968f --- /dev/null +++ b/Owin.Security.Providers/Reddit/RedditAuthenticationOptions.cs @@ -0,0 +1,105 @@ +using System; +using System.Collections.Generic; +using System.Net.Http; +using Microsoft.Owin; +using Microsoft.Owin.Security; +using Owin.Security.Providers.Reddit.Provider; + +namespace Owin.Security.Providers.Reddit +{ + public class RedditAuthenticationOptions : AuthenticationOptions + { + /// + /// Gets or sets the a pinned certificate validator to use to validate the endpoints used + /// in back channel communications belong to Reddit. + /// + /// + /// 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 Reddit. + /// 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 Reddit. + /// + /// + /// 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-Reddit". + /// + 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 Reddit supplied Client ID + /// + public string ClientId { get; set; } + + /// + /// Gets or sets the Reddit supplied Client Secret + /// + public string ClientSecret { get; set; } + + /// + /// Gets or sets the used in the authentication events + /// + public IRedditAuthenticationProvider 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 RedditAuthenticationOptions() + : base("Reddit") + { + Caption = Constants.DefaultAuthenticationType; + CallbackPath = new PathString("/signin-reddit"); + AuthenticationMode = AuthenticationMode.Passive; + Scope = new List + { + "identity", + "mysubreddits", + "privatemessages" + }; + BackchannelTimeout = TimeSpan.FromSeconds(60); + } + } +} \ No newline at end of file