// Copyright (c) .NET Foundation. All rights reserved. // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. using System; using System.Collections.Generic; using System.Threading; using System.Threading.Tasks; using Microsoft.AspNet.Http; using Microsoft.Framework.DependencyInjection; using Moq; using Xunit; namespace Microsoft.AspNet.Mvc.Core.Test { public class AntiForgeryTokenStoreTest { private readonly string _cookieName = "cookie-name"; [Fact] public void GetCookieToken_CookieDoesNotExist_ReturnsNull() { // Arrange var requestCookies = new Mock(); requestCookies .Setup(o => o.Get(It.IsAny())) .Returns(string.Empty); var mockHttpContext = new Mock(); mockHttpContext .Setup(o => o.Request.Cookies) .Returns(requestCookies.Object); var contextAccessor = new ScopedInstance(); mockHttpContext.SetupGet(o => o.RequestServices) .Returns(GetServiceProvider(contextAccessor)); var config = new AntiForgeryOptions() { CookieName = _cookieName }; var tokenStore = new AntiForgeryTokenStore( config: config, serializer: null); // Act var token = tokenStore.GetCookieToken(mockHttpContext.Object); // Assert Assert.Null(token); } [Fact] public void GetCookieToken_CookieIsMissingInRequest_LooksUpCookieInAntiForgeryContext() { // Arrange var requestCookies = new Mock(); requestCookies .Setup(o => o.Get(It.IsAny())) .Returns(string.Empty); var mockHttpContext = new Mock(); mockHttpContext .Setup(o => o.Request.Cookies) .Returns(requestCookies.Object); var contextAccessor = new ScopedInstance(); mockHttpContext.SetupGet(o => o.RequestServices) .Returns(GetServiceProvider(contextAccessor)); // add a cookie explicitly. var cookie = new AntiForgeryToken(); contextAccessor.Value = new AntiForgeryContext() { CookieToken = cookie }; var config = new AntiForgeryOptions() { CookieName = _cookieName }; var tokenStore = new AntiForgeryTokenStore( config: config, serializer: null); // Act var token = tokenStore.GetCookieToken(mockHttpContext.Object); // Assert Assert.Equal(cookie, token); } [Fact] public void GetCookieToken_CookieIsEmpty_ReturnsNull() { // Arrange var mockHttpContext = GetMockHttpContext(_cookieName, string.Empty); var config = new AntiForgeryOptions() { CookieName = _cookieName }; var tokenStore = new AntiForgeryTokenStore( config: config, serializer: null); // Act var token = tokenStore.GetCookieToken(mockHttpContext); // Assert Assert.Null(token); } [Fact] public void GetCookieToken_CookieIsInvalid_PropagatesException() { // Arrange var mockHttpContext = GetMockHttpContext(_cookieName, "invalid-value"); var config = new AntiForgeryOptions() { CookieName = _cookieName }; var expectedException = new InvalidOperationException("some exception"); var mockSerializer = new Mock(); mockSerializer .Setup(o => o.Deserialize("invalid-value")) .Throws(expectedException); var tokenStore = new AntiForgeryTokenStore( config: config, serializer: mockSerializer.Object); // Act & assert var ex = Assert.Throws(() => tokenStore.GetCookieToken(mockHttpContext)); Assert.Same(expectedException, ex); } [Fact] public void GetCookieToken_CookieIsValid_ReturnsToken() { // Arrange var expectedToken = new AntiForgeryToken(); var mockHttpContext = GetMockHttpContext(_cookieName, "valid-value"); var config = new AntiForgeryOptions() { CookieName = _cookieName }; var mockSerializer = new Mock(); mockSerializer .Setup(o => o.Deserialize("valid-value")) .Returns(expectedToken); var tokenStore = new AntiForgeryTokenStore( config: config, serializer: mockSerializer.Object); // Act AntiForgeryToken retVal = tokenStore.GetCookieToken(mockHttpContext); // Assert Assert.Same(expectedToken, retVal); } [Fact] public async Task GetFormToken_FormFieldIsEmpty_ReturnsNull() { // Arrange var mockHttpContext = new Mock(); var requestContext = new Mock(); var formCollection = new Mock(); formCollection.Setup(f => f["form-field-name"]).Returns(string.Empty); requestContext.Setup(o => o.ReadFormAsync(CancellationToken.None)) .Returns(Task.FromResult(formCollection.Object)); mockHttpContext.Setup(o => o.Request) .Returns(requestContext.Object); var config = new AntiForgeryOptions() { FormFieldName = "form-field-name" }; var tokenStore = new AntiForgeryTokenStore( config: config, serializer: null); // Act var token = await tokenStore.GetFormTokenAsync(mockHttpContext.Object); // Assert Assert.Null(token); } [Fact] public async Task GetFormToken_FormFieldIsInvalid_PropagatesException() { // Arrange var formCollection = new Mock(); formCollection.Setup(f => f["form-field-name"]).Returns("invalid-value"); var requestContext = new Mock(); requestContext.Setup(o => o.ReadFormAsync(CancellationToken.None)) .Returns(Task.FromResult(formCollection.Object)); var mockHttpContext = new Mock(); mockHttpContext.Setup(o => o.Request) .Returns(requestContext.Object); var config = new AntiForgeryOptions() { FormFieldName = "form-field-name" }; var expectedException = new InvalidOperationException("some exception"); var mockSerializer = new Mock(); mockSerializer.Setup(o => o.Deserialize("invalid-value")) .Throws(expectedException); var tokenStore = new AntiForgeryTokenStore( config: config, serializer: mockSerializer.Object); // Act & assert var ex = await Assert.ThrowsAsync( async () => await tokenStore.GetFormTokenAsync(mockHttpContext.Object)); Assert.Same(expectedException, ex); } [Fact] public async Task GetFormToken_FormFieldIsValid_ReturnsToken() { // Arrange var expectedToken = new AntiForgeryToken(); // Arrange var mockHttpContext = new Mock(); var requestContext = new Mock(); var formCollection = new Mock(); formCollection.Setup(f => f["form-field-name"]).Returns("valid-value"); requestContext.Setup(o => o.ReadFormAsync(CancellationToken.None)) .Returns(Task.FromResult(formCollection.Object)); mockHttpContext.Setup(o => o.Request) .Returns(requestContext.Object); var config = new AntiForgeryOptions() { FormFieldName = "form-field-name" }; var mockSerializer = new Mock(); mockSerializer.Setup(o => o.Deserialize("valid-value")) .Returns(expectedToken); var tokenStore = new AntiForgeryTokenStore( config: config, serializer: mockSerializer.Object); // Act var retVal = await tokenStore.GetFormTokenAsync(mockHttpContext.Object); // Assert Assert.Same(expectedToken, retVal); } [Theory] [InlineData(true, true)] [InlineData(false, null)] public void SaveCookieToken(bool requireSsl, bool? expectedCookieSecureFlag) { // Arrange var token = new AntiForgeryToken(); var mockCookies = new Mock(); bool defaultCookieSecureValue = expectedCookieSecureFlag ?? false; // pulled from config; set by ctor var cookies = new MockResponseCookieCollection(); cookies.Count = 0; var mockHttpContext = new Mock(); mockHttpContext.Setup(o => o.Response.Cookies) .Returns(cookies); var contextAccessor = new ScopedInstance(); mockHttpContext.SetupGet(o => o.RequestServices) .Returns(GetServiceProvider(contextAccessor)); var mockSerializer = new Mock(); mockSerializer.Setup(o => o.Serialize(token)) .Returns("serialized-value"); var config = new AntiForgeryOptions() { CookieName = _cookieName, RequireSSL = requireSsl }; var tokenStore = new AntiForgeryTokenStore( config: config, serializer: mockSerializer.Object); // Act tokenStore.SaveCookieToken(mockHttpContext.Object, token); // Assert Assert.Equal(1, cookies.Count); Assert.NotNull(contextAccessor.Value.CookieToken); Assert.NotNull(cookies); Assert.Equal(_cookieName, cookies.Key); Assert.Equal("serialized-value", cookies.Value); Assert.True(cookies.Options.HttpOnly); Assert.Equal(defaultCookieSecureValue, cookies.Options.Secure); } private HttpContext GetMockHttpContext(string cookieName, string cookieValue) { var requestCookies = new MockCookieCollection(new Dictionary() { { cookieName, cookieValue } }); var request = new Mock(); request.Setup(o => o.Cookies) .Returns(requestCookies); var mockHttpContext = new Mock(); mockHttpContext.Setup(o => o.Request) .Returns(request.Object); var contextAccessor = new ScopedInstance(); mockHttpContext.SetupGet(o => o.RequestServices) .Returns(GetServiceProvider(contextAccessor)); return mockHttpContext.Object; } private static IServiceProvider GetServiceProvider(IScopedInstance contextAccessor) { var serviceCollection = new ServiceCollection(); serviceCollection.AddInstance>(contextAccessor); return serviceCollection.BuildServiceProvider(); } private class MockResponseCookieCollection : IResponseCookies { public string Key { get; set; } public string Value { get; set; } public CookieOptions Options { get; set; } public int Count { get; set; } public void Append(string key, string value, CookieOptions options) { this.Key = key; this.Value = value; this.Options = options; this.Count++; } public void Append(string key, string value) { throw new NotImplementedException(); } public void Delete(string key, CookieOptions options) { throw new NotImplementedException(); } public void Delete(string key) { throw new NotImplementedException(); } } private class MockCookieCollection : IReadableStringCollection { private Dictionary _dictionary; public int Count { get { return _dictionary.Count; } } public ICollection Keys { get { return _dictionary.Keys; } } public MockCookieCollection(Dictionary dictionary) { _dictionary = dictionary; } public static MockCookieCollection GetDummyInstance(string key, string value) { return new MockCookieCollection(new Dictionary() { { key, value } }); } public string Get(string key) { return this[key]; } public IList GetValues(string key) { throw new NotImplementedException(); } public bool ContainsKey(string key) { return _dictionary.ContainsKey(key); } public string this[string key] { get { return _dictionary[key]; } } public IEnumerator> GetEnumerator() { throw new NotImplementedException(); } System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() { throw new NotImplementedException(); } } } }