-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathGet-TenantLoggingConfig.ps1
More file actions
1438 lines (1217 loc) · 63.3 KB
/
Get-TenantLoggingConfig.ps1
File metadata and controls
1438 lines (1217 loc) · 63.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<#
.SYNOPSIS
Extracts and analyzes Office 365 tenant logging configurations from single or multiple tenants with comprehensive audit and security logging analysis.
.DESCRIPTION
This script connects to Microsoft Graph API and Exchange Online to retrieve comprehensive logging configuration information
from Office 365 tenants. It provides detailed analysis of audit logging settings, security configurations, compliance
settings, and generates both structured data exports (JSON, CSV) and an interactive HTML dashboard for security operations teams.
The script supports three operational modes:
1. Single tenant with direct credential parameters
2. Single tenant using CSV lookup by client name
3. Multi-tenant processing from CSV file
Key logging analysis features include:
- Mailbox audit logging configuration
- Organization-wide audit settings
- Security & Compliance Center configuration
- Azure AD audit log settings
- Conditional Access logging
- Sign-in log retention policies
- Unified Audit Log status
The script provides recommendations for improving logging coverage and identifies potential security gaps.
.PARAMETER TenantId
The Azure AD/Entra ID tenant ID in GUID format. Required when using direct parameter authentication.
.PARAMETER ClientId
The client/application ID of the registered Azure AD application used for authentication.
.PARAMETER ClientSecret
The client secret for the registered Azure AD application used for authentication.
.PARAMETER CsvPath
Optional. Path to CSV file containing tenant credentials for multi-tenant scenarios.
.PARAMETER ClientName
Optional. The name of the specific client/tenant to process from the CSV file.
.PARAMETER IncludeMailboxAudit
Optional switch. If specified, includes detailed mailbox audit configuration analysis.
.PARAMETER IncludeComplianceCenter
Optional switch. If specified, includes Security & Compliance Center logging configuration.
.PARAMETER IncludeAzureADAudit
Optional switch. If specified, includes Azure AD audit log configuration and retention settings.
.PARAMETER SkipAnomalyDetection
Optional switch. If specified, disables logging configuration anomaly detection.
.PARAMETER OutputFormat
Optional. Format for data export. Valid values are "JSON", "CSV", or "Both". Default is "Both".
.PARAMETER LogLevel
Specifies the level of logging: None, Minimal, Standard, Debug. Default: Standard
.EXAMPLE
.\Get-TenantLoggingConfig.ps1 -TenantId "12345678-1234-1234-1234-123456789012" -ClientId "87654321-4321-4321-4321-210987654321" -ClientSecret "your-client-secret"
.EXAMPLE
.\Get-TenantLoggingConfig.ps1 -ClientName "Contoso Corp" -CsvPath ".\tenants.csv" -IncludeMailboxAudit -IncludeComplianceCenter
.EXAMPLE
.\Get-TenantLoggingConfig.ps1 -CsvPath ".\all_tenants.csv" -IncludeMailboxAudit -IncludeAzureADAudit -IncludeComplianceCenter
.NOTES
Required Microsoft Graph API Permissions:
- AuditLog.Read.All (to read audit log configuration)
- Directory.Read.All (to read directory and tenant configuration)
- Policy.Read.All (to read conditional access and security policies)
- SecurityEvents.Read.All (to read security configuration)
Required Exchange Online Permissions:
- Exchange Administrator or Global Administrator role
Version: 1.0
Author: Geoff Tankersley
Last Modified: 2025-08-12
#>
param(
[Parameter(Mandatory=$false, ParameterSetName='SingleTenant')]
[string]$TenantId,
[Parameter(Mandatory=$false, ParameterSetName='SingleTenant')]
[string]$ClientId,
[Parameter(Mandatory=$false, ParameterSetName='SingleTenant')]
[string]$ClientSecret,
[Parameter(Mandatory=$false, ParameterSetName='MultiTenant')]
[Parameter(Mandatory=$false, ParameterSetName='ClientLookup')]
[string]$CsvPath,
[Parameter(Mandatory=$false, ParameterSetName='ClientLookup')]
[string]$ClientName,
[Parameter(Mandatory=$false)]
[switch]$IncludeMailboxAudit,
[Parameter(Mandatory=$false)]
[switch]$IncludeComplianceCenter,
[Parameter(Mandatory=$false)]
[switch]$IncludeAzureADAudit,
[Parameter(Mandatory=$false)]
[switch]$SkipAnomalyDetection,
[Parameter(Mandatory=$false)]
[ValidateSet("JSON", "CSV", "Both")]
[string]$OutputFormat = "Both",
[Parameter(Mandatory=$false)]
[ValidateSet('None', 'Minimal', 'Standard', 'Debug')]
[string]$LogLevel = 'Standard'
)
#Requires -Version 5.1
$ErrorActionPreference = "Continue"
$timestamp = Get-Date -Format "yyyyMMdd-HHmmss"
$outputFolder = "TenantLoggingConfig-$timestamp"
$logFile = Join-Path -Path $outputFolder -ChildPath "logging-config-$timestamp.txt"
try {
New-Item -ItemType Directory -Path $outputFolder -Force | Out-Null
Write-Host "Created output directory: $outputFolder" -ForegroundColor Green
}
catch {
Write-Error "Failed to create output directory: $_"
exit 1
}
enum LogLevel {
None = 0
Minimal = 1
Standard = 2
Debug = 3
}
$script:LogLevel = [LogLevel]::$LogLevel
function Set-LogLevel {
param([LogLevel]$Level)
$script:LogLevel = $Level
}
function Write-LogFile {
param(
[Parameter(Mandatory=$true)]
[string]$Message,
[Parameter(Mandatory=$false)]
[ValidateSet("None", "Minimal", "Standard", "Debug")]
[string]$Level = "Standard",
[Parameter(Mandatory=$false)]
[string]$Color = "White"
)
$logLevelEnum = [LogLevel]::$Level
if ($script:LogLevel -ge $logLevelEnum) {
$logMessage = "$(Get-Date -Format 'yyyy-MM-dd HH:mm:ss') [$Level] $Message"
Add-Content -Path $logFile -Value $logMessage -Force
if ($Color -ne "White") {
Write-Host $Message -ForegroundColor $Color
} else {
Write-Host $Message
}
}
}
function Get-ClientCredentials {
param(
[Parameter(Mandatory=$true)]
[string]$ClientName,
[Parameter(Mandatory=$true)]
[string]$CsvPath
)
Write-LogFile "Looking up credentials for client: $ClientName" -Level "Standard"
if (-not (Test-Path -Path $CsvPath)) {
throw "CSV file not found: $CsvPath"
}
try {
$keys = Import-Csv -Path $CsvPath
$clientCreds = $keys | Where-Object { $_.Client -eq $ClientName }
if (-not $clientCreds) {
throw "Client '$ClientName' not found in CSV file"
}
if ($clientCreds.Count -gt 1) {
Write-LogFile "Multiple entries found for client '$ClientName', using first match" -Level "Minimal" -Color "Yellow"
$clientCreds = $clientCreds[0]
}
return @{
TenantId = $clientCreds.'Tenant ID'.Trim()
ClientId = $clientCreds.'Client ID'.Trim()
ClientSecret = $clientCreds.'Key Value'.Trim()
ClientName = $clientCreds.Client.Trim()
}
}
catch {
throw "Error reading CSV file: $_"
}
}
function Get-MsGraphToken {
param (
[Parameter(Mandatory=$true)]
[string]$TenantId,
[Parameter(Mandatory=$true)]
[string]$ClientId,
[Parameter(Mandatory=$true)]
[string]$ClientSecret,
[Parameter(Mandatory=$false)]
[int]$MaxRetries = 3
)
$tokenUrl = "https://login.microsoftonline.com/$TenantId/oauth2/v2.0/token"
$body = @{
client_id = $ClientId
client_secret = $ClientSecret
scope = "https://graph.microsoft.com/.default"
grant_type = "client_credentials"
}
$retryCount = 0
while ($retryCount -lt $MaxRetries) {
try {
Write-LogFile "Attempting to acquire access token (attempt $($retryCount + 1)/$MaxRetries)" -Level "Standard"
$response = Invoke-RestMethod -Uri $tokenUrl -Method Post -Body $body -ContentType "application/x-www-form-urlencoded"
Write-LogFile "Successfully acquired access token" -Level "Standard"
return $response.access_token
}
catch {
$retryCount++
if ($retryCount -ge $MaxRetries) {
Write-LogFile "Failed to obtain access token after $MaxRetries attempts: $_" -Level "Minimal" -Color "Red"
throw $_
}
Write-LogFile "Token acquisition failed, retrying in 5 seconds... (attempt $retryCount/$MaxRetries)" -Level "Minimal" -Color "Yellow"
Start-Sleep -Seconds 5
}
}
}
function Get-AzureADAuditConfig {
param (
[Parameter(Mandatory=$true)]
[string]$AccessToken
)
$headers = @{
"Authorization" = "Bearer $AccessToken"
"Content-Type" = "application/json"
}
try {
Write-LogFile "Retrieving Azure AD audit log configuration..." -Level "Standard"
# Directory audit settings
$auditConfigUri = "https://graph.microsoft.com/v1.0/auditLogs/directoryAudits?`$top=1"
$auditResponse = Invoke-RestMethod -Uri $auditConfigUri -Method Get -Headers $headers
# Sign-in log settings
$signInConfigUri = "https://graph.microsoft.com/v1.0/auditLogs/signIns?`$top=1"
$signInResponse = Invoke-RestMethod -Uri $signInConfigUri -Method Get -Headers $headers
# Tenant information
$tenantUri = "https://graph.microsoft.com/v1.0/organization"
$tenantResponse = Invoke-RestMethod -Uri $tenantUri -Method Get -Headers $headers
$tenant = $tenantResponse.value[0]
return @{
DirectoryAuditEnabled = ($auditResponse.value.Count -gt 0)
SignInAuditEnabled = ($signInResponse.value.Count -gt 0)
TenantDisplayName = $tenant.displayName
TenantId = $tenant.id
TenantDomain = ($tenant.verifiedDomains | Where-Object { $_.isDefault }).name
SecurityDefaults = $tenant.securityComplianceNotificationMails
DirectorySync = $tenant.onPremisesSyncEnabled
}
}
catch {
Write-LogFile "Error retrieving Azure AD audit configuration: $_" -Level "Minimal" -Color "Red"
return @{
DirectoryAuditEnabled = $false
SignInAuditEnabled = $false
TenantDisplayName = "Unknown"
TenantId = "Unknown"
TenantDomain = "Unknown"
SecurityDefaults = $null
DirectorySync = $null
}
}
}
function Get-ConditionalAccessConfig {
param (
[Parameter(Mandatory=$true)]
[string]$AccessToken
)
$headers = @{
"Authorization" = "Bearer $AccessToken"
"Content-Type" = "application/json"
}
try {
Write-LogFile "Retrieving Conditional Access configuration..." -Level "Standard"
$caPoliciesUri = "https://graph.microsoft.com/v1.0/identity/conditionalAccess/policies"
$caResponse = Invoke-RestMethod -Uri $caPoliciesUri -Method Get -Headers $headers
$policies = $caResponse.value
$enabledPolicies = $policies | Where-Object { $_.state -eq "enabled" }
$reportOnlyPolicies = $policies | Where-Object { $_.state -eq "enabledForReportingButNotEnforced" }
$disabledPolicies = $policies | Where-Object { $_.state -eq "disabled" }
return @{
TotalPolicies = $policies.Count
EnabledPolicies = $enabledPolicies.Count
ReportOnlyPolicies = $reportOnlyPolicies.Count
DisabledPolicies = $disabledPolicies.Count
PoliciesWithLogging = ($policies | Where-Object { $_.sessionControls }).Count
BlockLegacyAuth = ($enabledPolicies | Where-Object {
$_.conditions.clientAppTypes -contains "exchangeActiveSync" -or
$_.conditions.clientAppTypes -contains "other"
}).Count
RequireMFA = ($enabledPolicies | Where-Object {
$_.grantControls.builtInControls -contains "mfa"
}).Count
Policies = $policies
}
}
catch {
$errorDetails = $_.Exception.Message
if ($_.Exception.Message -like "*403*" -or $_.Exception.Message -like "*Forbidden*") {
Write-LogFile "Insufficient permissions for Conditional Access configuration (403 Forbidden). This requires Policy.Read.All permission." -Level "Minimal" -Color "Yellow"
} else {
Write-LogFile "Error retrieving Conditional Access configuration: $errorDetails" -Level "Minimal" -Color "Red"
}
return @{
TotalPolicies = 0
EnabledPolicies = 0
ReportOnlyPolicies = 0
DisabledPolicies = 0
PoliciesWithLogging = 0
BlockLegacyAuth = 0
RequireMFA = 0
Policies = @()
Error = "Access Denied - Insufficient Permissions"
}
}
}
function Get-ComplianceCenterConfig {
param (
[Parameter(Mandatory=$true)]
[string]$AccessToken
)
$headers = @{
"Authorization" = "Bearer $AccessToken"
"Content-Type" = "application/json"
}
try {
Write-LogFile "Retrieving Security & Compliance Center configuration..." -Level "Standard"
# Compliance policies
$complianceUri = "https://graph.microsoft.com/beta/deviceManagement/deviceCompliancePolicies"
$complianceResponse = Invoke-RestMethod -Uri $complianceUri -Method Get -Headers $headers -ErrorAction SilentlyContinue
# DLP policies
$dlpUri = "https://graph.microsoft.com/beta/informationProtection/policy/labels"
$dlpResponse = Invoke-RestMethod -Uri $dlpUri -Method Get -Headers $headers -ErrorAction SilentlyContinue
# Retention policies
$retentionUri = "https://graph.microsoft.com/beta/security/labels/retentionLabels"
$retentionResponse = Invoke-RestMethod -Uri $retentionUri -Method Get -Headers $headers -ErrorAction SilentlyContinue
return @{
CompliancePolicies = if ($complianceResponse.value) { $complianceResponse.value.Count } else { 0 }
DLPPolicies = if ($dlpResponse.value) { $dlpResponse.value.Count } else { 0 }
RetentionPolicies = if ($retentionResponse.value) { $retentionResponse.value.Count } else { 0 }
HasComplianceConfig = ($complianceResponse.value.Count -gt 0) -or ($dlpResponse.value.Count -gt 0) -or ($retentionResponse.value.Count -gt 0)
}
}
catch {
Write-LogFile "Error retrieving Compliance Center configuration: $_" -Level "Minimal" -Color "Red"
return @{
CompliancePolicies = 0
DLPPolicies = 0
RetentionPolicies = 0
HasComplianceConfig = $false
}
}
}
function Get-ExchangeOnlineAuditConfig {
param (
[Parameter(Mandatory=$true)]
[hashtable]$Credentials
)
try {
Write-LogFile "Connecting to Exchange Online for comprehensive audit configuration..." -Level "Standard"
if (-not (Get-Module -ListAvailable -Name ExchangeOnlineManagement)) {
Write-LogFile "ExchangeOnlineManagement module not found. Installing..." -Level "Standard" -Color "Yellow"
try {
Install-Module -Name ExchangeOnlineManagement -Force -AllowClobber -Scope CurrentUser
Write-LogFile "ExchangeOnlineManagement module installed successfully" -Level "Standard" -Color "Green"
}
catch {
Write-LogFile "Failed to install ExchangeOnlineManagement module: $_" -Level "Minimal" -Color "Red"
return @{
Error = "ExchangeOnlineManagement module not available and installation failed"
}
}
}
Import-Module ExchangeOnlineManagement -Force
try {
# Get Exchange Online specific access token
$tokenBody = @{
client_id = $Credentials.ClientId
client_secret = $Credentials.ClientSecret
scope = "https://outlook.office365.com/.default"
grant_type = "client_credentials"
}
$tokenUrl = "https://login.microsoftonline.com/$($Credentials.TenantId)/oauth2/v2.0/token"
$tokenResponse = Invoke-RestMethod -Uri $tokenUrl -Method Post -Body $tokenBody -ContentType "application/x-www-form-urlencoded"
$accessToken = $tokenResponse.access_token
# Connect with the Exchange-specific access token
$Organization = "$($Credentials.TenantId).onmicrosoft.com"
Connect-ExchangeOnline -AccessToken $accessToken -Organization $Organization -ShowBanner:$false -WarningAction SilentlyContinue
Write-LogFile "Successfully connected to Exchange Online using access token" -Level "Standard" -Color "Green"
}
catch {
Write-LogFile "Exchange Online connection failed: $_" -Level "Minimal" -Color "Red"
throw "Exchange Online authentication failed. Ensure Exchange Administrator role is assigned to the service principal."
}
$auditResults = @{}
# 1. Organization-wide audit configuration
Write-LogFile "Retrieving organization audit configuration..." -Level "Debug"
try {
$orgConfig = Get-OrganizationConfig | Select-Object AuditDisabled, IsDehydrated
$auditResults.OrganizationAuditDisabled = $orgConfig.AuditDisabled
$auditResults.OrganizationAuditEnabled = -not $orgConfig.AuditDisabled
$auditResults.TenantIsDehydrated = $orgConfig.IsDehydrated
}
catch {
Write-LogFile "Error retrieving organization config: $_" -Level "Debug"
$auditResults.OrganizationAuditDisabled = $null
$auditResults.OrganizationAuditEnabled = $false
}
# 2. Admin audit log configuration
Write-LogFile "Retrieving admin audit log configuration..." -Level "Debug"
try {
$adminAuditConfig = Get-AdminAuditLogConfig
$auditResults.AdminAuditLogEnabled = $adminAuditConfig.AdminAuditLogEnabled
$auditResults.AdminAuditLogAgeLimit = $adminAuditConfig.LogLevel
$auditResults.AdminAuditLogCmdlets = $adminAuditConfig.AdminAuditLogCmdlets.Count
$auditResults.AdminAuditLogParameters = $adminAuditConfig.AdminAuditLogParameters.Count
}
catch {
Write-LogFile "Error retrieving admin audit config: $_" -Level "Debug"
$auditResults.AdminAuditLogEnabled = $false
$auditResults.AdminAuditLogAgeLimit = "Unknown"
$auditResults.AdminAuditLogCmdlets = 0
$auditResults.AdminAuditLogParameters = 0
}
# 3. Mailbox audit configuration (comprehensive)
Write-LogFile "Retrieving mailbox audit configuration..." -Level "Debug"
try {
# Get all mailboxes with audit settings
$mailboxes = Get-EXOMailbox -ResultSize 1000 -PropertySets Audit
$auditEnabledCount = ($mailboxes | Where-Object { $_.AuditEnabled }).Count
$auditDisabledCount = ($mailboxes | Where-Object { -not $_.AuditEnabled }).Count
# Get default mailbox audit configuration
$defaultAuditConfig = Get-MailboxAuditBypassAssociation | Where-Object { $_.AuditBypassEnabled }
$bypassCount = $defaultAuditConfig.Count
$auditResults.TotalMailboxes = $mailboxes.Count
$auditResults.MailboxAuditEnabledCount = $auditEnabledCount
$auditResults.MailboxAuditDisabledCount = $auditDisabledCount
$auditResults.MailboxAuditBypassCount = $bypassCount
$auditResults.MailboxAuditCoveragePercentage = if ($mailboxes.Count -gt 0) {
[math]::Round(($auditEnabledCount / $mailboxes.Count) * 100, 1)
} else { 0 }
# Sample of mailbox audit settings
$auditResults.SampleMailboxAuditSettings = $mailboxes | Select-Object -First 10 | ForEach-Object {
@{
UserPrincipalName = $_.UserPrincipalName
DisplayName = $_.DisplayName
AuditEnabled = $_.AuditEnabled
RecipientTypeDetails = $_.RecipientTypeDetails
AuditLogAgeLimit = $_.AuditLogAgeLimit
AuditOwner = $_.AuditOwner -join ","
AuditDelegate = $_.AuditDelegate -join ","
AuditAdmin = $_.AuditAdmin -join ","
}
}
}
catch {
Write-LogFile "Error retrieving mailbox audit config: $_" -Level "Debug"
$auditResults.TotalMailboxes = 0
$auditResults.MailboxAuditEnabledCount = 0
$auditResults.MailboxAuditDisabledCount = 0
$auditResults.MailboxAuditBypassCount = 0
$auditResults.MailboxAuditCoveragePercentage = 0
$auditResults.SampleMailboxAuditSettings = @()
}
# 4. Transport and message tracking configuration
Write-LogFile "Retrieving transport and message tracking configuration..." -Level "Debug"
try {
$transportConfig = Get-TransportConfig | Select-Object MessageTrackingLogEnabled, MessageTrackingLogMaxAge, MessageTrackingLogMaxDirectorySize
$auditResults.MessageTrackingEnabled = $transportConfig.MessageTrackingLogEnabled
$auditResults.MessageTrackingMaxAge = $transportConfig.MessageTrackingLogMaxAge
$auditResults.MessageTrackingMaxSize = $transportConfig.MessageTrackingLogMaxDirectorySize
}
catch {
Write-LogFile "Error retrieving transport config: $_" -Level "Debug"
$auditResults.MessageTrackingEnabled = $false
$auditResults.MessageTrackingMaxAge = "Unknown"
$auditResults.MessageTrackingMaxSize = "Unknown"
}
# 5. Role group and management role assignments
Write-LogFile "Retrieving role group configuration..." -Level "Debug"
try {
$roleGroups = Get-RoleGroup | Select-Object Name, Members
$auditResults.TotalRoleGroups = $roleGroups.Count
$auditResults.PopulatedRoleGroups = ($roleGroups | Where-Object { $_.Members.Count -gt 0 }).Count
# Get management role assignments for audit-related roles
$managementRoles = Get-ManagementRoleAssignment | Where-Object {
$_.Role -like "*Audit*" -or $_.Role -like "*Compliance*" -or $_.Role -like "*eDiscovery*"
}
$auditResults.AuditRelatedRoleAssignments = $managementRoles.Count
# Sample role group data
$auditResults.SampleRoleGroups = $roleGroups | Select-Object -First 10 | ForEach-Object {
@{
Name = $_.Name
MemberCount = $_.Members.Count
Members = ($_.Members | Select-Object -First 5) -join ", "
}
}
}
catch {
Write-LogFile "Error retrieving role configuration: $_" -Level "Debug"
$auditResults.TotalRoleGroups = 0
$auditResults.PopulatedRoleGroups = 0
$auditResults.AuditRelatedRoleAssignments = 0
$auditResults.SampleRoleGroups = @()
}
# 6. Litigation hold and retention policy information
Write-LogFile "Retrieving litigation hold and retention configuration..." -Level "Debug"
try {
$litigationHoldMailboxes = Get-EXOMailbox -Properties LitigationHoldEnabled -ResultSize 1000 | Where-Object { $_.LitigationHoldEnabled -eq $true }
$auditResults.LitigationHoldMailboxes = $litigationHoldMailboxes.Count
# Retention policy count
$retentionPolicies = Get-RetentionPolicy
$auditResults.RetentionPoliciesCount = $retentionPolicies.Count
# Retention tag count
$retentionTags = Get-RetentionPolicyTag
$auditResults.RetentionTagsCount = $retentionTags.Count
}
catch {
Write-LogFile "Error retrieving retention config: $_" -Level "Debug"
$auditResults.LitigationHoldMailboxes = 0
$auditResults.RetentionPoliciesCount = 0
$auditResults.RetentionTagsCount = 0
}
# 7. Data Loss Prevention (DLP) policy information
Write-LogFile "Retrieving DLP policy configuration..." -Level "Debug"
try {
$dlpPolicies = Get-DlpPolicy
$auditResults.DLPPoliciesCount = $dlpPolicies.Count
$auditResults.DLPPoliciesEnabled = ($dlpPolicies | Where-Object { $_.State -eq "Enabled" }).Count
# Sample DLP policies
$auditResults.SampleDLPPolicies = $dlpPolicies | Select-Object -First 5 | ForEach-Object {
@{
Name = $_.Name
State = $_.State
Mode = $_.Mode
}
}
}
catch {
Write-LogFile "Error retrieving DLP config: $_" -Level "Debug"
$auditResults.DLPPoliciesCount = 0
$auditResults.DLPPoliciesEnabled = 0
$auditResults.SampleDLPPolicies = @()
}
# 8. Anti-malware and anti-spam configuration
Write-LogFile "Retrieving anti-malware and anti-spam configuration..." -Level "Debug"
try {
$malwarePolicies = Get-MalwareFilterPolicy
$auditResults.MalwarePoliciesCount = $malwarePolicies.Count
$spamPolicies = Get-HostedContentFilterPolicy
$auditResults.SpamPoliciesCount = $spamPolicies.Count
}
catch {
Write-LogFile "Error retrieving anti-malware/spam config: $_" -Level "Debug"
$auditResults.MalwarePoliciesCount = 0
$auditResults.SpamPoliciesCount = 0
}
# 9. Safe Attachments and Safe Links (if available)
Write-LogFile "Retrieving Defender for Office 365 configuration..." -Level "Debug"
try {
$safeAttachmentPolicies = Get-SafeAttachmentPolicy -ErrorAction SilentlyContinue
$auditResults.SafeAttachmentPoliciesCount = if ($safeAttachmentPolicies) { $safeAttachmentPolicies.Count } else { 0 }
$safeLinkPolicies = Get-SafeLinksPolicy -ErrorAction SilentlyContinue
$auditResults.SafeLinkPoliciesCount = if ($safeLinkPolicies) { $safeLinkPolicies.Count } else { 0 }
}
catch {
Write-LogFile "Defender for Office 365 not available or no permissions: $_" -Level "Debug"
$auditResults.SafeAttachmentPoliciesCount = 0
$auditResults.SafeLinkPoliciesCount = 0
}
# 10. Calculate overall Exchange audit score
$exchangeAuditScore = 0
$maxExchangeScore = 100
# Scoring criteria
if ($auditResults.OrganizationAuditEnabled) { $exchangeAuditScore += 20 }
if ($auditResults.AdminAuditLogEnabled) { $exchangeAuditScore += 15 }
if ($auditResults.MailboxAuditCoveragePercentage -gt 90) { $exchangeAuditScore += 20 }
elseif ($auditResults.MailboxAuditCoveragePercentage -gt 75) { $exchangeAuditScore += 15 }
elseif ($auditResults.MailboxAuditCoveragePercentage -gt 50) { $exchangeAuditScore += 10 }
if ($auditResults.MessageTrackingEnabled) { $exchangeAuditScore += 10 }
if ($auditResults.DLPPoliciesEnabled -gt 0) { $exchangeAuditScore += 10 }
if ($auditResults.RetentionPoliciesCount -gt 0) { $exchangeAuditScore += 10 }
if ($auditResults.SafeAttachmentPoliciesCount -gt 0) { $exchangeAuditScore += 5 }
if ($auditResults.SafeLinkPoliciesCount -gt 0) { $exchangeAuditScore += 5 }
if ($auditResults.MailboxAuditBypassCount -eq 0) { $exchangeAuditScore += 5 }
$auditResults.ExchangeAuditScore = $exchangeAuditScore
$auditResults.ExchangeAuditScorePercentage = [math]::Round(($exchangeAuditScore / $maxExchangeScore) * 100, 1)
Disconnect-ExchangeOnline -Confirm:$false -ErrorAction SilentlyContinue
Write-LogFile "Exchange Online audit configuration retrieval completed" -Level "Standard" -Color "Green"
return $auditResults
}
catch {
Write-LogFile "Error during Exchange Online audit configuration retrieval: $_" -Level "Minimal" -Color "Red"
try {
Disconnect-ExchangeOnline -Confirm:$false -ErrorAction SilentlyContinue
}
catch {
}
return @{
Error = $_.Exception.Message
OrganizationAuditEnabled = $false
TotalMailboxes = 0
MailboxAuditEnabledCount = 0
MailboxAuditDisabledCount = 0
MailboxAuditBypassCount = 0
MailboxAuditCoveragePercentage = 0
ExchangeAuditScore = 0
ExchangeAuditScorePercentage = 0
}
}
}
function Find-LoggingAnomalies {
param (
[Parameter(Mandatory=$true)]
[hashtable]$LoggingConfig
)
Write-LogFile "Analyzing logging configuration for potential issues..." -Level "Standard"
$anomalies = @()
# 1. Organization-wide audit disabled
if (-not $LoggingConfig.AzureAD.DirectoryAuditEnabled) {
$anomalies += @{
Type = "Directory Audit Disabled"
Severity = "High"
Details = "Azure AD directory audit logging is not enabled"
Recommendation = "Enable directory audit logging in Azure AD to track administrative changes"
}
}
# 2. Sign-in audit disabled
if (-not $LoggingConfig.AzureAD.SignInAuditEnabled) {
$anomalies += @{
Type = "Sign-in Audit Disabled"
Severity = "High"
Details = "Azure AD sign-in audit logging is not enabled"
Recommendation = "Enable sign-in audit logging to track user authentication events"
}
}
# 3. Exchange Online audit issues
if ($LoggingConfig.ExchangeOnlineAudit) {
if (-not $LoggingConfig.ExchangeOnlineAudit.OrganizationAuditEnabled) {
$anomalies += @{
Type = "Exchange Organization Audit Disabled"
Severity = "High"
Details = "Exchange Online organization-wide auditing is disabled"
Recommendation = "Enable organization-wide auditing with Set-OrganizationConfig -AuditDisabled `$false"
}
}
if (-not $LoggingConfig.ExchangeOnlineAudit.AdminAuditLogEnabled) {
$anomalies += @{
Type = "Exchange Admin Audit Disabled"
Severity = "High"
Details = "Exchange Online administrator audit logging is disabled"
Recommendation = "Enable admin audit logging to track administrative changes"
}
}
if ($LoggingConfig.ExchangeOnlineAudit.MailboxAuditBypassCount -gt 0) {
$anomalies += @{
Type = "Mailbox Audit Bypass"
Severity = "Medium"
Details = "$($LoggingConfig.ExchangeOnlineAudit.MailboxAuditBypassCount) mailboxes have audit bypass enabled"
Recommendation = "Review and minimize audit bypass exceptions for security accounts"
}
}
$nonAuditedPercentage = if ($LoggingConfig.ExchangeOnlineAudit.TotalMailboxes -gt 0) {
[math]::Round(($LoggingConfig.ExchangeOnlineAudit.MailboxAuditDisabledCount / $LoggingConfig.ExchangeOnlineAudit.TotalMailboxes) * 100, 1)
} else { 0 }
if ($nonAuditedPercentage -gt 10) {
$anomalies += @{
Type = "High Non-Audited Mailbox Percentage"
Severity = "Medium"
Details = "$nonAuditedPercentage% of mailboxes ($($LoggingConfig.ExchangeOnlineAudit.MailboxAuditDisabledCount)/$($LoggingConfig.ExchangeOnlineAudit.TotalMailboxes)) have audit disabled"
Recommendation = "Review mailbox audit settings and enable auditing for critical mailboxes"
}
}
if (-not $LoggingConfig.ExchangeOnlineAudit.MessageTrackingEnabled) {
$anomalies += @{
Type = "Message Tracking Disabled"
Severity = "Medium"
Details = "Exchange Online message tracking is disabled"
Recommendation = "Enable message tracking for email flow monitoring and troubleshooting"
}
}
if ($LoggingConfig.ExchangeOnlineAudit.DLPPoliciesCount -eq 0) {
$anomalies += @{
Type = "No DLP Policies"
Severity = "Medium"
Details = "No Data Loss Prevention policies are configured in Exchange Online"
Recommendation = "Implement DLP policies to protect sensitive data and generate audit trails"
}
}
}
# 4. Conditional Access logging gaps
if ($LoggingConfig.ConditionalAccess.TotalPolicies -eq 0) {
$anomalies += @{
Type = "No Conditional Access Policies"
Severity = "Medium"
Details = "No Conditional Access policies are configured"
Recommendation = "Implement Conditional Access policies to improve security and generate audit logs"
}
}
# 5. Missing compliance configuration
if (-not $LoggingConfig.ComplianceCenter.HasComplianceConfig) {
$anomalies += @{
Type = "No Compliance Configuration"
Severity = "Medium"
Details = "No compliance policies, DLP policies, or retention policies are configured"
Recommendation = "Implement compliance policies to generate audit trails for data protection"
}
}
Write-LogFile "Logging anomaly detection completed. Found $($anomalies.Count) potential issues" -Level "Standard"
return $anomalies
}
function Format-LoggingData {
param (
[Parameter(Mandatory=$true)]
[hashtable]$AzureADConfig,
[Parameter(Mandatory=$false)]
[hashtable]$ConditionalAccessConfig = @{},
[Parameter(Mandatory=$false)]
[hashtable]$ComplianceCenterConfig = @{},
[Parameter(Mandatory=$false)]
[hashtable]$ExchangeOnlineAuditConfig = @{}
)
Write-LogFile "Formatting logging configuration data..." -Level "Standard"
# Calculate overall logging score (0-100)
$scoringCriteria = @{
AzureADDirectoryAudit = if ($AzureADConfig.DirectoryAuditEnabled) { 12 } else { 0 }
AzureADSignInAudit = if ($AzureADConfig.SignInAuditEnabled) { 12 } else { 0 }
ExchangeOrgAudit = if ($ExchangeOnlineAuditConfig.OrganizationAuditEnabled) { 15 } else { 0 }
ExchangeAdminAudit = if ($ExchangeOnlineAuditConfig.AdminAuditLogEnabled) { 10 } else { 0 }
MailboxAuditCoverage = if ($ExchangeOnlineAuditConfig.MailboxAuditCoveragePercentage -gt 90) { 12 } elseif ($ExchangeOnlineAuditConfig.MailboxAuditCoveragePercentage -gt 75) { 8 } elseif ($ExchangeOnlineAuditConfig.MailboxAuditCoveragePercentage -gt 50) { 4 } else { 0 }
ConditionalAccessPolicies = if ($ConditionalAccessConfig.EnabledPolicies -gt 0) { 8 } else { 0 }
ComplianceConfig = if ($ComplianceCenterConfig.HasComplianceConfig) { 6 } else { 0 }
LegacyAuthBlocking = if ($ConditionalAccessConfig.BlockLegacyAuth -gt 0) { 6 } else { 0 }
MFAEnforcement = if ($ConditionalAccessConfig.RequireMFA -gt 0) { 6 } else { 0 }
MessageTracking = if ($ExchangeOnlineAuditConfig.MessageTrackingEnabled) { 4 } else { 0 }
DLPPolicies = if ($ExchangeOnlineAuditConfig.DLPPoliciesEnabled -gt 0) { 4 } else { 0 }
}
$overallScore = ($scoringCriteria.Values | Measure-Object -Sum).Sum
$securityPosture = switch ($overallScore) {
{ $_ -ge 90 } { "Excellent" }
{ $_ -ge 75 } { "Good" }
{ $_ -ge 60 } { "Fair" }
{ $_ -ge 40 } { "Poor" }
default { "Critical" }
}
$formattedConfig = [PSCustomObject]@{
TenantName = $AzureADConfig.TenantDisplayName
TenantId = $AzureADConfig.TenantId
TenantDomain = $AzureADConfig.TenantDomain
DirectorySyncEnabled = $AzureADConfig.DirectorySync
# Azure AD Audit Configuration
DirectoryAuditEnabled = $AzureADConfig.DirectoryAuditEnabled
SignInAuditEnabled = $AzureADConfig.SignInAuditEnabled
# Exchange Online Audit Configuration (Comprehensive)
ExchangeOrganizationAuditEnabled = if ($ExchangeOnlineAuditConfig.OrganizationAuditEnabled -ne $null) { $ExchangeOnlineAuditConfig.OrganizationAuditEnabled } else { $false }
ExchangeAdminAuditEnabled = if ($ExchangeOnlineAuditConfig.AdminAuditLogEnabled) { $ExchangeOnlineAuditConfig.AdminAuditLogEnabled } else { $false }
TotalMailboxes = if ($ExchangeOnlineAuditConfig.TotalMailboxes) { $ExchangeOnlineAuditConfig.TotalMailboxes } else { 0 }
MailboxAuditEnabledCount = if ($ExchangeOnlineAuditConfig.MailboxAuditEnabledCount) { $ExchangeOnlineAuditConfig.MailboxAuditEnabledCount } else { 0 }
MailboxAuditDisabledCount = if ($ExchangeOnlineAuditConfig.MailboxAuditDisabledCount) { $ExchangeOnlineAuditConfig.MailboxAuditDisabledCount } else { 0 }
MailboxAuditBypassCount = if ($ExchangeOnlineAuditConfig.MailboxAuditBypassCount) { $ExchangeOnlineAuditConfig.MailboxAuditBypassCount } else { 0 }
MessageTrackingEnabled = if ($ExchangeOnlineAuditConfig.MessageTrackingEnabled) { $ExchangeOnlineAuditConfig.MessageTrackingEnabled } else { $false }
LitigationHoldMailboxes = if ($ExchangeOnlineAuditConfig.LitigationHoldMailboxes) { $ExchangeOnlineAuditConfig.LitigationHoldMailboxes } else { 0 }
# Exchange Online Security Policies
ExchangeDLPPoliciesCount = if ($ExchangeOnlineAuditConfig.DLPPoliciesCount) { $ExchangeOnlineAuditConfig.DLPPoliciesCount } else { 0 }
ExchangeDLPPoliciesEnabled = if ($ExchangeOnlineAuditConfig.DLPPoliciesEnabled) { $ExchangeOnlineAuditConfig.DLPPoliciesEnabled } else { 0 }
ExchangeRetentionPoliciesCount = if ($ExchangeOnlineAuditConfig.RetentionPoliciesCount) { $ExchangeOnlineAuditConfig.RetentionPoliciesCount } else { 0 }
ExchangeRetentionTagsCount = if ($ExchangeOnlineAuditConfig.RetentionTagsCount) { $ExchangeOnlineAuditConfig.RetentionTagsCount } else { 0 }
MalwarePoliciesCount = if ($ExchangeOnlineAuditConfig.MalwarePoliciesCount) { $ExchangeOnlineAuditConfig.MalwarePoliciesCount } else { 0 }
SpamPoliciesCount = if ($ExchangeOnlineAuditConfig.SpamPoliciesCount) { $ExchangeOnlineAuditConfig.SpamPoliciesCount } else { 0 }
SafeAttachmentPoliciesCount = if ($ExchangeOnlineAuditConfig.SafeAttachmentPoliciesCount) { $ExchangeOnlineAuditConfig.SafeAttachmentPoliciesCount } else { 0 }
SafeLinkPoliciesCount = if ($ExchangeOnlineAuditConfig.SafeLinkPoliciesCount) { $ExchangeOnlineAuditConfig.SafeLinkPoliciesCount } else { 0 }
# Exchange Audit Scoring
ExchangeAuditScore = if ($ExchangeOnlineAuditConfig.ExchangeAuditScore) { $ExchangeOnlineAuditConfig.ExchangeAuditScore } else { 0 }
ExchangeAuditScorePercentage = if ($ExchangeOnlineAuditConfig.ExchangeAuditScorePercentage) { $ExchangeOnlineAuditConfig.ExchangeAuditScorePercentage } else { 0 }
# Conditional Access Configuration
ConditionalAccessPoliciesTotal = $ConditionalAccessConfig.TotalPolicies
ConditionalAccessPoliciesEnabled = $ConditionalAccessConfig.EnabledPolicies
ConditionalAccessReportOnly = $ConditionalAccessConfig.ReportOnlyPolicies
ConditionalAccessDisabled = $ConditionalAccessConfig.DisabledPolicies
LegacyAuthBlockingPolicies = $ConditionalAccessConfig.BlockLegacyAuth
MFARequirementPolicies = $ConditionalAccessConfig.RequireMFA
# Compliance & Security Configuration
CompliancePoliciesCount = $ComplianceCenterConfig.CompliancePolicies
DLPPoliciesCount = $ComplianceCenterConfig.DLPPolicies
RetentionPoliciesCount = $ComplianceCenterConfig.RetentionPolicies
HasComplianceConfiguration = $ComplianceCenterConfig.HasComplianceConfig
# Calculated Metrics
MailboxAuditCoveragePercentage = if ($ExchangeOnlineAuditConfig.MailboxAuditCoveragePercentage) {
$ExchangeOnlineAuditConfig.MailboxAuditCoveragePercentage
} else { 0 }
ConditionalAccessCoverage = if ($ConditionalAccessConfig.TotalPolicies -gt 0) {
[math]::Round(($ConditionalAccessConfig.EnabledPolicies / $ConditionalAccessConfig.TotalPolicies) * 100, 1)
} else { 0 }
# Overall Assessment
OverallLoggingScore = $overallScore
SecurityPosture = $securityPosture
LoggingMaturityLevel = switch ($overallScore) {
{ $_ -ge 85 } { "Advanced" }
{ $_ -ge 70 } { "Intermediate" }
{ $_ -ge 50 } { "Basic" }
default { "Minimal" }
}
# Timestamps
AssessmentDate = Get-Date -Format "yyyy-MM-dd HH:mm:ss"
LastUpdated = Get-Date -Format "yyyy-MM-dd HH:mm:ss"
}
return $formattedConfig
}
function Export-ToJson {
param (
[Parameter(Mandatory=$true)]
[PSCustomObject]$Data,
[Parameter(Mandatory=$true)]
[string]$OutputPath,
[Parameter(Mandatory=$false)]
[array]$Anomalies = @(),
[Parameter(Mandatory=$false)]
[hashtable]$RawData = @{}
)
$exportData = @{
Summary = $Data
Anomalies = $Anomalies
RawData = $RawData
ExportTimestamp = Get-Date -Format "yyyy-MM-dd HH:mm:ss"
ScriptVersion = "1.0"
}
$jsonOutput = $exportData | ConvertTo-Json -Depth 10
$jsonFile = Join-Path -Path $OutputPath -ChildPath "tenant-logging-config-$(Get-Date -Format 'yyyyMMdd-HHmmss').json"
try {
$jsonOutput | Out-File -FilePath $jsonFile -Encoding UTF8
Write-LogFile "JSON export completed: $jsonFile" -Level "Standard" -Color "Green"
return $jsonFile
}
catch {
Write-LogFile "Failed to export JSON: $_" -Level "Minimal" -Color "Red"
return $null
}
}
function Export-ToCsv {
param (
[Parameter(Mandatory=$true)]
[PSCustomObject]$Data,
[Parameter(Mandatory=$true)]
[string]$OutputPath
)
$csvFile = Join-Path -Path $OutputPath -ChildPath "tenant-logging-summary-$(Get-Date -Format 'yyyyMMdd-HHmmss').csv"
try {
$Data | Export-Csv -Path $csvFile -NoTypeInformation -Encoding UTF8
Write-LogFile "CSV export completed: $csvFile" -Level "Standard" -Color "Green"
return $csvFile
}
catch {
Write-LogFile "Failed to export CSV: $_" -Level "Minimal" -Color "Red"
return $null
}
}
function New-HtmlDashboard {
param (
[Parameter(Mandatory=$true)]
[PSCustomObject]$Data,