Added Yammer

This commit is contained in:
ravind
2014-11-22 18:30:24 -05:00
parent 987381d767
commit 27b5d0d133
10 changed files with 652 additions and 0 deletions

View File

@@ -219,6 +219,15 @@
<Compile Include="Yahoo\YahooAuthenticationHandler.cs" />
<Compile Include="Yahoo\YahooAuthenticationMiddleware.cs" />
<Compile Include="Yahoo\YahooAuthenticationOptions.cs" />
<Compile Include="Yammer\Constants.cs" />
<Compile Include="Yammer\Provider\IYammerAuthenticationProvider.cs" />
<Compile Include="Yammer\Provider\YammerAuthenticatedContext.cs" />
<Compile Include="Yammer\Provider\YammerAuthenticationProvider.cs" />
<Compile Include="Yammer\Provider\YammerReturnEndpointContext.cs" />
<Compile Include="Yammer\YammerAuthenticationHandler.cs" />
<Compile Include="Yammer\YammerAuthenticationExtensions.cs" />
<Compile Include="Yammer\YammerAuthenticationMiddleware.cs" />
<Compile Include="Yammer\YammerAuthenticationOptions.cs" />
</ItemGroup>
<ItemGroup>
<EmbeddedResource Include="Properties\Resources.resx">

View File

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

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

View File

@@ -0,0 +1,21 @@
using System.Threading.Tasks;
namespace Owin.Security.Providers.Yammer.Provider
{
public interface IYammerAuthenticationProvider
{
/// <summary>
/// Invoked whenever Yammer 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(YammerAuthenticatedContext 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(YammerReturnEndpointContext context);
}
}

View File

@@ -0,0 +1,87 @@
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.Yammer.Provider
{
/// <summary>
/// Contains information about the login session as well as the user <see cref="System.Security.Claims.ClaimsIdentity"/>.
/// </summary>
public class YammerAuthenticatedContext : BaseContext
{
/// <summary>
/// Initializes a <see cref="YammerAuthenticatedContext"/>
/// </summary>
/// <param name="context">The OWIN environment</param>
/// <param name="user">The JSON-serialized user</param>
/// <param name="accessToken">Yammer Access token</param>
public YammerAuthenticatedContext(IOwinContext context, dynamic user, string accessToken) : base(context)
{
User = user;
AccessToken = accessToken;
Id = user.id;
Name = user.full_name;
Url = user.url;
Network = user.network_name;
if (user.contact.email_addresses != null)
{
foreach (var eml in user.contact.email_addresses)
{
if (eml.type == "primary") PrimaryEmail = eml.address;
}
}
}
/// <summary>
/// Gets the JSON-serialized user
/// </summary>
/// <remarks>
/// Contains the Yammer user
/// </remarks>
public dynamic User { get; private set; }
/// <summary>
/// Gets the Yammer access token
/// </summary>
public string AccessToken { get; private set; }
/// <summary>
/// Gets the Yammer user ID
/// </summary>
public string Id { get; private set; }
/// <summary>
/// Gets the Yammer full_name
/// </summary>
public string Name { get; private set; }
/// <summary>
/// Gets the Yammer url
/// </summary>
public string Url { get; private set; }
/// <summary>
/// Gets the Yammer Primary Email
/// </summary>
public string PrimaryEmail { get; private set; }
/// <summary>
/// Gets the yammer network_name
/// </summary>
public string Network { 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.Yammer.Provider
{
/// <summary>
/// Default <see cref="IYammerAuthenticationProvider"/> implementation.
/// </summary>
public class YammerAuthenticationProvider : IYammerAuthenticationProvider
{
/// <summary>
/// Initializes a <see cref="YammerAuthenticationProvider"/>
/// </summary>
public YammerAuthenticationProvider()
{
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<YammerAuthenticatedContext, Task> OnAuthenticated { get; set; }
/// <summary>
/// Gets or sets the function that is invoked when the ReturnEndpoint method is invoked.
/// </summary>
public Func<YammerReturnEndpointContext, Task> OnReturnEndpoint { get; set; }
/// <summary>
/// Invoked whenever Yammer 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(YammerAuthenticatedContext 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(YammerReturnEndpointContext context)
{
return OnReturnEndpoint(context);
}
}
}

View File

@@ -0,0 +1,24 @@
using Microsoft.Owin;
using Microsoft.Owin.Security;
using Microsoft.Owin.Security.Provider;
namespace Owin.Security.Providers.Yammer.Provider
{
/// <summary>
/// Provides context information to middleware providers.
/// </summary>
public class YammerReturnEndpointContext : ReturnEndpointContext
{
/// <summary>
///
/// </summary>
/// <param name="context">OWIN environment</param>
/// <param name="ticket">The authentication ticket</param>
public YammerReturnEndpointContext(
IOwinContext context,
AuthenticationTicket ticket)
: base(context, ticket)
{
}
}
}

View File

@@ -0,0 +1,28 @@
using System;
namespace Owin.Security.Providers.Yammer
{
public static class YammerAuthenticationExtensions
{
public static IAppBuilder UseYammerAuthentication(this IAppBuilder app, YammerAuthenticationOptions options)
{
if (app == null)
throw new ArgumentNullException("app");
if (options == null)
throw new ArgumentNullException("options");
app.Use(typeof(YammerAuthenticationMiddleware), app, options);
return app;
}
public static IAppBuilder UseYammerAuthentication(this IAppBuilder app, string clientId, string clientSecret)
{
return app.UseYammerAuthentication(new YammerAuthenticationOptions
{
ClientId = clientId,
ClientSecret = clientSecret
});
}
}
}

View File

@@ -0,0 +1,250 @@
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.Yammer.Provider;
namespace Owin.Security.Providers.Yammer
{
public class YammerAuthenticationHandler : AuthenticationHandler<YammerAuthenticationOptions>
{
private const string XmlSchemaString = "http://www.w3.org/2001/XMLSchema#string";
private const string TokenEndpoint = "https://www.yammer.com/oauth2/access_token.json";
private const string UserAuthenticationEndpoint = "https://www.yammer.com/dialog/oauth";
private readonly ILogger logger;
private readonly HttpClient httpClient;
public YammerAuthenticationHandler(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;
}
if (code == null)
{
throw new Exception(query["error"] + " - " + query["error_description"]);
}
// 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;
string endPoint =
TokenEndpoint +
"?client_id=" + Uri.EscapeDataString(Options.ClientId) +
"&client_secret=" + Uri.EscapeDataString(Options.ClientSecret) +
"&code=" + Uri.EscapeDataString(code);
// Request the token
HttpResponseMessage tokenResponse = await httpClient.GetAsync(endPoint);
tokenResponse.EnsureSuccessStatusCode();
string text = await tokenResponse.Content.ReadAsStringAsync();
// Deserializes the token response
dynamic response = JsonConvert.DeserializeObject<dynamic>(text);
string accessToken = (string)response.access_token.token;
// Get the Yammer user
dynamic user = response.user;
var context = new YammerAuthenticatedContext(Context, user, accessToken);
context.Identity = new ClaimsIdentity(
Options.AuthenticationType,
ClaimsIdentity.DefaultNameClaimType,
ClaimsIdentity.DefaultRoleClaimType);
EnsureAcceptedNetwork(Options.AcceptedNetworks, context.Network);
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.PrimaryEmail))
{
context.Identity.AddClaim(new Claim(ClaimTypes.Email, context.PrimaryEmail, XmlSchemaString, Options.AuthenticationType));
}
if (!string.IsNullOrEmpty(context.Url))
{
context.Identity.AddClaim(new Claim(ClaimTypes.Uri, context.Url, XmlSchemaString, Options.AuthenticationType));
}
if (!string.IsNullOrEmpty(context.AccessToken))
{
context.Identity.AddClaim(new Claim("urn:Yammer: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<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 =
UserAuthenticationEndpoint +
"?client_id=" + Uri.EscapeDataString(Options.ClientId) +
"&redirect_uri=" + Uri.EscapeDataString(redirectUri) +
"&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 YammerReturnEndpointContext(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;
}
private void EnsureAcceptedNetwork(string[] validNetworks, string userNetwork)
{
if (validNetworks != null && validNetworks.Length > 0)
{
bool isValid = false;
foreach (string network in validNetworks)
{
if (userNetwork == network)
{
isValid = true;
break;
}
}
if (!isValid) throw new Exception("User is not in list of accepted networks");
}
}
}
}

View File

@@ -0,0 +1,71 @@
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.Yammer.Provider;
using System;
using System.Globalization;
using System.Net;
using System.Net.Http;
namespace Owin.Security.Providers.Yammer
{
public class YammerAuthenticationMiddleware : AuthenticationMiddleware<YammerAuthenticationOptions>
{
private readonly HttpClient httpClient;
private readonly ILogger logger;
public YammerAuthenticationMiddleware(OwinMiddleware next, IAppBuilder app, YammerAuthenticationOptions 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<YammerAuthenticationMiddleware>();
if (Options.Provider == null)
Options.Provider = new YammerAuthenticationProvider();
if (Options.StateDataFormat == null)
{
IDataProtector dataProtector = app.CreateDataProtector(
typeof(YammerAuthenticationMiddleware).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
};
}
/// <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.Yammer.YammerAuthenticationOptions" /> supplied to the constructor.
/// </returns>
protected override AuthenticationHandler<YammerAuthenticationOptions> CreateHandler()
{
return new YammerAuthenticationHandler(httpClient, logger);
}
private HttpClientHandler ResolveHttpMessageHandler()
{
return new HttpClientHandler
{
Credentials = new NetworkCredential(Options.ClientId, Options.ClientSecret)
};
}
}
}

View File

@@ -0,0 +1,104 @@
using Microsoft.Owin;
using Microsoft.Owin.Security;
using Owin.Security.Providers.Yammer.Provider;
using System;
using System.Collections.Generic;
using System.Net.Http;
namespace Owin.Security.Providers.Yammer
{
public class YammerAuthenticationOptions : AuthenticationOptions
{
/// <summary>
/// Gets or sets the a pinned certificate validator to use to validate the endpoints used
/// in back channel communications belong to Yammer.
/// </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 Yammer.
/// 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 Yammer.
/// </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-Yammer".
/// </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 Yammer supplied Client ID
/// </summary>
public string ClientId { get; set; }
/// <summary>
/// Gets or sets the Yammer supplied Client Secret
/// </summary>
public string ClientSecret { get; set; }
/// <summary>
/// Gets or sets the <see cref="IYammerAuthenticationProvider" /> used in the authentication events
/// </summary>
public IYammerAuthenticationProvider 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>
/// Will only allow logins from users belonging to one of these networks. Leave blank to allow all.
/// </summary>
public string[] AcceptedNetworks { get; set; }
/// <summary>
/// Initializes a new <see cref="YammerAuthenticationOptions" />
/// </summary>
public YammerAuthenticationOptions()
: base("Yammer")
{
Caption = Constants.DefaultAuthenticationType;
CallbackPath = new PathString("/signin-Yammer");
AuthenticationMode = AuthenticationMode.Passive;
BackchannelTimeout = TimeSpan.FromSeconds(60);
}
}
}