add new function for exporting nested tables

2024-06-15 14:49:13 -05:00
parent c4b2427539
commit 6752e56be9
6 changed files with 353 additions and 23 deletions
--- a/source/Public/Export-M365SecurityAuditTable.ps1
+++ b/source/Public/Export-M365SecurityAuditTable.ps1
@@ -0,0 +1,110 @@
+function Export-M365SecurityAuditTable {
+    [CmdletBinding()]
+    param (
+        [Parameter(Mandatory = $true, ParameterSetName = "FromAuditResultsSingle")]
+        [Parameter(Mandatory = $true, ParameterSetName = "FromAuditResultsMultiple")]
+        [CISAuditResult[]]$AuditResults,
+
+        [Parameter(Mandatory = $true, ParameterSetName = "FromCsvSingle")]
+        [Parameter(Mandatory = $true, ParameterSetName = "FromCsvMultiple")]
+        [ValidateScript({ Test-Path $_ -and (Get-Item $_).PSIsContainer -eq $false })]
+        [string]$CsvPath,
+
+        [Parameter(Mandatory = $false, Position = 1, ParameterSetName = "FromAuditResultsSingle")]
+        [Parameter(Mandatory = $false, Position = 1, ParameterSetName = "FromCsvSingle")]
+        [ValidateSet("6.1.2","6.1.3","7.3.4")]
+        [string]$TestNumber,
+
+        [Parameter(Mandatory = $false, Position = 1, ParameterSetName = "FromAuditResultsMultiple")]
+        [Parameter(Mandatory = $false, Position = 1, ParameterSetName = "FromCsvMultiple")]
+        [ValidateSet("6.1.2","6.1.3","7.3.4")]
+        [string[]]$TestNumbers,
+
+        [Parameter(Mandatory = $true, Position = 2, ParameterSetName = "FromAuditResultsMultiple")]
+        [Parameter(Mandatory = $true, Position = 2, ParameterSetName = "FromCsvMultiple")]
+        [Parameter(Mandatory = $false, Position = 2, ParameterSetName = "FromAuditResultsSingle")]
+        [Parameter(Mandatory = $false, Position = 2, ParameterSetName = "FromCsvSingle")]
+        [string]$ExportPath
+    )
+
+    if ($PSCmdlet.ParameterSetName -like "FromCsv*") {
+        $AuditResults = Import-Csv -Path $CsvPath | ForEach-Object {
+            [CISAuditResult]::new(
+                $_.Status,
+                $_.ELevel,
+                $_.ProfileLevel,
+                [bool]$_.Automated,
+                $_.Connection,
+                $_.Rec,
+                $_.RecDescription,
+                $_.CISControlVer,
+                $_.CISControl,
+                $_.CISDescription,
+                [bool]$_.IG1,
+                [bool]$_.IG2,
+                [bool]$_.IG3,
+                [bool]$_.Result,
+                $_.Details,
+                $_.FailureReason
+            )
+        }
+    }
+
+    #$script:TestDefinitionsObject = Import-Csv -Path .\source\helper\TestDefinitions.csv
+    if (-not $TestNumbers -and -not $TestNumber) {
+        $TestNumbers = "6.1.2","6.1.3","7.3.4"
+        if (-not $ExportPath) {
+            Write-Error "ExportPath is required when exporting all test results."
+            return
+        }
+    }
+
+    $results = @()
+
+    $testsToProcess = if ($TestNumber) { @($TestNumber) } else { $TestNumbers }
+
+    foreach ($test in $testsToProcess) {
+        $auditResult = $AuditResults | Where-Object { $_.Rec -eq $test }
+        if (-not $auditResult) {
+            Write-Error "No audit results found for the test number $test."
+            continue
+        }
+
+        switch ($test) {
+            "6.1.3" {
+                $details = $auditResult.Details
+                $csv = $details | ConvertFrom-Csv -Delimiter '|'
+
+                foreach ($row in $csv) {
+                    $row.AdminActionsMissing = (Get-Action -AbbreviatedActions $row.AdminActionsMissing.Split(',') -ReverseActionType Admin) -join ','
+                    $row.DelegateActionsMissing = (Get-Action -AbbreviatedActions $row.DelegateActionsMissing.Split(',') -ReverseActionType Delegate) -join ','
+                    $row.OwnerActionsMissing = (Get-Action -AbbreviatedActions $row.OwnerActionsMissing.Split(',') -ReverseActionType Owner) -join ','
+                }
+
+                $newObjectDetails = $csv
+                $results += [PSCustomObject]@{ TestNumber = $test; Details = $newObjectDetails }
+            }
+            "7.3.4" {
+                # Placeholder for specific logic for 7.3.4 if needed
+            }
+            Default {
+                $details = $auditResult.Details
+                $csv = $details | ConvertFrom-Csv -Delimiter '|'
+                $results += [PSCustomObject]@{ TestNumber = $test; Details = $csv }
+            }
+        }
+    }
+
+    if ($ExportPath) {
+        $timestamp = (Get-Date).ToString("yyyy.MM.dd_HH.mm.ss")
+        foreach ($result in $results) {
+            $testDef = $script:TestDefinitionsObject | Where-Object { $_.Rec -eq $result.TestNumber }
+            if ($testDef) {
+                $fileName = "$ExportPath\$($timestamp)_$($result.TestNumber).$($testDef.TestFileName -replace '\.ps1$').csv"
+                $result.Details | Out-File -FilePath $fileName
+            }
+        }
+    } else {
+        return $results.Details
+    }
+}