diff --git a/CHANGELOG.md b/CHANGELOG.md index 59cf0c4..60c65fa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,7 @@ The format is based on and uses the types of changes according to [Keep a Change - Added a new private function `Measure-AuditResult` to calculate and display audit results. - Enhanced error logging to capture failed test details and display them at the end of the audit. - Added a private function `Get-RequiredModule` to initialize the `$requiredModules` variable for better code organization in the main script. -- Updated `Test-MailboxAuditingE3` and `Test-MailboxAuditingE5` functions to use `Format-MissingActions` for structuring missing actions into a pipe-separated table format. +- Updated `Test-MailboxAuditingE3` and `Test-MailboxAuditingE5` functions to use `Format-MissingAction` for structuring missing actions into a pipe-separated table format. - Added more verbose logging to `Test-BlockMailForwarding` and improved error handling for better troubleshooting. - Improved `Test-RestrictCustomScripts` to handle long URL lengths better by extracting and replacing common hostnames, and provided detailed output. - Added sorting to output. diff --git a/helpers/CIS 365 v3.0.0 Controls/Test-MailboxAuditingE3_6.1.2_E3L1_IG1_IG2_IG3.ps1 b/helpers/CIS 365 v3.0.0 Controls/Test-MailboxAuditingE3_6.1.2_E3L1_IG1_IG2_IG3.ps1 index abce35b..62a5675 100644 --- a/helpers/CIS 365 v3.0.0 Controls/Test-MailboxAuditingE3_6.1.2_E3L1_IG1_IG2_IG3.ps1 +++ b/helpers/CIS 365 v3.0.0 Controls/Test-MailboxAuditingE3_6.1.2_E3L1_IG1_IG2_IG3.ps1 @@ -60,7 +60,7 @@ function Test-MailboxAuditingE3_6.1.2_E3L1_IG1_IG2_IG3 { } if ($missingActions) { - $formattedActions = Format-MissingActions $missingActions + $formattedActions = Format-MissingAction $missingActions $allFailures += "$userUPN`: AuditEnabled - True; $formattedActions" } # Mark the user as processed @@ -83,7 +83,7 @@ function Test-MailboxAuditingE3_6.1.2_E3L1_IG1_IG2_IG3 { } } -function Format-MissingActions { +function Format-MissingAction { param ([array]$missingActions) $actionGroups = @{ diff --git a/helpers/CIS 365 v3.0.0 Controls/Test-MailboxAuditingE5_6.1.3_E5L1_IG1_IG2_IG3.ps1 b/helpers/CIS 365 v3.0.0 Controls/Test-MailboxAuditingE5_6.1.3_E5L1_IG1_IG2_IG3.ps1 index 1dd6b92..5525a67 100644 --- a/helpers/CIS 365 v3.0.0 Controls/Test-MailboxAuditingE5_6.1.3_E5L1_IG1_IG2_IG3.ps1 +++ b/helpers/CIS 365 v3.0.0 Controls/Test-MailboxAuditingE5_6.1.3_E5L1_IG1_IG2_IG3.ps1 @@ -60,7 +60,7 @@ function Test-MailboxAuditingE5_6.1.3_E5L1_IG1_IG2_IG3 { } if ($missingActions) { - $formattedActions = Format-MissingActions $missingActions + $formattedActions = Format-MissingAction $missingActions $allFailures += "$userUPN`: AuditEnabled - True; $formattedActions" } else { @@ -92,7 +92,7 @@ function Test-MailboxAuditingE5_6.1.3_E5L1_IG1_IG2_IG3 { } } -function Format-MissingActions { +function Format-MissingAction { param ([array]$missingActions) $actionGroups = @{ diff --git a/source/Private/Format-MissingActions.ps1 b/source/Private/Format-MissingAction.ps1 similarity index 94% rename from source/Private/Format-MissingActions.ps1 rename to source/Private/Format-MissingAction.ps1 index f6fd0bf..1932fb1 100644 --- a/source/Private/Format-MissingActions.ps1 +++ b/source/Private/Format-MissingAction.ps1 @@ -1,4 +1,4 @@ -function Format-MissingActions { +function Format-MissingAction { param ([array]$missingActions) $actionGroups = @{ diff --git a/source/Private/Get-RequiredModule.ps1 b/source/Private/Get-RequiredModule.ps1 index b5b1c8d..ffa65fc 100644 --- a/source/Private/Get-RequiredModule.ps1 +++ b/source/Private/Get-RequiredModule.ps1 @@ -1,5 +1,6 @@ function Get-RequiredModule { [CmdletBinding(DefaultParameterSetName = 'AuditFunction')] + [OutputType([PSCustomObject])] param ( [Parameter(Mandatory = $true, ParameterSetName = 'AuditFunction')] [switch]$AuditFunction, diff --git a/source/Private/Update-CISExcelWorksheet.ps1 b/source/Private/Update-CISExcelWorksheet.ps1 index 6de5747..a0d7ae1 100644 --- a/source/Private/Update-CISExcelWorksheet.ps1 +++ b/source/Private/Update-CISExcelWorksheet.ps1 @@ -25,7 +25,7 @@ function Update-CISExcelWorksheet { # Update the worksheet with the provided data - Update-WorksheetCells -Worksheet $worksheet -Data $Data -StartingRowIndex $StartingRowIndex + Update-WorksheetCell -Worksheet $worksheet -Data $Data -StartingRowIndex $StartingRowIndex # Save and close the Excel package Close-ExcelPackage $excelPackage diff --git a/source/Private/Update-WorksheetCells.ps1 b/source/Private/Update-WorksheetCell.ps1 similarity index 95% rename from source/Private/Update-WorksheetCells.ps1 rename to source/Private/Update-WorksheetCell.ps1 index eae857f..622f963 100644 --- a/source/Private/Update-WorksheetCells.ps1 +++ b/source/Private/Update-WorksheetCell.ps1 @@ -1,4 +1,4 @@ - function Update-WorksheetCells { + function Update-WorksheetCell { param ( $Worksheet, $Data, diff --git a/source/Public/Get-AdminRoleUserLicense.ps1 b/source/Public/Get-AdminRoleUserLicense.ps1 index fa2a49a..9cd86c3 100644 --- a/source/Public/Get-AdminRoleUserLicense.ps1 +++ b/source/Public/Get-AdminRoleUserLicense.ps1 @@ -25,6 +25,8 @@ https://criticalsolutionsnetwork.github.io/M365FoundationsCISReport/#Get-AdminRoleUserLicense #> function Get-AdminRoleUserLicense { + # Set output type to System.Collections.ArrayList + [OutputType([System.Collections.ArrayList])] [CmdletBinding()] param ( [Parameter(Mandatory = $false)] diff --git a/source/tests/Test-MailboxAuditingE3.ps1 b/source/tests/Test-MailboxAuditingE3.ps1 index 26e6379..ca9efcd 100644 --- a/source/tests/Test-MailboxAuditingE3.ps1 +++ b/source/tests/Test-MailboxAuditingE3.ps1 @@ -49,7 +49,7 @@ function Test-MailboxAuditingE3 { } if ($missingActions.Count -gt 0) { - $formattedActions = Format-MissingActions -missingActions $missingActions + $formattedActions = Format-MissingAction -missingActions $missingActions $allFailures += "$userUPN|True|$($formattedActions.Admin)|$($formattedActions.Delegate)|$($formattedActions.Owner)" } } diff --git a/source/tests/Test-MailboxAuditingE5.ps1 b/source/tests/Test-MailboxAuditingE5.ps1 index af40be6..b21f6a2 100644 --- a/source/tests/Test-MailboxAuditingE5.ps1 +++ b/source/tests/Test-MailboxAuditingE5.ps1 @@ -49,7 +49,7 @@ function Test-MailboxAuditingE5 { } if ($missingActions.Count -gt 0) { - $formattedActions = Format-MissingActions -missingActions $missingActions + $formattedActions = Format-MissingAction -missingActions $missingActions $allFailures += "$userUPN|True|$($formattedActions.Admin)|$($formattedActions.Delegate)|$($formattedActions.Owner)" } }