powershell-scripts/Audit File Deletion/AuditFileDeletion.ps1

273 lines
8.4 KiB
PowerShell
Raw Normal View History

<#
=============================================================================================
Name: Audit File Deletion in Office 365
Description: This script exports deleted files audit records to CSV
Website: o365reports.com
Script Highlights:
~~~~~~~~~~~~~~~~~
1. The script uses modern authentication to connect to Exchange Online.
2. The script can be executed with MFA enabled account too.
3. Exports report results to CSV file.
4. Helps to generate audit reports for custom periods.
5. Automatically installs the EXO V2 (if not installed already) upon your confirmation.
6. The script is scheduler-friendly. I.e., Credential can be passed as a parameter instead of saving inside the script.
For detailed Script execution: https://o365reports.com/2021/12/15/find-out-who-deleted-files-from-office-365
============================================================================================
#>
Param
(
[Parameter(Mandatory = $false)]
[Nullable[DateTime]]$StartDate,
[Nullable[DateTime]]$EndDate,
[string]$FilesDeletedBy,
[switch]$SharePointOnline,
[switch]$OneDrive,
[string]$UserName,
[string]$Password
)
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
}
else
{
Connect-ExchangeOnline
}
}
$MaxStartDate=((Get-Date).AddDays(-89)).Date
#Getting file deletion activity for past 90 days
if(($StartDate -eq $null) -and ($EndDate -eq $null))
{
$EndDate=(Get-Date).Date
$StartDate=$MaxStartDate
}
#Getting start date to generate file deletion activity report
While($true)
{
if ($StartDate -eq $null)
{
$StartDate=Read-Host Enter start time for report generation '(Eg:04/28/2021)'
}
Try
{
$Date=[DateTime]$StartDate
if($Date -ge $MaxStartDate)
{
break
}
else
{
Write-Host `nAudit can be retrieved only for past 90 days. Please select a date after $MaxStartDate -ForegroundColor Red
return
}
}
Catch
{
Write-Host `nNot a valid date -ForegroundColor Red
}
}
#Getting end date to audit file deletion activity report
While($true)
{
if ($EndDate -eq $null)
{
$EndDate=Read-Host Enter End time for report generation '(Eg: 04/28/2021)'
}
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
}
}
$OutputCSV=".\DeletedFilesAuditReport_$((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
if($CurrentEnd -gt $EndDate)
{
$CurrentEnd=$EndDate
}
if($CurrentStart -eq $CurrentEnd)
{
Write-Host Start and end time are same.Please enter different time range -ForegroundColor Red
Exit
}
Connect_EXO
$CurrentResultCount=0
$AggregateResultCount=0
Write-Host `nAuditing deleted files from $StartDate to $EndDate...
$ProcessedAuditCount=0
$OutputEvents=0
$ExportResult=""
$ExportResults=@()
$RetriveOperation="FileDeleted,FileDeletedFirstStageRecycleBin,FileDeletedSecondStageRecycleBin,FileRecycled"
#Checking whether the user is available
#if(($FilesDeletedBy.Length -ne 0) -and ((Get-Mailbox -Identity $Mailbox) -eq $null))
#{
# Write-Host Mailbox does not exist. Please check the mailbox name. -ForegroundColor Red
#exit
#}
while($true)
{
#Getting file deleted audit data for the given time range
Search-UnifiedAuditLog -StartDate $CurrentStart -EndDate $CurrentEnd -Operations $RetriveOperation -SessionId s -SessionCommand ReturnLargeSet -ResultSize 5000 | ForEach-Object {
$ResultCount++
$ProcessedAuditCount++
Write-Progress -Activity "`n Retrieving file deletion activities from $CurrentStart to $CurrentEnd.."`n" Processed audit record count: $ProcessedAuditCount"
$MoreInfo=$_.auditdata
$Operation=$_.Operations
$DeletedBy=$_.UserIds
$AuditData=$_.auditdata | ConvertFrom-Json
$Workload=$AuditData.Workload
$PrintFlag="True"
#Audit files deleted by specific user
if(($FilesDeletedBy.Length -ne 0) -and ($FilesDeletedBy -ne $DeletedBy))
{
$PrintFlag="False"
}
#Filter for workload based file deletion events
If($SharePointOnline.IsPresent -and ($Workload -eq "OneDrive"))
{
$PrintFlag="False"
}
If($OneDrive.IsPresent -and ($Workload -eq "SharePoint"))
{
$PrintFlag="False"
}
if($PrintFlag -eq "True")
{
$ActivityTime=(Get-Date($AuditData.CreationTime)).ToLocalTime() #Get-Date($AuditData.CreationTime) Uncomment to view the Activity Time in UTC
$DeletedFile=$AuditData.SourceFileName
$FileExtension=$AuditData.SourceFileExtension
$Fileurl=$AuditData.ObjectID
$SiteUrl=$AuditData.SiteUrl
#Export result to csv
$OutputEvents++
$ExportResult=@{'Activity Time'=$ActivityTime;'Deleted File'=$DeletedFile;'Activity'=$Operation;'Deleted By'=$DeletedBy;'File Extension'=$FileExtension;'File URL'=$Fileurl;'Site URL'=$Siteurl;'Workload'=$Workload;'More Info'=$MoreInfo}
$ExportResults= New-Object PSObject -Property $ExportResult
$ExportResults | Select-Object 'Activity Time','Activity','Deleted File','Deleted By','File Extension','File Url','Site url','Workload','More Info' | Export-Csv -Path $OutputCSV -Notype -Append
}
}
$currentResultCount=$currentResultCount+$ResultCount
if($CurrentResultCount -ge 50000)
{
Write-Host Retrieved max record for 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 -match "[Y]")
{
Write-Host Proceeding audit log collection with data loss
[DateTime]$CurrentStart=$CurrentEnd
[DateTime]$CurrentEnd=$CurrentStart.AddMinutes($IntervalTimeInMinutes)
$CurrentResultCount=0
if($CurrentEnd -gt $EndDate)
{
$CurrentEnd=$EndDate
}
}
else
{
Write-Host Please rerun the script with reduced time interval -ForegroundColor Red
Exit
}
}
if($ResultCount -lt 5000)
{
if($CurrentEnd -eq $EndDate)
{
break
}
$CurrentStart=$CurrentEnd
if($CurrentStart -gt (Get-Date))
{
break
}
$CurrentEnd=$CurrentStart.AddMinutes($IntervalTimeInMinutes)
$CurrentResultCount=0
if($CurrentEnd -gt $EndDate)
{
$CurrentEnd=$EndDate
}
}
$ResultCount=0
}
#Open output file after execution
If($OutputEvents -eq 0)
{
Write-Host No records found
}
else
{
Write-Host `nThe output file contains $OutputEvents audit records
if((Test-Path -Path $OutputCSV) -eq "True")
{
Write-Host `n" The Output file available in" -NoNewline -ForegroundColor Yellow; Write-Host $OutputCSV
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
$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 -InformationAction Ignore -ErrorAction SilentlyContinue