Fixing style cop issues

Author: devsriMS

src/ServiceManagement/RecoveryServices/Commands.RecoveryServices/PSRecoveryServicesClient/PSRecoveryServicesVaultClient.cs

@@ -27,7 +27,7 @@ public partial class PSRecoveryServicesClient
         /// Updates the vault certificate
         /// </summary>
         /// <param name="args">the certificate update arguments</param>
-        /// <returns>UploadCertificateResponse</returns>
+        /// <returns>Upload Certificate Response</returns>
         public async Task<UploadCertificateResponse> UpdateVaultCertificate(CertificateArgs args)
         {
             return await this.GetSiteRecoveryClient().Vaults.UploadCertificateAsync(args, this.GetRequestHeaders(false));

src/ServiceManagement/RecoveryServices/Commands.RecoveryServices/PSRecoveryServicesClient/PSRecoveryServicesVaultExtendedInfoClient.cs

@@ -26,7 +26,7 @@ public partial class PSRecoveryServicesClient
         /// <summary>
         /// Gets Vault Extended Information
         /// </summary>
-        /// <returns>ResourceExtendedInformationResponse</returns>
+        /// <returns>Vault Extended Information Response</returns>
         public async Task<ResourceExtendedInformation> GetExtendedInfo()
         {
             ResourceExtendedInformationResponse response = await this.GetSiteRecoveryClient().VaultExtendedInfo.GetExtendedInfoAsync(this.GetRequestHeaders(false));
@@ -37,8 +37,8 @@ public async Task<ResourceExtendedInformation> GetExtendedInfo()
         /// <summary>
         /// Creates the extended information for the vault
         /// </summary>
-        /// <param name="extendedInfoArgs">extneded info to be created</param>
-        /// <returns>ResourceExtendedInformation</returns>
+        /// <param name="extendedInfoArgs">extended info to be created</param>
+        /// <returns>Vault Extended Information</returns>
         public async Task<ResourceExtendedInformation> CreateExtendedInfo(ResourceExtendedInformationArgs extendedInfoArgs)
         {
             ResourceExtendedInformationResponse response = await this.GetSiteRecoveryClient().VaultExtendedInfo.CreateExtendedInfoAsync(extendedInfoArgs, this.GetRequestHeaders(false));

src/ServiceManagement/RecoveryServices/Commands.RecoveryServices/Service/GetVaultCredentialsFile.cs

@@ -16,13 +16,12 @@
 using System.Management.Automation;
 using System.Security.Cryptography.X509Certificates;
 using System.Threading.Tasks;
-using Microsoft.Azure.Commands.RecoveryServices.lib;
 using Microsoft.Azure.Commands.RecoveryServices.SiteRecovery;
 using Microsoft.Azure.Portal.HybridServicesCore;
 using Microsoft.Azure.Portal.RecoveryServices.Models.Common;
-using Microsoft.WindowsAzure.Management.SiteRecovery.Models;
 using Microsoft.WindowsAzure.Commands.Common;
 using Microsoft.WindowsAzure.Commands.Common.Models;
+using Microsoft.WindowsAzure.Management.SiteRecovery.Models;
 
 namespace Microsoft.Azure.Commands.RecoveryServices
 {
@@ -33,6 +32,9 @@ namespace Microsoft.Azure.Commands.RecoveryServices
     [OutputType(typeof(string))]
     public class GetVaultCredentialsFile : RecoveryServicesCmdletBase
     {
+        /// <summary>
+        /// Expiry in hours for generated certificate.
+        /// </summary>
         private const int VaultCertificateExpiryInHoursForHRM = 120;
 
         #region Parameters
@@ -49,7 +51,7 @@ public class GetVaultCredentialsFile : RecoveryServicesCmdletBase
         /// </summary>
         [Parameter(ParameterSetName = ASRParameterSets.ByParam, HelpMessage = "Vault Name for which the cred file to be generated")]
         [ValidateNotNullOrEmpty]
-        // TODO: devsri - Remove this.
+        //// TODO: devsri - Remove this.
         public string CloudServiceName { get; set; }
 
         /// <summary>
@@ -68,8 +70,7 @@ public class GetVaultCredentialsFile : RecoveryServicesCmdletBase
         /// <summary>
         /// Gets or sets the path where the credential file is to be generated
         /// </summary>
-        [Parameter(ParameterSetName = ASRParameterSets.ByParam, Mandatory =false, HelpMessage = "The path where the vault credential file is to be created.")]
-        // TODO:devsri - add file path validator over here.
+        [Parameter(ParameterSetName = ASRParameterSets.ByParam, Mandatory = false, HelpMessage = "The path where the vault credential file is to be created.")]
         public string Path { get; set; }
 
         #endregion Parameters
@@ -119,6 +120,11 @@ public override async void ExecuteCmdlet()
             }
         }
 
+        /// <summary>
+        /// Method to update vault certificate
+        /// </summary>
+        /// <param name="cert">certificate object </param>
+        /// <returns>Upload Certificate Response</returns>
         private async Task<UploadCertificateResponse> UpdateVaultCertificate(X509Certificate2 cert)
         {
             var certificateArgs = new CertificateArgs()
@@ -132,6 +138,10 @@ private async Task<UploadCertificateResponse> UpdateVaultCertificate(X509Certifi
             return response;
         }
 
+        /// <summary>
+        /// Get the Integrity key
+        /// </summary>
+        /// <returns>key as string.</returns>
         private async Task<string> GetChannelIntegrityKey()
         {
             ResourceExtendedInformation extendedInformation;
@@ -141,7 +151,7 @@ private async Task<string> GetChannelIntegrityKey()
             }
             catch (Exception)
             {
-                //TODO:devsri - Handle specific error rather than generic once
+                // TODO:devsri - Handle specific error rather than generic once
                 extendedInformation = new ResourceExtendedInformation();
             }
 
@@ -158,6 +168,16 @@ private async Task<string> GetChannelIntegrityKey()
             return extendedInfo.ChannelIntegrityKey;
         }
 
+        /// <summary>
+        /// Method to generate the credential file content
+        /// </summary>
+        /// <param name="subscriptionId">subscription id</param>
+        /// <param name="resourceName">resource name</param>
+        /// <param name="managementCert">management cert</param>
+        /// <param name="acsDetails">ACS details</param>
+        /// <param name="channelIntegrityKey">Integrity key</param>
+        /// <param name="cloudServiceName">cloud service name</param>
+        /// <returns>vault credential object</returns>
         private ASRVaultCreds GenerateCredential(string subscriptionId, string resourceName, X509Certificate2 managementCert, UploadCertificateResponse acsDetails, string channelIntegrityKey, string cloudServiceName)
         {
             string serializedCertifivate = Convert.ToBase64String(managementCert.Export(X509ContentType.Pfx));
@@ -175,6 +195,10 @@ private ASRVaultCreds GenerateCredential(string subscriptionId, string resourceN
             return vaultCreds;
         }
 
+        /// <summary>
+        /// Method to generate the file name
+        /// </summary>
+        /// <returns>file name as string.</returns>
         private string GenerateFileName()
         {
             string fileName;

src/ServiceManagement/RecoveryServices/Commands.RecoveryServices/lib/CertUtils.cs

@@ -13,54 +13,57 @@
 // ----------------------------------------------------------------------------------
 
 using System;
+using System.IO;
 using System.Security.Cryptography;
 using System.Security.Cryptography.X509Certificates;
 using Security.Cryptography;
 using Security.Cryptography.X509Certificates;
-using System.IO;
-using System.Runtime.InteropServices;
-using System.ComponentModel;
 
-namespace Microsoft.Azure.Commands.RecoveryServices.lib
+namespace Microsoft.Azure.Commands.RecoveryServices
 {
+    /// <summary>
+    /// Class to provide methods to manage the certificates.
+    /// </summary>
     public static class CertUtils
     {
-        public const string MsEnhancedProv = "Microsoft Enhanced Cryptographic Provider v1.0"; // MS_ENHANCED_PROV;
-        private const string DefaultIssuer = "CN=Windows Azure Tools";
-        private const string DefaultPassword = "";
+        /// <summary>
+        /// Enhancement provider
+        /// </summary>
+        private const string MsEnhancedProv = "Microsoft Enhanced Cryptographic Provider v1.0";
 
-        public const string OIDClientAuthValue = "1.3.6.1.5.5.7.3.2";
-        public const string OIDClientAuthFriendlyName = "Client Authentication";
-        public const int KeySize2048 = 2048;
+        /// <summary>
+        /// Client Authentication Value
+        /// </summary>
+        private const string OIDClientAuthValue = "1.3.6.1.5.5.7.3.2";
 
         /// <summary>
-        /// Windows Azure Service Management API requires 2048bit RSA keys.
-        /// The private key needs to be exportable so we can save it to .pfx for sharing with team members.
+        /// Client Authentication Friendly name
         /// </summary>
-        /// <returns>A 2048 bit RSA key</returns>
-        private static CngKey Create2048RsaKey()
-        {
-            var keyCreationParameters = new CngKeyCreationParameters
-            {
-                ExportPolicy = CngExportPolicies.AllowExport,
-                KeyCreationOptions = CngKeyCreationOptions.None,
-                KeyUsage = CngKeyUsages.AllUsages,
-                Provider = new CngProvider(MsEnhancedProv)
-            };
+        private const string OIDClientAuthFriendlyName = "Client Authentication";
 
-            keyCreationParameters.Parameters.Add(new CngProperty("Length", BitConverter.GetBytes(KeySize2048), CngPropertyOptions.None));
+        /// <summary>
+        /// Key size
+        /// </summary>
+        private const int KeySize2048 = 2048;
 
-            return CngKey.Create(CngAlgorithm2.Rsa, null, keyCreationParameters);
-        }
+        /// <summary>
+        /// default issuer name
+        /// </summary>
+        private const string DefaultIssuer = "CN=Windows Azure Tools";
 
         /// <summary>
-        /// Method to generate a self signed certifficate
+        /// default password.
+        /// </summary>
+        private const string DefaultPassword = "";
+
+        /// <summary>
+        /// Method to generate a self signed certificate
         /// </summary>
         /// <param name="validForHours">number of hours for which the certificate is valid.</param>
         /// <param name="subscriptionId">subscriptionId in question</param>
         /// <param name="certificateNamePrefix">prefix for the certificate name</param>
         /// <param name="issuer">issuer for the certificate</param>
-        /// <param name="password">certificate passwor</param>
+        /// <param name="password">certificate password</param>
         /// <returns>certificate as an object</returns>
         public static X509Certificate2 CreateSelfSignedCertificate(
             int validForHours,
@@ -103,18 +106,7 @@ public static X509Certificate2 CreateSelfSignedCertificate(
             var bytes = cert.Export(X509ContentType.Pfx, password);
 
             // PfxValidation is not done here because these are newly created certs and assumed valid.
-            return NewX509Certificate2(bytes, password, X509KeyStorageFlags.PersistKeySet | X509KeyStorageFlags.Exportable, doPfxValidation: false);
-        }
-
-        /// <summary>
-        /// Generates friendly name
-        /// </summary>
-        /// <param name="subscriptionId">subscription id</param>
-        /// <param name="prefix">prefix, likely resource name</param>
-        /// <returns>friendly name</returns>
-        private static string GenerateCertFriendlyName(string subscriptionId, string prefix = "")
-        {
-            return string.Format("{0}{1}-{2}-vaultcredentials", prefix, subscriptionId, DateTime.Now.ToString("M-d-yyyy"));
+            return NewX509Certificate2(bytes, password, X509KeyStorageFlags.PersistKeySet | X509KeyStorageFlags.Exportable, shouldValidatePfx: false);
         }
 
         /// <summary>
@@ -123,9 +115,9 @@ private static string GenerateCertFriendlyName(string subscriptionId, string pre
         /// <param name="rawData">The bytes that represent the certificate</param>
         /// <param name="password">The certificate private password</param>
         /// <param name="keyStorageFlags">The certificate loading options</param>
-        /// <param name="doPfxValidation">Flag to indicate if pfx file should validated. Set to true if the rawData is retrieved from an untrusted source.</param>
+        /// <param name="shouldValidatePfx">Flag to indicate if file should validated. Set to true if the rawData is retrieved from an untrusted source.</param>
         /// <returns>An instance of the X509Certificate</returns>
-        public static X509Certificate2 NewX509Certificate2(byte[] rawData, string password, X509KeyStorageFlags keyStorageFlags, bool doPfxValidation)
+        public static X509Certificate2 NewX509Certificate2(byte[] rawData, string password, X509KeyStorageFlags keyStorageFlags, bool shouldValidatePfx)
         {
             string temporaryFileName = Path.GetTempFileName();
 
@@ -147,5 +139,36 @@ public static X509Certificate2 NewX509Certificate2(byte[] rawData, string passwo
                 }
             }
         }
+
+        /// <summary>
+        /// Generates friendly name
+        /// </summary>
+        /// <param name="subscriptionId">subscription id</param>
+        /// <param name="prefix">prefix, likely resource name</param>
+        /// <returns>friendly name</returns>
+        private static string GenerateCertFriendlyName(string subscriptionId, string prefix = "")
+        {
+            return string.Format("{0}{1}-{2}-vaultcredentials", prefix, subscriptionId, DateTime.Now.ToString("M-d-yyyy"));
+        }
+
+        /// <summary>
+        /// Windows Azure Service Management API requires 2048bit RSA keys.
+        /// The private key needs to be exportable so we can save it for sharing with team members.
+        /// </summary>
+        /// <returns>A 2048 bit RSA key</returns>
+        private static CngKey Create2048RsaKey()
+        {
+            var keyCreationParameters = new CngKeyCreationParameters
+            {
+                ExportPolicy = CngExportPolicies.AllowExport,
+                KeyCreationOptions = CngKeyCreationOptions.None,
+                KeyUsage = CngKeyUsages.AllUsages,
+                Provider = new CngProvider(MsEnhancedProv)
+            };
+
+            keyCreationParameters.Parameters.Add(new CngProperty("Length", BitConverter.GetBytes(KeySize2048), CngPropertyOptions.None));
+
+            return CngKey.Create(CngAlgorithm2.Rsa, null, keyCreationParameters);
+        }
     }
 }