Add unit tests for WeakReferenceHelpers

Doc comment cleanup on IOptimizedAuthenticatedEncryptor

DataProtection.sln

@@ -21,6 +21,8 @@ Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "Microsoft.AspNet.Cryptograp
 EndProject
 Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "Microsoft.AspNet.Cryptography.KeyDerivation.Test", "test\Microsoft.AspNet.Cryptography.KeyDerivation.Test\Microsoft.AspNet.Cryptography.KeyDerivation.Test.kproj", "{42C97F52-8D56-46BD-A712-4F22BED157A7}"
 EndProject
+Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "Microsoft.AspNet.Cryptography.Internal.Test", "test\Microsoft.AspNet.Cryptography.Internal.Test\Microsoft.AspNet.Cryptography.Internal.Test.kproj", "{37053D5F-5B61-47CE-8B72-298CE007FFB0}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -77,6 +79,14 @@ Global
 		{42C97F52-8D56-46BD-A712-4F22BED157A7}.Release|Any CPU.Build.0 = Release|Any CPU
 		{42C97F52-8D56-46BD-A712-4F22BED157A7}.Release|x86.ActiveCfg = Release|Any CPU
 		{42C97F52-8D56-46BD-A712-4F22BED157A7}.Release|x86.Build.0 = Release|Any CPU
+		{37053D5F-5B61-47CE-8B72-298CE007FFB0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{37053D5F-5B61-47CE-8B72-298CE007FFB0}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{37053D5F-5B61-47CE-8B72-298CE007FFB0}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{37053D5F-5B61-47CE-8B72-298CE007FFB0}.Debug|x86.Build.0 = Debug|Any CPU
+		{37053D5F-5B61-47CE-8B72-298CE007FFB0}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{37053D5F-5B61-47CE-8B72-298CE007FFB0}.Release|Any CPU.Build.0 = Release|Any CPU
+		{37053D5F-5B61-47CE-8B72-298CE007FFB0}.Release|x86.ActiveCfg = Release|Any CPU
+		{37053D5F-5B61-47CE-8B72-298CE007FFB0}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -89,5 +99,6 @@ Global
 		{E2779976-A28C-4365-A4BB-4AD854FAF23E} = {5FCB2DA3-5395-47F5-BCEE-E0EA319448EA}
 		{421F0383-34B1-402D-807B-A94542513ABA} = {5FCB2DA3-5395-47F5-BCEE-E0EA319448EA}
 		{42C97F52-8D56-46BD-A712-4F22BED157A7} = {60336AB3-948D-4D15-A5FB-F32A2B91E814}
+		{37053D5F-5B61-47CE-8B72-298CE007FFB0} = {60336AB3-948D-4D15-A5FB-F32A2B91E814}
 	EndGlobalSection
 EndGlobal

src/Microsoft.AspNet.Cryptography.Internal/Properties/AssemblyInfo.cs

@@ -8,6 +8,7 @@ using System.Runtime.InteropServices;
 // we only ever p/invoke into DLLs known to be in the System32 folder
 [assembly: DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
 
+[assembly: InternalsVisibleTo("Microsoft.AspNet.Cryptography.Internal.Test")]
 [assembly: InternalsVisibleTo("Microsoft.AspNet.Cryptography.KeyDerivation")]
 [assembly: InternalsVisibleTo("Microsoft.AspNet.Cryptography.KeyDerivation.Test")]
 [assembly: InternalsVisibleTo("Microsoft.AspNet.Security.DataProtection")]

src/Microsoft.AspNet.Security.DataProtection/AuthenticatedEncryption/IOptimizedAuthenticatedEncryptor.cs

@@ -18,18 +18,25 @@ namespace Microsoft.AspNet.Security.DataProtection.AuthenticatedEncryption
         /// the returned ciphertext but which will still be covered by the authentication tag.
         /// This input may be zero bytes in length. The same AAD must be specified in the corresponding
         /// call to Decrypt.</param>
-        /// <param name="preBufferSize">The number of bytes to include before the ciphertext in the return value.</param>
+        /// <param name="preBufferSize">The number of bytes to pad before the ciphertext in the output.</param>
-        /// <param name="postBufferSize">The number of bytes to include after the ciphertext in the return value.</param>
+        /// <param name="postBufferSize">The number of bytes to pad after the ciphertext in the output.</param>
         /// <returns>
-        /// A buffer containing the ciphertext and authentication tag.
+        /// The ciphertext blob, including authentication tag. The ciphertext blob will be surrounded by
-        /// If a non-zero pre-buffer or post-buffer size is specified, the returned buffer will contain appropriate padding
+        /// the number of padding bytes requested. For instance, if the given (plaintext, AAD) input results
-        /// on either side of the ciphertext and authentication tag. For instance, if a pre-buffer size of 4 and a post-buffer
+        /// in a (ciphertext, auth tag) output of 0x0102030405, and if 'preBufferSize' is 3 and
-        /// size of 7 are specified, and if the ciphertext and tag are a combined 48 bytes, then the returned buffer will
+        /// 'postBufferSize' is 5, then the return value will be 0xYYYYYY0102030405ZZZZZZZZZZ, where bytes
-        /// be a total 59 bytes in length. The first four bytes will be undefined, the next 48 bytes will contain the
+        /// YY and ZZ are undefined.
-        /// ciphertext and tag, and the last seven bytes will be undefined. The intent is that the caller can overwrite the
-        /// pre-buffer or post-buffer with a header or footer without needing to allocate an additional buffer object.
         /// </returns>
-        /// <remarks>All cryptography-related exceptions should be homogenized to CryptographicException.</remarks>
+        /// <remarks>
+        /// This method allows for a slight performance improvement over IAuthenticatedEncryptor.Encrypt
+        /// in the case where the caller needs to prepend or append some data to the resulting ciphertext.
+        /// For instance, if the caller needs to append a 32-bit header to the resulting ciphertext, then
+        /// he can specify 4 for 'preBufferSize' and overwrite the first 32 bits of the buffer returned
+        /// by this function. This saves the caller from having to allocate a new buffer to hold the final
+        /// transformed result.
+        /// 
+        /// All cryptography-related exceptions should be homogenized to CryptographicException.
+        /// </remarks>
         byte[] Encrypt(ArraySegment<byte> plaintext, ArraySegment<byte> additionalAuthenticatedData, uint preBufferSize, uint postBufferSize);
     }
 }

test/Microsoft.AspNet.Cryptography.Internal.Test/Microsoft.AspNet.Cryptography.Internal.Test.kproj

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="14.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <VisualStudioVersion Condition="'$(VisualStudioVersion)' == ''">14.0</VisualStudioVersion>
+    <VSToolsPath Condition="'$(VSToolsPath)' == ''">$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)</VSToolsPath>
+  </PropertyGroup>
+  <Import Project="$(VSToolsPath)\AspNet\Microsoft.Web.AspNet.Props" Condition="'$(VSToolsPath)' != ''" />
+  <PropertyGroup Label="Globals">
+    <ProjectGuid>37053d5f-5b61-47ce-8b72-298ce007ffb0</ProjectGuid>
+    <BaseIntermediateOutputPath Condition="'$(BaseIntermediateOutputPath)'=='' ">..\..\artifacts\obj\$(MSBuildProjectName)</BaseIntermediateOutputPath>
+    <OutputPath Condition="'$(OutputPath)'=='' ">..\..\artifacts\bin\$(MSBuildProjectName)\</OutputPath>
+  </PropertyGroup>
+  <PropertyGroup>
+    <SchemaVersion>2.0</SchemaVersion>
+  </PropertyGroup>
+  <Import Project="$(VSToolsPath)\AspNet\Microsoft.Web.AspNet.targets" Condition="'$(VSToolsPath)' != ''" />
+</Project>

test/Microsoft.AspNet.Cryptography.Internal.Test/Properties/AssemblyInfo.cs

@@ -0,0 +1,8 @@
+// Copyright (c) Microsoft Open Technologies, Inc. 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.Runtime.CompilerServices;
+
+// for unit testing
+[assembly: InternalsVisibleTo("DynamicProxyGenAssembly2")]

test/Microsoft.AspNet.Cryptography.Internal.Test/WeakReferenceHelpersTests.cs

@@ -0,0 +1,87 @@
+// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using Xunit;
+
+namespace Microsoft.AspNet.Cryptography
+{
+    public class WeakReferenceHelpersTests
+    {
+        [Fact]
+        public void GetSharedInstance_ExistingWeakRefHasBeenGCed_CreatesNew()
+        {
+            // Arrange
+            WeakReference<MyDisposable> wrOriginal = new WeakReference<MyDisposable>(null);
+            WeakReference<MyDisposable> wr = wrOriginal;
+            MyDisposable newInstance = new MyDisposable();
+
+            // Act
+            var retVal = WeakReferenceHelpers.GetSharedInstance(ref wr, () => newInstance);
+
+            // Assert
+            MyDisposable target;
+            Assert.NotNull(wr);
+            Assert.NotSame(wrOriginal, wr);
+            Assert.True(wr.TryGetTarget(out target));
+            Assert.Same(newInstance, target);
+            Assert.Same(newInstance, retVal);
+            Assert.False(newInstance.HasBeenDisposed);
+        }
+
+        [Fact]
+        public void GetSharedInstance_ExistingWeakRefIsNull_CreatesNew()
+        {
+            // Arrange
+            WeakReference<MyDisposable> wr = null;
+            MyDisposable newInstance = new MyDisposable();
+
+            // Act
+            var retVal = WeakReferenceHelpers.GetSharedInstance(ref wr, () => newInstance);
+
+            // Assert
+            MyDisposable target;
+            Assert.NotNull(wr);
+            Assert.True(wr.TryGetTarget(out target));
+            Assert.Same(newInstance, target);
+            Assert.Same(newInstance, retVal);
+            Assert.False(newInstance.HasBeenDisposed);
+        }
+
+        [Fact]
+        public void GetSharedInstance_ExistingWeakRefIsNull_AnotherThreadCreatesInstanceWhileOurFactoryRuns_ReturnsExistingInstanceAndDisposesNewInstance()
+        {
+            // Arrange
+            WeakReference<MyDisposable> wr = null;
+            MyDisposable instanceThatWillBeCreatedFirst = new MyDisposable();
+            MyDisposable instanceThatWillBeCreatedSecond = new MyDisposable();
+
+            // Act
+            var retVal = WeakReferenceHelpers.GetSharedInstance(ref wr, () =>
+            {
+                // mimic another thread creating the instance while our factory is being invoked
+                WeakReferenceHelpers.GetSharedInstance(ref wr, () => instanceThatWillBeCreatedFirst);
+                return instanceThatWillBeCreatedSecond;
+            });
+
+            // Assert
+            MyDisposable target;
+            Assert.NotNull(wr);
+            Assert.True(wr.TryGetTarget(out target));
+            Assert.Same(instanceThatWillBeCreatedFirst, target);
+            Assert.Same(instanceThatWillBeCreatedFirst, retVal);
+            Assert.False(instanceThatWillBeCreatedFirst.HasBeenDisposed);
+            Assert.True(instanceThatWillBeCreatedSecond.HasBeenDisposed);
+        }
+
+        private sealed class MyDisposable : IDisposable
+        {
+            public bool HasBeenDisposed { get; private set; }
+
+            public void Dispose()
+            {
+                HasBeenDisposed = true;
+            }
+        }
+    }
+}

test/Microsoft.AspNet.Cryptography.Internal.Test/project.json

@@ -0,0 +1,13 @@
+{
+    "dependencies": {
+        "Microsoft.AspNet.Cryptography.Internal": "1.0.0-*",
+        "Microsoft.AspNet.Testing": "1.0.0-*",
+        "xunit.runner.kre": "1.0.0-*"
+    },
+    "frameworks": {
+        "aspnet50": { }
+    },
+    "commands": {
+        "test": "xunit.runner.kre"
+    }
+}