[Enhancement] Multiple format document upload (#110)

* adding code to work with documents with other file extention * adding update for other file formats * remove commented line * cleanup
ssc-spc-ccoe-cei · Mar 15, 2024 · 3f204ad · 3f204ad
1 parent 043addb
commit 3f204ad
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 29 deletions.
diff --git a/psmodules/GR-Common.zip b/psmodules/GR-Common.zip
diff --git a/setup/IaC/modules/automationaccount.bicep b/setup/IaC/modules/automationaccount.bicep
@@ -149,7 +149,7 @@ resource module13 'modules' = if (newDeployment || updatePSModules) {
     properties: {
       contentLink: {
         uri: '${ModuleBaseURL}/GR-Common.zip'
-        version: '1.1.16'
+        version: '1.1.17'
       }
     }
   }

diff --git a/setup/modules.json b/setup/modules.json
@@ -19,7 +19,7 @@
     "localVariables": [
       {
         "Name": "DocumentName",
-        "Value": "BreakGlassAccountProcedure.txt"
+        "Value": "BreakGlassAccountProcedure"
       },
       {
         "Name": "itsgcode",
@@ -33,7 +33,7 @@
     "ModuleType": "Builtin",
     "Status": "Enabled",
     "Required": "True",
-    "Script": "Check-GAAuthenticationMethods -StorageAccountName $vars.storageaccountname -ContainerName $vars.containerName -ResourceGroupName $ResourceGroupName -SubscriptionID $SubID -DocumentName $vars.DocumentName -ControlName $msgTable.CtrName1 -ItemName $msgTable.gaAccntsMFACheck -MsgTable $msgTable -ReportTime $ReportTime -itsgcode $vars.itsgcode",
+    "Script": "Check-GAAuthenticationMethods -StorageAccountName $vars.storageAccountName -ContainerName $vars.containerName -ResourceGroupName $ResourceGroupName -SubscriptionID $SubID -DocumentName $vars.DocumentName -ControlName $msgTable.CtrName1 -ItemName $msgTable.gaAccntsMFACheck -MsgTable $msgTable -ReportTime $ReportTime -itsgcode $vars.itsgcode",
     "variables": [
       {
         "Name": "storageAccountName",
@@ -47,7 +47,7 @@
     "localVariables": [
       {
         "Name": "DocumentName",
-        "Value": "GlobalAdministratorsUPN.txt"
+        "Value": "GlobalAdministratorsUPN"
       },
       {
         "Name": "itsgcode",
@@ -75,7 +75,7 @@
     "localVariables": [
       {
         "Name": "DocumentName",
-        "Value": "BGFollowProcedureResponsibility.txt"
+        "Value": "BGFollowProcedureResponsibility"
       },
       {
         "Name": "itsgcode",
@@ -216,7 +216,7 @@
     "localVariables": [
       {
         "Name": "DocumentName",
-        "Value": "GCPasswordGuidanceDoc.txt"
+        "Value": "GCPasswordGuidanceDoc"
       },
       {
         "Name": "itsgcode",
@@ -244,7 +244,7 @@
     "localVariables": [
       {
         "Name": "DocumentName",
-        "Value": "PrivilegedAccountManagementPlan.txt"
+        "Value": "PrivilegedAccountManagementPlan"
       },
       {
         "Name": "itsgcode",
@@ -300,7 +300,7 @@
     "localVariables": [
       {
         "Name": "DocumentName",
-        "Value": "AuthorizedProcessApprovedByCSO.txt"
+        "Value": "AuthorizedProcessApprovedByCSO"
       },
       {
         "Name": "itsgcode",
@@ -328,7 +328,7 @@
     "localVariables": [
       {
         "Name": "DocumentName",
-        "Value": "GlobalAdministratorsUPN.txt"
+        "Value": "GlobalAdministratorsUPN"
       },
       {
         "Name": "itsgcode",
@@ -396,7 +396,7 @@
     "localVariables": [
       {
         "Name": "DocumentName",
-        "Value": "SPNEncryptedEmailToCSPMSentAttestation.txt"
+        "Value": "SPNEnencryptedEmailToCSPMSentAttestation"
       },
       {
         "Name": "itsgcode",
@@ -524,7 +524,7 @@
     "localVariables": [
       {
         "Name": "DocumentName",
-        "Value": "TLS12EnabledAttestation.txt"
+        "Value": "TLS12EnabledAttestation"
       },
       {
         "Name": "itsgcode",
@@ -580,7 +580,7 @@
     "localVariables": [
       {
         "Name": "DocumentName",
-        "Value": "ConfirmNetworkDiagramExists.txt"
+        "Value": "ConfirmNetworkDiagramExists"
       },
       {
         "Name": "itsgcode",
@@ -648,7 +648,7 @@
     "localVariables": [
       {
         "Name": "DocumentName",
-        "Value": "NetworkBoundaryProtectionPolicy.txt"
+        "Value": "NetworkBoundaryProtectionPolicy"
       },
       {
         "Name": "itsgcode",
@@ -676,7 +676,7 @@
     "localVariables": [
       {
         "Name": "DocumentName",
-        "Value": "LimitPublicIPsPolicy.txt"
+        "Value": "LimitPublicIPsPolicy"
       },
       {
         "Name": "itsgcode",
@@ -704,7 +704,7 @@
     "localVariables": [
       {
         "Name": "DocumentName",
-        "Value": "AuthSourceIPPolicyConfirm.txt"
+        "Value": "AuthSourceIPPolicyConfirm"
       },
       {
         "Name": "itsgcode",
@@ -753,8 +753,8 @@
       {
         "Name": "DocumentName",
         "Value": [
-          "MemorandumOfUnderstanding.txt",
-          "ChiefDirectoryOfficeConfirmation.txt"
+          "MemorandumOfUnderstanding",
+          "ChiefDirectoryOfficeConfirmation"
         ]
       },
       {
@@ -784,7 +784,7 @@
       {
         "Name": "DocumentName",
         "Value": [
-          "SeverityNotificationToEmailConfigured.txt"
+          "SeverityNotificationToEmailConfigured"
         ]
       },
       {
@@ -885,7 +885,7 @@
     "localVariables": [
       {
         "Name": "DocumentName",
-        "Value": "ConfirmPasswordNotificationsConfigured.txt"
+        "Value": "ConfirmPasswordNotificationsConfigured"
       },
       {
         "Name": "itsgcode",

diff --git a/src/Guardrails-Common/GR-Common.psd1 b/src/Guardrails-Common/GR-Common.psd1
@@ -14,7 +14,7 @@
 RootModule = 'GR-Common'
 
 # Version number of this module.
-ModuleVersion = '1.1.16'
+ModuleVersion = '1.1.17'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

diff --git a/src/Guardrails-Common/GR-Common.psm1 b/src/Guardrails-Common/GR-Common.psm1
@@ -527,6 +527,22 @@ function Check-DocumentExistsInStorage {
     [PSCustomObject] $ErrorList = New-Object System.Collections.ArrayList
     [bool] $IsCompliant = $false
     [string] $Comments = $null
+
+    if ($ItemName.ToLower() -eq 'network architecture diagram'){
+        $fileExtensions = @(".pdf", ".png", ".jpeg", ".vsdx")
+    }
+    elseif ($ItemName.ToLower() -eq 'global administrators accounts mfa check') {
+        $fileExtensions = @(".txt")
+    }
+    else {
+        $fileExtensions = @(".txt",".docx", ".doc")
+    }
+
+    $DocumentName_new = New-Object System.Collections.Generic.List[System.Object]
+    ForEach ($fileExt in $fileExtensions) {
+        $DocumentName_new.Add($DocumentName[0] + $fileExt)
+    }
+
     try {
         Select-AzSubscription -Subscription $SubscriptionID | out-null
     }
@@ -550,20 +566,27 @@ function Check-DocumentExistsInStorage {
 
     $docMissing = $false
     $commentsArray = @()
-    ForEach ($docName in $DocumentName) {
+    $blobFound = $false
+
+    ForEach ($docName in $DocumentName_new) {
         # check for procedure doc in blob storage account
         $blobs = Get-AzStorageBlob -Container $ContainerName -Context $StorageAccount.Context -Blob $docName -ErrorAction SilentlyContinue
-
         If ($blobs) {
-            # a blob with the name $DocumentName was located in the specified storage account
-            $commentsArray += $msgTable.procedureFileFound -f $docName
-        }
-        else {
-            # no blob with the name $DocumentName was found in the specified storage account
-            $docMissing = $true
-            $commentsArray += $msgTable.procedureFileNotFound -f $ItemName, $docName, $ContainerName, $StorageAccountName
+            $blobFound = $true
+            break
         }
     }
+
+    if ($blobFound){
+        # a blob with the name $attestationFileName was located in the specified storage account
+        $commentsArray += $msgTable.procedureFileFound -f $docName
+    }
+    else {
+        # no blob with the name $attestationFileName was found in the specified storage account
+        $docMissing = $true
+        $commentsArray += $msgTable.procedureFileNotFound -f $ItemName, $DocumentName[0], $ContainerName, $StorageAccountName
+    }
+
     $Comments = $commentsArray -join ";"
 
     If ($docMissing) {