Make ILoggerFactory an optional service on any DI-injected services

aspnet · Jun 13, 2017 · a39bcaf · a39bcaf
1 parent abf05e2
commit a39bcaf
Show file tree

Hide file tree

Showing 34 changed files with 238 additions and 237 deletions.
diff --git a/samples/AzureBlob/AzureBlob.csproj b/samples/AzureBlob/AzureBlob.csproj
@@ -1,9 +1,10 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <Import Project="..\..\build\dependencies.props" />
 
   <PropertyGroup>
     <TargetFramework>netcoreapp2.0</TargetFramework>
+    <OutputType>exe</OutputType>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/samples/AzureBlob/Program.cs b/samples/AzureBlob/Program.cs
@@ -6,6 +6,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Microsoft.WindowsAzure.Storage;
+using LogLevel = Microsoft.Extensions.Logging.LogLevel;
 
 namespace AzureBlob
 {
@@ -24,21 +25,19 @@ public static void Main(string[] args)
             container.CreateIfNotExistsAsync().GetAwaiter().GetResult();
 
             // Configure
-
-            var serviceCollection = new ServiceCollection();
-            serviceCollection.AddLogging();
-            serviceCollection.AddDataProtection()
-                .PersistKeysToAzureBlobStorage(container, "keys.xml");
-
-            var services = serviceCollection.BuildServiceProvider();
-            var loggerFactory = services.GetService<LoggerFactory>();
-            loggerFactory.AddConsole();
-
-            // Run a sample payload
-
-            var protector = services.GetDataProtector("sample-purpose");
-            var protectedData = protector.Protect("Hello world!");
-            Console.WriteLine(protectedData);
+            using (var services = new ServiceCollection()
+                .AddLogging(o => o.AddConsole().SetMinimumLevel(LogLevel.Debug))
+                .AddDataProtection()
+                .PersistKeysToAzureBlobStorage(container, "keys.xml")
+                .Services
+                .BuildServiceProvider())
+            {
+                // Run a sample payload
+
+                var protector = services.GetDataProtector("sample-purpose");
+                var protectedData = protector.Protect("Hello world!");
+                Console.WriteLine(protectedData);
+            }
         }
     }
 }
diff --git a/samples/AzureBlob/Properties/launchSettings.json b/samples/AzureBlob/Properties/launchSettings.json
diff --git a/samples/CustomEncryptorSample/CustomEncryptorSample.csproj b/samples/CustomEncryptorSample/CustomEncryptorSample.csproj
@@ -1,9 +1,10 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <Import Project="..\..\build\dependencies.props" />
 
   <PropertyGroup>
     <TargetFrameworks>net461;netcoreapp2.0</TargetFrameworks>
+    <OutputType>exe</OutputType>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/samples/CustomEncryptorSample/Program.cs b/samples/CustomEncryptorSample/Program.cs
@@ -14,25 +14,23 @@ public class Program
         public static void Main(string[] args)
         {
             var keysFolder = Path.Combine(Directory.GetCurrentDirectory(), "temp-keys");
-            var serviceCollection = new ServiceCollection();
-            serviceCollection.AddLogging();
-            serviceCollection.AddDataProtection()
+            using (var services = new ServiceCollection()
+                .AddLogging(o => o.AddConsole().SetMinimumLevel(LogLevel.Debug))
+                .AddDataProtection()
                 .PersistKeysToFileSystem(new DirectoryInfo(keysFolder))
-                .UseXmlEncryptor(s => new CustomXmlEncryptor(s));
+                .UseXmlEncryptor(s => new CustomXmlEncryptor(s))
+                .Services.BuildServiceProvider())
+            {
+                var protector = services.GetDataProtector("SamplePurpose");
 
-            var services = serviceCollection.BuildServiceProvider();
-            var loggerFactory = services.GetRequiredService<LoggerFactory>();
-            loggerFactory.AddConsole();
+                // protect the payload
+                var protectedPayload = protector.Protect("Hello World!");
+                Console.WriteLine($"Protect returned: {protectedPayload}");
 
-            var protector = services.GetDataProtector("SamplePurpose");
-
-            // protect the payload
-            var protectedPayload = protector.Protect("Hello World!");
-            Console.WriteLine($"Protect returned: {protectedPayload}");
-
-            // unprotect the payload
-            var unprotectedPayload = protector.Unprotect(protectedPayload);
-            Console.WriteLine($"Unprotect returned: {unprotectedPayload}");
+                // unprotect the payload
+                var unprotectedPayload = protector.Unprotect(protectedPayload);
+                Console.WriteLine($"Unprotect returned: {unprotectedPayload}");
+            }
         }
     }
 }
diff --git a/samples/CustomEncryptorSample/Properties/launchSettings.json b/samples/CustomEncryptorSample/Properties/launchSettings.json
diff --git a/samples/KeyManagementSample/KeyManagementSample.csproj b/samples/KeyManagementSample/KeyManagementSample.csproj
@@ -1,9 +1,10 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <Import Project="..\..\build\dependencies.props" />
 
   <PropertyGroup>
     <TargetFrameworks>net461;netcoreapp2.0</TargetFrameworks>
+    <OutputType>exe</OutputType>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/samples/KeyManagementSample/Program.cs b/samples/KeyManagementSample/Program.cs
@@ -16,48 +16,50 @@ public static void Main(string[] args)
         {
             var keysFolder = Path.Combine(Directory.GetCurrentDirectory(), "temp-keys");
             var serviceCollection = new ServiceCollection();
-            var builder = serviceCollection.AddDataProtection()
+            var builder = serviceCollection
+                .AddDataProtection()
                 // point at a specific folder and use DPAPI to encrypt keys
                 .PersistKeysToFileSystem(new DirectoryInfo(keysFolder));
             if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
             {
                 builder.ProtectKeysWithDpapi();
             }
 
-            var services = serviceCollection.BuildServiceProvider();
+            using (var services = serviceCollection.BuildServiceProvider())
+            {
+                // perform a protect operation to force the system to put at least
+                // one key in the key ring
+                services.GetDataProtector("Sample.KeyManager.v1").Protect("payload");
+                Console.WriteLine("Performed a protect operation.");
 
-            // perform a protect operation to force the system to put at least
-            // one key in the key ring
-            services.GetDataProtector("Sample.KeyManager.v1").Protect("payload");
-            Console.WriteLine("Performed a protect operation.");
+                // get a reference to the key manager
+                var keyManager = services.GetService<IKeyManager>();
 
-            // get a reference to the key manager
-            var keyManager = services.GetService<IKeyManager>();
+                // list all keys in the key ring
+                var allKeys = keyManager.GetAllKeys();
+                Console.WriteLine($"The key ring contains {allKeys.Count} key(s).");
+                foreach (var key in allKeys)
+                {
+                    Console.WriteLine($"Key {key.KeyId:B}: Created = {key.CreationDate:u}, IsRevoked = {key.IsRevoked}");
+                }
 
-            // list all keys in the key ring
-            var allKeys = keyManager.GetAllKeys();
-            Console.WriteLine($"The key ring contains {allKeys.Count} key(s).");
-            foreach (var key in allKeys)
-            {
-                Console.WriteLine($"Key {key.KeyId:B}: Created = {key.CreationDate:u}, IsRevoked = {key.IsRevoked}");
-            }
+                // revoke all keys in the key ring
+                keyManager.RevokeAllKeys(DateTimeOffset.Now, reason: "Revocation reason here.");
+                Console.WriteLine("Revoked all existing keys.");
 
-            // revoke all keys in the key ring
-            keyManager.RevokeAllKeys(DateTimeOffset.Now, reason: "Revocation reason here.");
-            Console.WriteLine("Revoked all existing keys.");
+                // add a new key to the key ring with immediate activation and a 1-month expiration
+                keyManager.CreateNewKey(
+                    activationDate: DateTimeOffset.Now,
+                    expirationDate: DateTimeOffset.Now.AddMonths(1));
+                Console.WriteLine("Added a new key.");
 
-            // add a new key to the key ring with immediate activation and a 1-month expiration
-            keyManager.CreateNewKey(
-                activationDate: DateTimeOffset.Now,
-                expirationDate: DateTimeOffset.Now.AddMonths(1));
-            Console.WriteLine("Added a new key.");
-
-            // list all keys in the key ring
-            allKeys = keyManager.GetAllKeys();
-            Console.WriteLine($"The key ring contains {allKeys.Count} key(s).");
-            foreach (var key in allKeys)
-            {
-                Console.WriteLine($"Key {key.KeyId:B}: Created = {key.CreationDate:u}, IsRevoked = {key.IsRevoked}");
+                // list all keys in the key ring
+                allKeys = keyManager.GetAllKeys();
+                Console.WriteLine($"The key ring contains {allKeys.Count} key(s).");
+                foreach (var key in allKeys)
+                {
+                    Console.WriteLine($"Key {key.KeyId:B}: Created = {key.CreationDate:u}, IsRevoked = {key.IsRevoked}");
+                }
             }
         }
     }

diff --git a/samples/KeyManagementSample/Properties/launchSettings.json b/samples/KeyManagementSample/Properties/launchSettings.json
diff --git a/samples/NonDISample/Program.cs b/samples/NonDISample/Program.cs
@@ -5,7 +5,6 @@
 using System.IO;
 using System.Runtime.InteropServices;
 using Microsoft.AspNetCore.DataProtection;
-using Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel;
 
 namespace NonDISample
 {

diff --git a/samples/Redis/Program.cs b/samples/Redis/Program.cs
@@ -17,19 +17,18 @@ public static void Main(string[] args)
             var redis = ConnectionMultiplexer.Connect("localhost:6379");
 
             // Configure
-            var serviceCollection = new ServiceCollection();
-            serviceCollection.AddLogging();
-            serviceCollection.AddDataProtection()
-                .PersistKeysToRedis(redis, "DataProtection-Keys");
-
-            var services = serviceCollection.BuildServiceProvider();
-            var loggerFactory = services.GetService<LoggerFactory>();
-            loggerFactory.AddConsole();
-
-            // Run a sample payload
-            var protector = services.GetDataProtector("sample-purpose");
-            var protectedData = protector.Protect("Hello world!");
-            Console.WriteLine(protectedData);
+            using (var services = new ServiceCollection()
+                .AddLogging(o => o.AddConsole().SetMinimumLevel(LogLevel.Debug))
+                .AddDataProtection()
+                .PersistKeysToRedis(redis, "DataProtection-Keys")
+                .Services
+                .BuildServiceProvider())
+            {
+                // Run a sample payload
+                var protector = services.GetDataProtector("sample-purpose");
+                var protectedData = protector.Protect("Hello world!");
+                Console.WriteLine(protectedData);
+            }
         }
     }
 }
diff --git a/samples/Redis/Properties/launchSettings.json b/samples/Redis/Properties/launchSettings.json
diff --git a/samples/Redis/Redis.csproj b/samples/Redis/Redis.csproj
@@ -1,9 +1,10 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <Import Project="..\..\build\dependencies.props" />
 
   <PropertyGroup>
     <TargetFrameworks>net461;netcoreapp2.0</TargetFrameworks>
+    <OutputType>exe</OutputType>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/...tection/AuthenticatedEncryption/ConfigurationModel/AuthenticatedEncryptorConfiguration.cs b/...tection/AuthenticatedEncryption/ConfigurationModel/AuthenticatedEncryptorConfiguration.cs
@@ -4,6 +4,7 @@
 using System;
 using System.Security.Cryptography;
 using Microsoft.AspNetCore.Cryptography;
+using Microsoft.Extensions.Logging.Abstractions;
 
 namespace Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel
 {
@@ -42,7 +43,7 @@ IAuthenticatedEncryptorDescriptor IInternalAlgorithmConfiguration.CreateDescript
 
         void IInternalAlgorithmConfiguration.Validate()
         {
-            var factory = new AuthenticatedEncryptorFactory(DataProtectionProviderFactory.GetDefaultLoggerFactory());
+            var factory = new AuthenticatedEncryptorFactory(NullLoggerFactory.Instance);
             // Run a sample payload through an encrypt -> decrypt operation to make sure data round-trips properly.
             var encryptor = factory.CreateAuthenticatedEncryptorInstance(Secret.Random(512 / 8), this);
             try

diff --git a/...n/AuthenticatedEncryption/ConfigurationModel/CngCbcAuthenticatedEncryptorConfiguration.cs b/...n/AuthenticatedEncryption/ConfigurationModel/CngCbcAuthenticatedEncryptorConfiguration.cs
@@ -2,6 +2,7 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using Microsoft.AspNetCore.Cryptography;
+using Microsoft.Extensions.Logging.Abstractions;
 
 namespace Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel
 {
@@ -88,7 +89,7 @@ IAuthenticatedEncryptorDescriptor IInternalAlgorithmConfiguration.CreateDescript
         /// </summary>
         void IInternalAlgorithmConfiguration.Validate()
         {
-            var factory = new CngCbcAuthenticatedEncryptorFactory(DataProtectionProviderFactory.GetDefaultLoggerFactory());
+            var factory = new CngCbcAuthenticatedEncryptorFactory(NullLoggerFactory.Instance);
             // Run a sample payload through an encrypt -> decrypt operation to make sure data round-trips properly.
             using (var encryptor = factory.CreateAuthenticatedEncryptorInstance(Secret.Random(512 / 8), this))
             {

diff --git a/...n/AuthenticatedEncryption/ConfigurationModel/CngGcmAuthenticatedEncryptorConfiguration.cs b/...n/AuthenticatedEncryption/ConfigurationModel/CngGcmAuthenticatedEncryptorConfiguration.cs
@@ -2,6 +2,7 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using Microsoft.AspNetCore.Cryptography;
+using Microsoft.Extensions.Logging.Abstractions;
 
 namespace Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel
 {
@@ -64,7 +65,7 @@ IAuthenticatedEncryptorDescriptor IInternalAlgorithmConfiguration.CreateDescript
         /// </summary>
         void IInternalAlgorithmConfiguration.Validate()
         {
-            var factory = new CngGcmAuthenticatedEncryptorFactory(DataProtectionProviderFactory.GetDefaultLoggerFactory());
+            var factory = new CngGcmAuthenticatedEncryptorFactory(NullLoggerFactory.Instance);
             // Run a sample payload through an encrypt -> decrypt operation to make sure data round-trips properly.
             using (var encryptor = factory.CreateAuthenticatedEncryptorInstance(Secret.Random(512 / 8), this))
             {