diff --git a/NuGetPackageVerifier.json b/NuGetPackageVerifier.json index ba44824cf4..f5a8168e06 100644 --- a/NuGetPackageVerifier.json +++ b/NuGetPackageVerifier.json @@ -1,12 +1,7 @@ { "adx": { // Packages written by the ADX team and that ship on NuGet.org "rules": [ - "AssemblyHasDocumentFileRule", - "AssemblyHasVersionAttributesRule", - "AssemblyHasServicingAttributeRule", - "AssemblyHasNeutralResourcesLanguageAttributeRule", - "SatellitePackageRule", - "StrictSemanticVersionValidationRule" + "AdxVerificationCompositeRule" ], "packages": { "Microsoft.AspNetCore.Cryptography.Internal": { }, @@ -25,12 +20,7 @@ }, "Default": { // Rules to run for packages not listed in any other set. "rules": [ - "AssemblyHasDocumentFileRule", - "AssemblyHasVersionAttributesRule", - "AssemblyHasServicingAttributeRule", - "AssemblyHasNeutralResourcesLanguageAttributeRule", - "SatellitePackageRule", - "StrictSemanticVersionValidationRule" + "DefaultCompositeRule" ] } } \ No newline at end of file diff --git a/src/Microsoft.AspNetCore.Cryptography.Internal/project.json b/src/Microsoft.AspNetCore.Cryptography.Internal/project.json index ea24ed56f6..8c53951240 100644 --- a/src/Microsoft.AspNetCore.Cryptography.Internal/project.json +++ b/src/Microsoft.AspNetCore.Cryptography.Internal/project.json @@ -21,6 +21,8 @@ "compilationOptions": { "allowUnsafe": true, "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true } } diff --git a/src/Microsoft.AspNetCore.Cryptography.KeyDerivation/project.json b/src/Microsoft.AspNetCore.Cryptography.KeyDerivation/project.json index e589a39619..0f1ff14744 100644 --- a/src/Microsoft.AspNetCore.Cryptography.KeyDerivation/project.json +++ b/src/Microsoft.AspNetCore.Cryptography.KeyDerivation/project.json @@ -21,6 +21,8 @@ "compilationOptions": { "allowUnsafe": true, "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true } } diff --git a/src/Microsoft.AspNetCore.DataProtection.Abstractions/DataProtectionExtensions.cs b/src/Microsoft.AspNetCore.DataProtection.Abstractions/DataProtectionExtensions.cs index 6946dbeaaa..9096a871d7 100644 --- a/src/Microsoft.AspNetCore.DataProtection.Abstractions/DataProtectionExtensions.cs +++ b/src/Microsoft.AspNetCore.DataProtection.Abstractions/DataProtectionExtensions.cs @@ -248,7 +248,7 @@ namespace Microsoft.AspNetCore.DataProtection /// The data protector to use for this operation. /// The protected data to unprotect. /// The plaintext form of the protected data. - /// + /// /// Thrown if is invalid or malformed. /// public static string Unprotect(this IDataProtector protector, string protectedData) diff --git a/src/Microsoft.AspNetCore.DataProtection.Abstractions/IDataProtectionProvider.cs b/src/Microsoft.AspNetCore.DataProtection.Abstractions/IDataProtectionProvider.cs index 603fad789f..02f772724b 100644 --- a/src/Microsoft.AspNetCore.DataProtection.Abstractions/IDataProtectionProvider.cs +++ b/src/Microsoft.AspNetCore.DataProtection.Abstractions/IDataProtectionProvider.cs @@ -11,7 +11,7 @@ namespace Microsoft.AspNetCore.DataProtection /// /// Creates an given a purpose. /// - /// + /// /// The purpose to be assigned to the newly-created . /// /// An IDataProtector tied to the provided purpose. diff --git a/src/Microsoft.AspNetCore.DataProtection.Abstractions/IDataProtector.cs b/src/Microsoft.AspNetCore.DataProtection.Abstractions/IDataProtector.cs index 2cea1c2732..1d9c8c3946 100644 --- a/src/Microsoft.AspNetCore.DataProtection.Abstractions/IDataProtector.cs +++ b/src/Microsoft.AspNetCore.DataProtection.Abstractions/IDataProtector.cs @@ -20,7 +20,7 @@ namespace Microsoft.AspNetCore.DataProtection /// /// The protected data to unprotect. /// The plaintext form of the protected data. - /// + /// /// Thrown if the protected data is invalid or malformed. /// byte[] Unprotect(byte[] protectedData); diff --git a/src/Microsoft.AspNetCore.DataProtection.Abstractions/project.json b/src/Microsoft.AspNetCore.DataProtection.Abstractions/project.json index 5d1109f732..36738186db 100644 --- a/src/Microsoft.AspNetCore.DataProtection.Abstractions/project.json +++ b/src/Microsoft.AspNetCore.DataProtection.Abstractions/project.json @@ -23,6 +23,8 @@ }, "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true } } \ No newline at end of file diff --git a/src/Microsoft.AspNetCore.DataProtection.Extensions/DataProtectionExtensions.cs b/src/Microsoft.AspNetCore.DataProtection.Extensions/DataProtectionExtensions.cs index 85ae629d69..0529a1c15a 100644 --- a/src/Microsoft.AspNetCore.DataProtection.Extensions/DataProtectionExtensions.cs +++ b/src/Microsoft.AspNetCore.DataProtection.Extensions/DataProtectionExtensions.cs @@ -101,7 +101,7 @@ namespace Microsoft.AspNetCore.DataProtection /// An 'out' parameter which upon a successful unprotect /// operation receives the expiration date of the payload. /// The plaintext form of the protected data. - /// + /// /// Thrown if is invalid, malformed, or expired. /// public static string Unprotect(this ITimeLimitedDataProtector protector, string protectedData, out DateTimeOffset expiration) diff --git a/src/Microsoft.AspNetCore.DataProtection.Extensions/ITimeLimitedDataProtector.cs b/src/Microsoft.AspNetCore.DataProtection.Extensions/ITimeLimitedDataProtector.cs index fe8904be6f..71fa609f21 100644 --- a/src/Microsoft.AspNetCore.DataProtection.Extensions/ITimeLimitedDataProtector.cs +++ b/src/Microsoft.AspNetCore.DataProtection.Extensions/ITimeLimitedDataProtector.cs @@ -19,7 +19,7 @@ namespace Microsoft.AspNetCore.DataProtection /// /// Creates an given a purpose. /// - /// + /// /// The purpose to be assigned to the newly-created . /// /// An tied to the provided purpose. @@ -47,7 +47,7 @@ namespace Microsoft.AspNetCore.DataProtection /// An 'out' parameter which upon a successful unprotect /// operation receives the expiration date of the payload. /// The plaintext form of the protected data. - /// + /// /// Thrown if is invalid, malformed, or expired. /// byte[] Unprotect(byte[] protectedData, out DateTimeOffset expiration); diff --git a/src/Microsoft.AspNetCore.DataProtection.Extensions/project.json b/src/Microsoft.AspNetCore.DataProtection.Extensions/project.json index f43d531b73..cbdf080737 100644 --- a/src/Microsoft.AspNetCore.DataProtection.Extensions/project.json +++ b/src/Microsoft.AspNetCore.DataProtection.Extensions/project.json @@ -19,6 +19,8 @@ }, "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true } } \ No newline at end of file diff --git a/src/Microsoft.AspNetCore.DataProtection.SystemWeb/project.json b/src/Microsoft.AspNetCore.DataProtection.SystemWeb/project.json index 39b2a10314..e2ecac0519 100644 --- a/src/Microsoft.AspNetCore.DataProtection.SystemWeb/project.json +++ b/src/Microsoft.AspNetCore.DataProtection.SystemWeb/project.json @@ -20,7 +20,9 @@ }, "compilationOptions": { "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "packInclude": { "content/net451/": "web.config.transform" diff --git a/src/Microsoft.AspNetCore.DataProtection/AuthenticatedEncryption/ConfigurationModel/ManagedAuthenticatedEncryptorConfiguration.cs b/src/Microsoft.AspNetCore.DataProtection/AuthenticatedEncryption/ConfigurationModel/ManagedAuthenticatedEncryptorConfiguration.cs index 94d53bb3f1..50130013f4 100644 --- a/src/Microsoft.AspNetCore.DataProtection/AuthenticatedEncryption/ConfigurationModel/ManagedAuthenticatedEncryptorConfiguration.cs +++ b/src/Microsoft.AspNetCore.DataProtection/AuthenticatedEncryption/ConfigurationModel/ManagedAuthenticatedEncryptorConfiguration.cs @@ -7,7 +7,8 @@ namespace Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.Configurat { /// /// Represents a configured authenticated encryption mechanism which uses - /// managed and types. + /// managed and + /// types. /// public sealed class ManagedAuthenticatedEncryptorConfiguration : IAuthenticatedEncryptorConfiguration, IInternalAuthenticatedEncryptorConfiguration { diff --git a/src/Microsoft.AspNetCore.DataProtection/DataProtectionConfiguration.cs b/src/Microsoft.AspNetCore.DataProtection/DataProtectionConfiguration.cs index 81541c22e4..c9f4e8df0a 100644 --- a/src/Microsoft.AspNetCore.DataProtection/DataProtectionConfiguration.cs +++ b/src/Microsoft.AspNetCore.DataProtection/DataProtectionConfiguration.cs @@ -17,6 +17,7 @@ using System.Security.Cryptography.X509Certificates; namespace Microsoft.AspNetCore.DataProtection { +#if !DOTNET5_4 /// /// Provides access to configuration for the data protection system, which allows the /// developer to configure default cryptographic algorithms, key storage locations, @@ -26,7 +27,7 @@ namespace Microsoft.AspNetCore.DataProtection /// /// If the developer changes the at-rest key protection mechanism, it is intended that /// he also change the key storage location, and vice versa. For instance, a call to - /// should generally be accompanied by + /// should generally be accompanied by /// a call to , or exceptions may /// occur at runtime due to the data protection system not knowing where to persist keys. /// @@ -43,6 +44,31 @@ namespace Microsoft.AspNetCore.DataProtection /// contain existing keys that use older algorithms or protection mechanisms. /// /// +#else + /// + /// Provides access to configuration for the data protection system, which allows the + /// developer to configure default cryptographic algorithms, key storage locations, + /// and the mechanism by which keys are protected at rest. + /// + /// + /// + /// If the developer changes the at-rest key protection mechanism, it is intended that + /// he also change the key storage location, and vice versa. + /// + /// + /// Similarly, when a developer modifies the default protected payload cryptographic + /// algorithms, it is intended that he also select an explitiy key storage location. + /// A call to + /// should therefore generally be paired with a call to , + /// for example. + /// + /// + /// When the default cryptographic algorithms or at-rest key protection mechanisms are + /// changed, they only affect new keys in the repository. The repository may + /// contain existing keys that use older algorithms or protection mechanisms. + /// + /// +#endif public class DataProtectionConfiguration { /// @@ -284,7 +310,7 @@ namespace Microsoft.AspNetCore.DataProtection /// /// See https://msdn.microsoft.com/en-us/library/windows/desktop/hh769091(v=vs.85).aspx /// and https://msdn.microsoft.com/en-us/library/windows/desktop/hh706800(v=vs.85).aspx - /// for more information on valid values for the the + /// for more information on valid values for the the /// and arguments. /// This API is only supported on Windows 8 / Windows Server 2012 and higher. /// diff --git a/src/Microsoft.AspNetCore.DataProtection/RegistryPolicyResolver.cs b/src/Microsoft.AspNetCore.DataProtection/RegistryPolicyResolver.cs index 5fd5188953..6169bd1fb4 100644 --- a/src/Microsoft.AspNetCore.DataProtection/RegistryPolicyResolver.cs +++ b/src/Microsoft.AspNetCore.DataProtection/RegistryPolicyResolver.cs @@ -81,7 +81,7 @@ namespace Microsoft.AspNetCore.DataProtection } /// - /// Returns a object from the default registry location. + /// Returns an array of s from the default registry location. /// public static ServiceDescriptor[] ResolveDefaultPolicy() { diff --git a/src/Microsoft.AspNetCore.DataProtection/Repositories/RegistryXmlRepository.cs b/src/Microsoft.AspNetCore.DataProtection/Repositories/RegistryXmlRepository.cs index 63263223e7..b0fbc3a347 100644 --- a/src/Microsoft.AspNetCore.DataProtection/Repositories/RegistryXmlRepository.cs +++ b/src/Microsoft.AspNetCore.DataProtection/Repositories/RegistryXmlRepository.cs @@ -39,6 +39,7 @@ namespace Microsoft.AspNetCore.DataProtection.Repositories /// Creates a with keys stored in the given registry key. /// /// The registry key in which to persist key material. + /// The used to resolve services. public RegistryXmlRepository(RegistryKey registryKey, IServiceProvider services) { if (registryKey == null) diff --git a/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/DpapiNGXmlDecryptor.cs b/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/DpapiNGXmlDecryptor.cs index af35d69bd8..cab86abdbf 100644 --- a/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/DpapiNGXmlDecryptor.cs +++ b/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/DpapiNGXmlDecryptor.cs @@ -43,7 +43,6 @@ namespace Microsoft.AspNetCore.DataProtection.XmlEncryption /// /// An encrypted XML element. /// The decrypted form of . - /// public XElement Decrypt(XElement encryptedElement) { if (encryptedElement == null) diff --git a/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/DpapiXmlDecryptor.cs b/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/DpapiXmlDecryptor.cs index 6b331f9626..28fc289dbb 100644 --- a/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/DpapiXmlDecryptor.cs +++ b/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/DpapiXmlDecryptor.cs @@ -40,7 +40,6 @@ namespace Microsoft.AspNetCore.DataProtection.XmlEncryption /// /// An encrypted XML element. /// The decrypted form of . - /// public XElement Decrypt(XElement encryptedElement) { if (encryptedElement == null) diff --git a/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/EncryptedXmlDecryptor.cs b/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/EncryptedXmlDecryptor.cs index 5690ca8569..6a7d639552 100644 --- a/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/EncryptedXmlDecryptor.cs +++ b/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/EncryptedXmlDecryptor.cs @@ -40,7 +40,6 @@ namespace Microsoft.AspNetCore.DataProtection.XmlEncryption /// /// An encrypted XML element. /// The decrypted form of . - /// public XElement Decrypt(XElement encryptedElement) { if (encryptedElement == null) diff --git a/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/NullXmlDecryptor.cs b/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/NullXmlDecryptor.cs index f8de45f23d..a63c0f2963 100644 --- a/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/NullXmlDecryptor.cs +++ b/src/Microsoft.AspNetCore.DataProtection/XmlEncryption/NullXmlDecryptor.cs @@ -17,7 +17,6 @@ namespace Microsoft.AspNetCore.DataProtection.XmlEncryption /// /// An encrypted XML element. /// The decrypted form of . - /// public XElement Decrypt(XElement encryptedElement) { if (encryptedElement == null) diff --git a/src/Microsoft.AspNetCore.DataProtection/project.json b/src/Microsoft.AspNetCore.DataProtection/project.json index 3932a1f275..9372a62be1 100644 --- a/src/Microsoft.AspNetCore.DataProtection/project.json +++ b/src/Microsoft.AspNetCore.DataProtection/project.json @@ -38,6 +38,8 @@ "compilationOptions": { "allowUnsafe": true, "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true } } \ No newline at end of file