diff --git a/Audit Shared Mailbox Activities/AuditSharedMailboxActivities.ps1 b/Audit Shared Mailbox Activities/AuditSharedMailboxActivities.ps1 new file mode 100644 index 0000000..38baf93 --- /dev/null +++ b/Audit Shared Mailbox Activities/AuditSharedMailboxActivities.ps1 @@ -0,0 +1,317 @@ +<# +============================================================================================= +Name: Audit Shared Mailbox Activities Using PowerShell +Version: 1.0 +Website: o365reports.com + +Script Highlights: +~~~~~~~~~~~~~~~~~~ + +1. The script retrieves audit log for the last 180 days by default. +2. Helps to generate audit reports for custom periods. +3. Tracks activities from a specific shared mailbox. +4. Exports shared mailbox activities performed by admins and delegated users. +5. Exports report results to CSV file. +6. The script can be executed with an MFA-enabled account too. +7. Supports Certificate-based Authentication too. +8. Automatically installs the EXO Module (if not installed already) upon your confirmation. +9. The script is scheduler friendly. + +For detailed script execution: https://o365reports.com/2024/09/24/audit-shared-mailbox-activities-using-powershell/ +============================================================================================ +#> + +Param +( + [Parameter(Mandatory = $false)] + [Switch]$IncludeExternalAccess, + [Nullable[DateTime]]$StartDate, + [Nullable[DateTime]]$EndDate, + [string]$Organization, + [string]$ClientId, + [string]$CertificateThumbprint, + [string]$UserName, + [string]$Password, + [string]$SharedMailboxUPN +) + + +$MaxStartDate=((Get-Date).AddDays(-179)).Date + + +#Retrive audit log for the past 180 days +if(($StartDate -eq $null) -and ($EndDate -eq $null)) +{ + $EndDate=(Get-Date).Date + $StartDate=$MaxStartDate +} +#Getting start date to audit export report +While($true) +{ + if ($StartDate -eq $null) + { + $StartDate=Read-Host Enter start time for report generation '(Eg:09/24/2024)' + } + Try + { + $Date=[DateTime]$StartDate + if($Date -ge $MaxStartDate) + { + break + } + else + { + Write-Host `nAudit can be retrieved only for the past 180 days. Please select a date after $MaxStartDate -ForegroundColor Red + return + } + } + Catch + { + Write-Host `nNot a valid date -ForegroundColor Red + } +} + + +#Getting end date to export audit report +While($true) +{ + if ($EndDate -eq $null) + { + $EndDate=Read-Host Enter End time for report generation '(Eg: 9/24/2024)' + } + Try + { + $Date=[DateTime]$EndDate + if($EndDate -lt ($StartDate)) + { + Write-Host End time should be later than start time -ForegroundColor Red + return + } + break + } + Catch + { + Write-Host `nNot a valid date -ForegroundColor Red + } +} + + +Function Connect_Exo +{ + #Check for EXO module inatallation + $Module = Get-Module ExchangeOnlineManagement -ListAvailable + if($Module.count -eq 0) + { + Write-Host Exchange Online PowerShell module is not available -ForegroundColor yellow + $Confirm= Read-Host Are you sure you want to install module? [Y] Yes [N] No + if($Confirm -match "[yY]") + { + Write-host "Installing Exchange Online PowerShell module" + Install-Module ExchangeOnlineManagement -Repository PSGallery -AllowClobber -Force + } + else + { + Write-Host EXO module is required to connect Exchange Online.Please install module using Install-Module ExchangeOnlineManagement cmdlet. + Exit + } + } + Write-Host Connecting to Exchange Online... + #Storing credential in script for scheduling purpose/ Passing credential as parameter - Authentication using non-MFA account + if(($UserName -ne "") -and ($Password -ne "")) + { + $SecuredPassword = ConvertTo-SecureString -AsPlainText $Password -Force + $Credential = New-Object System.Management.Automation.PSCredential $UserName,$SecuredPassword + Connect-ExchangeOnline -Credential $Credential -ShowBanner:$false + } + elseif($Organization -ne "" -and $ClientId -ne "" -and $CertificateThumbprint -ne "") + { + Connect-ExchangeOnline -AppId $ClientId -CertificateThumbprint $CertificateThumbprint -Organization $Organization -ShowBanner:$false + } + else + { + Connect-ExchangeOnline -ShowBanner:$false + } +} +Connect_Exo + +#Get shared mailbox name +if($SharedMailboxUPN -eq "") +{ + $SharedMailboxUPN= Read-Host "Enter shared mailbox name (eg: support@contoso.com)" +} +#Validate mailbox name + $MailboxDetails=Get-ExoMailbox -Identity $SharedMailboxUPN +if(!($?)) +{ + Write-Host The given mailbox $SharedMailboxUPN is not valid. Please provide a valid shared mailbox name. -ForegroundColor Red + Exit +} +$Location=Get-Location +$OutputCSV="$Location\Audit_Shared_Mailbox_Activities_$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).csv" +$IntervalTimeInMinutes=1440 #$IntervalTimeInMinutes=Read-Host Enter interval time period '(in minutes)' +$CurrentStart=$StartDate +$CurrentEnd=$CurrentStart.AddMinutes($IntervalTimeInMinutes) + +#Check whether CurrentEnd exceeds EndDate(checks for 1st iteration) +if($CurrentEnd -gt $EndDate) +{ + $CurrentEnd=$EndDate +} + +$AggregateResults = 0 +$CurrentResult= @() +$CurrentResultCount=0 +$SMBActivitiesCount=0 +Write-Host `nRetrieving audit log from $StartDate to $EndDate... -ForegroundColor cyan + +while($true) +{ + #Write-Host Retrieving audit log between StartDate $CurrentStart to EndDate $CurrentEnd ******* IntervalTime $IntervalTimeInMinutes minutes + if($CurrentStart -eq $CurrentEnd) + { + Write-Host Start and end time are same.Please enter different time range -ForegroundColor Red + Exit + } + + + #Getting audit log for a given time range + else + { + $Results=Search-UnifiedAuditLog -StartDate $CurrentStart -EndDate $CurrentEnd -Operations 'ApplyRecord','Copy','Create','FolderBind','HardDelete','SendAs','SendOnBehalf','MailItemsAccessed','MessageBind','Move','MoveToDeletedItems','RecordDelete','SoftDelete','Update','UpdateCalendarDelegation','UpdateFolderPermissions','UpdateInboxRules' -SessionId s -SessionCommand ReturnLargeSet -ResultSize 5000 + } + + $AllAuditData=@() + $AllAudits= + + foreach($Result in $Results) + { + + $MoreInfo=$Result.auditData + $AuditData=$Result.auditdata | ConvertFrom-Json + $Operation= $AuditData.operation + #Remove owner access + if($AuditData.LogonType -eq 0) + { + continue + + } + + #Filter for external access + if((!($IncludeExternalAccess.IsPresent)) -and ($AuditData.ExternalAccess -eq $true)) + { + continue + } + + #Processing shared mailbox access records + if(($AuditData.LogonUserSId -ne $AuditData.MailboxOwnerSid) -or ((($AuditData.Operation -eq "SendAs") -or ($AuditData.Operation -eq "SendOnBehalf")) -and ($AuditData.UserType -eq 0))) + { + $AuditData.CreationTime=(Get-Date($AuditData.CreationTime)).ToLocalTime() + if($AuditData.LogonType -eq 1) + { + $LogonType="Administrator" + } + elseif($AuditData.LogonType -eq 2) + { + $LogonType="Delegated" + } + else + { + $LogonType="Microsoft datacenter" + } + if($AuditData.Operation -eq "SendAs") + { + $AccessedMB=$AuditData.SendAsUserSMTP + $AccessedBy=$AuditData.UserId + } + elseif($AuditData.Operation -eq "SendOnBehalf") + { + $AccessedMB=$AuditData.SendOnBehalfOfUserSmtp + $AccessedBy=$AuditData.UserId + } + else + { + $AccessedMB=$AuditData.MailboxOwnerUPN + $AccessedBy=$AuditData.UserId + } + + #Filter the result for specific mailbox + if(($AccessedMB -eq $AccessedBy) -or ($AccessedMB -ne $SharedMailboxUPN)) + { + Continue + } + + + $SMBActivitiesCount++ + $AllAudits=@{'Activity Time'=$AuditData.CreationTime;'Performed by'=$AccessedBy;'Performed Operation'=$AuditData.Operation;'Shared Mailbox Name'=$AccessedMB;'Logon Type'=$LogonType;'Result Status'=$AuditData.ResultStatus;'External Access'=$AuditData.ExternalAccess;'More Info'=$MoreInfo} + $AllAuditData= New-Object PSObject -Property $AllAudits + $AllAuditData | Sort 'Activity Time' | select 'Activity Time','Shared Mailbox Name','Performed Operation','Performed by','Result Status','Logon Type','External Access','More Info' | Export-Csv $OutputCSV -NoTypeInformation -Append + } + } + + $currentResultCount=$CurrentResultCount+($Results.count) + $AggregateResults +=$Results.count + Write-Progress -Activity "`n Retrieving audit log for $CurrentStart : $CurrentResultCount records"`n" Total processed audit record count: $AggregateResults" + if(($CurrentResultCount -eq 50000) -or ($Results.count -lt 5000)) + { + if($CurrentResultCount -eq 50000) + { + Write-Host Retrieved max record for the current range.Proceeding further may cause data loss or rerun the script with reduced time interval. -ForegroundColor Red + $Confirm=Read-Host `nAre you sure you want to continue? [Y] Yes [N] No + if($Confirm -notmatch "[Y]") + { + Write-Host Please rerun the script with reduced time interval -ForegroundColor Red + Exit + } + else + { + Write-Host Proceeding audit log collection with data loss + } + } + #Check for last iteration + if(($CurrentEnd -eq $EndDate)) + { + break + } + [DateTime]$CurrentStart=$CurrentEnd + #Break loop if start date exceeds current date(There will be no data) + if($CurrentStart -gt (Get-Date)) + { + break + } + [DateTime]$CurrentEnd=$CurrentStart.AddMinutes($IntervalTimeInMinutes) + if($CurrentEnd -gt $EndDate) + { + $CurrentEnd=$EndDate + } + + $CurrentResultCount=0 + $CurrentResult = @() + } +} +Write-Host `n~~ Script prepared by AdminDroid Community ~~`n -ForegroundColor Green +Write-Host "~~ Check out " -NoNewline -ForegroundColor Green; Write-Host "admindroid.com" -ForegroundColor Yellow -NoNewline; Write-Host " to get access to 1800+ Microsoft 365 reports. ~~" -ForegroundColor Green `n`n + +If($AggregateResults -eq 0) +{ + Write-Host No records found +} +#Open output file after execution +else +{ + Write-Host `nThe output file contains $SMBActivitiesCount audit records + if((Test-Path -Path $OutputCSV) -eq "True") + { + Write-Host `nThe Output file available in: -NoNewline -ForegroundColor Yellow + Write-Host $OutputCSV + $Prompt = New-Object -ComObject wscript.shell + $UserInput = $Prompt.popup("Do you want to open output file?",` + 0,"Open Output File",4) + If ($UserInput -eq 6) + { + Invoke-Item "$OutputCSV" + } + } +} + +#Disconnect Exchange Online session +Disconnect-ExchangeOnline -Confirm:$false \ No newline at end of file