131 lines
7.5 KiB
PowerShell
131 lines
7.5 KiB
PowerShell
function Test-MailboxAuditingE5 {
|
|
[CmdletBinding()]
|
|
[OutputType([CISAuditResult])]
|
|
param (
|
|
# Parameters can be added if needed
|
|
)
|
|
|
|
begin {
|
|
# Dot source the class script if necessary
|
|
#. .\source\Classes\CISAuditResult.ps1
|
|
|
|
# Conditions for 6.1.3 (L1) Ensure mailbox auditing for E5 users is Enabled
|
|
#
|
|
# Validate test for a pass:
|
|
# - Confirm that the automated test results align with the manual audit steps outlined in the CIS benchmark.
|
|
# - Specific conditions to check:
|
|
# - Condition A: Mailbox auditing is enabled for E5 users.
|
|
# - Condition B: AuditAdmin actions include ApplyRecord, Create, HardDelete, MailItemsAccessed, MoveToDeletedItems, Send, SendAs, SendOnBehalf, SoftDelete, Update, UpdateCalendarDelegation, UpdateFolderPermissions, UpdateInboxRules.
|
|
# - Condition C: AuditDelegate actions include ApplyRecord, Create, HardDelete, MailItemsAccessed, MoveToDeletedItems, SendAs, SendOnBehalf, SoftDelete, Update, UpdateFolderPermissions, UpdateInboxRules.
|
|
# - Condition D: AuditOwner actions include ApplyRecord, HardDelete, MailItemsAccessed, MoveToDeletedItems, Send, SoftDelete, Update, UpdateCalendarDelegation, UpdateFolderPermissions, UpdateInboxRules.
|
|
#
|
|
# Validate test for a fail:
|
|
# - Confirm that the failure conditions in the automated test are consistent with the manual audit results.
|
|
# - Specific conditions to check:
|
|
# - Condition A: Mailbox auditing is not enabled for E5 users.
|
|
# - Condition B: AuditAdmin actions do not include all of the following: ApplyRecord, Create, HardDelete, MailItemsAccessed, MoveToDeletedItems, Send, SendAs, SendOnBehalf, SoftDelete, Update, UpdateCalendarDelegation, UpdateFolderPermissions, UpdateInboxRules.
|
|
# - Condition C: AuditDelegate actions do not include all of the following: ApplyRecord, Create, HardDelete, MailItemsAccessed, MoveToDeletedItems, SendAs, SendOnBehalf, SoftDelete, Update, UpdateFolderPermissions, UpdateInboxRules.
|
|
# - Condition D: AuditOwner actions do not include all of the following: ApplyRecord, HardDelete, MailItemsAccessed, MoveToDeletedItems, Send, SoftDelete, Update, UpdateCalendarDelegation, UpdateFolderPermissions, UpdateInboxRules.
|
|
|
|
$e5SkuPartNumbers = @("SPE_E5", "ENTERPRISEPREMIUM", "OFFICEE5")
|
|
$AdminActions = @("ApplyRecord", "Copy", "Create", "FolderBind", "HardDelete", "MailItemsAccessed", "Move", "MoveToDeletedItems", "SendAs", "SendOnBehalf", "Send", "SoftDelete", "Update", "UpdateCalendarDelegation", "UpdateFolderPermissions", "UpdateInboxRules")
|
|
$DelegateActions = @("ApplyRecord", "Create", "FolderBind", "HardDelete", "MailItemsAccessed", "Move", "MoveToDeletedItems", "SendAs", "SendOnBehalf", "SoftDelete", "Update", "UpdateFolderPermissions", "UpdateInboxRules")
|
|
$OwnerActions = @("ApplyRecord", "Create", "HardDelete", "MailboxLogin", "Move", "MailItemsAccessed", "MoveToDeletedItems", "Send", "SoftDelete", "Update", "UpdateCalendarDelegation", "UpdateFolderPermissions", "UpdateInboxRules")
|
|
|
|
$allFailures = @()
|
|
$allUsers = Get-AzureADUser -All $true
|
|
$processedUsers = @{} # Dictionary to track processed users
|
|
$recnum = "6.1.3"
|
|
}
|
|
|
|
process {
|
|
try {
|
|
foreach ($user in $allUsers) {
|
|
if ($processedUsers.ContainsKey($user.UserPrincipalName)) {
|
|
Write-Verbose "Skipping already processed user: $($user.UserPrincipalName)"
|
|
continue
|
|
}
|
|
|
|
$licenseDetails = Get-MgUserLicenseDetail -UserId $user.UserPrincipalName
|
|
$hasOfficeE5 = ($licenseDetails | Where-Object { $_.SkuPartNumber -in $e5SkuPartNumbers }).Count -gt 0
|
|
Write-Verbose "Evaluating user $($user.UserPrincipalName) for Office E5 license."
|
|
|
|
if ($hasOfficeE5) {
|
|
$userUPN = $user.UserPrincipalName
|
|
$mailbox = Get-EXOMailbox -Identity $userUPN -PropertySets Audit
|
|
|
|
$missingActions = @()
|
|
if ($mailbox.AuditEnabled) {
|
|
# Validate Admin actions
|
|
foreach ($action in $AdminActions) {
|
|
if ($mailbox.AuditAdmin -notcontains $action) { $missingActions += "Admin action '$action' missing" } # Condition B
|
|
}
|
|
# Validate Delegate actions
|
|
foreach ($action in $DelegateActions) {
|
|
if ($mailbox.AuditDelegate -notcontains $action) { $missingActions += "Delegate action '$action' missing" } # Condition C
|
|
}
|
|
# Validate Owner actions
|
|
foreach ($action in $OwnerActions) {
|
|
if ($mailbox.AuditOwner -notcontains $action) { $missingActions += "Owner action '$action' missing" } # Condition D
|
|
}
|
|
|
|
if ($missingActions.Count -gt 0) {
|
|
$formattedActions = Format-MissingAction -missingActions $missingActions
|
|
$allFailures += "$userUPN|True|$($formattedActions.Admin)|$($formattedActions.Delegate)|$($formattedActions.Owner)"
|
|
}
|
|
}
|
|
else {
|
|
$allFailures += "$userUPN|False|||"
|
|
}
|
|
|
|
# Mark the user as processed
|
|
$processedUsers[$user.UserPrincipalName] = $true
|
|
}
|
|
}
|
|
|
|
# Prepare failure reasons and details based on compliance
|
|
$failureReasons = if ($allFailures.Count -eq 0) { "N/A" } else { "Audit issues detected." }
|
|
$details = if ($allFailures.Count -eq 0) {
|
|
"All Office E5 users have correct mailbox audit settings." # Condition A for pass
|
|
}
|
|
else {
|
|
"UserPrincipalName|AuditEnabled|AdminActionsMissing|DelegateActionsMissing|OwnerActionsMissing`n" + ($allFailures -join "`n") # Condition A for fail
|
|
}
|
|
|
|
# Populate the audit result
|
|
$params = @{
|
|
Rec = $recnum
|
|
Result = $allFailures.Count -eq 0
|
|
Status = if ($allFailures.Count -eq 0) { "Pass" } else { "Fail" }
|
|
Details = $details
|
|
FailureReason = $failureReasons
|
|
}
|
|
$auditResult = Initialize-CISAuditResult @params
|
|
}
|
|
catch {
|
|
Write-Error "An error occurred during the test: $_"
|
|
|
|
# Retrieve the description from the test definitions
|
|
$testDefinition = $script:TestDefinitionsObject | Where-Object { $_.Rec -eq $recnum }
|
|
$description = if ($testDefinition) { $testDefinition.RecDescription } else { "Description not found" }
|
|
|
|
$script:FailedTests.Add([PSCustomObject]@{ Rec = $recnum; Description = $description; Error = $_ })
|
|
|
|
# Call Initialize-CISAuditResult with error parameters
|
|
$auditResult = Initialize-CISAuditResult -Rec $recnum -Failure
|
|
}
|
|
}
|
|
|
|
end {
|
|
#$verbosePreference = 'Continue'
|
|
$detailsLength = $details.Length
|
|
Write-Verbose "Character count of the details: $detailsLength"
|
|
|
|
if ($detailsLength -gt 32767) {
|
|
Write-Verbose "Warning: The character count exceeds the limit for Excel cells."
|
|
}
|
|
#$verbosePreference = 'SilentlyContinue'
|
|
return $auditResult
|
|
}
|
|
}
|