-
Notifications
You must be signed in to change notification settings - Fork 0
/
dynamicPermission.Groups.ps1
496 lines (436 loc) · 23.6 KB
/
dynamicPermission.Groups.ps1
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
#####################################################
# HelloID-Conn-Prov-Target-ExchangeOnline-DynamicPermissions-Groups
#
# Version: 2.0.0
#####################################################
# Initialize default values
$c = $configuration | ConvertFrom-Json
$p = $person | ConvertFrom-Json
# The accountReference object contains the Identification object provided in the account create call
$aRef = $accountReference | ConvertFrom-Json
# Operation is a script parameter which contains the action HelloID wants to perform for this permission
# It has one of the following values: "grant", "revoke", "update"
$o = $operation | ConvertFrom-Json
# The entitlementContext contains the sub permissions (Previously the $permissionReference variable)
$eRef = $entitlementContext | ConvertFrom-Json
$success = $false # Set to false at start, at the end, only when no error occurs it is set to true
$auditLogs = [System.Collections.Generic.List[PSCustomObject]]::new()
# Set TLS to accept TLS, TLS 1.1 and TLS 1.2
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls -bor [Net.SecurityProtocolType]::Tls11 -bor [Net.SecurityProtocolType]::Tls12
# Set debug logging
switch ($($c.isDebug)) {
$true { $VerbosePreference = "Continue" }
$false { $VerbosePreference = "SilentlyContinue" }
}
$InformationPreference = "Continue"
$WarningPreference = "Continue"
# Define configuration properties as required
$requiredConfigurationFields = @("AzureADOrganization", "AzureADTenantId", "AzureADAppId", "AzureADAppSecret")
# Used to connect to Exchange Online in an unattended scripting scenario using an App ID and App Secret to create an Access Token.
$AADOrganization = $c.AzureADOrganization
$AADTenantId = $c.AzureADTenantId
$AADAppID = $c.AzureADAppId
$AADAppSecret = $c.AzureADAppSecret
$currentPermissions = @{}
foreach ($permission in $eRef.CurrentPermissions) {
$currentPermissions[$permission.Reference.Id] = $permission.DisplayName
}
# Determine all the sub-permissions that needs to be Granted/Updated/Revoked
$subPermissions = New-Object Collections.Generic.List[PSCustomObject]
# PowerShell commands to import
$commands = @(
, "Get-DistributionGroup"
, "Add-DistributionGroupMember"
, "Remove-DistributionGroupMember"
)
#region functions
function Resolve-HTTPError {
[CmdletBinding()]
param (
[Parameter(Mandatory,
ValueFromPipeline
)]
[object]$ErrorObject
)
process {
$httpErrorObj = [PSCustomObject]@{
FullyQualifiedErrorId = $ErrorObject.FullyQualifiedErrorId
MyCommand = $ErrorObject.InvocationInfo.MyCommand
RequestUri = $ErrorObject.TargetObject.RequestUri
ScriptStackTrace = $ErrorObject.ScriptStackTrace
ErrorMessage = ""
}
if ($ErrorObject.Exception.GetType().FullName -eq "Microsoft.PowerShell.Commands.HttpResponseException") {
$httpErrorObj.ErrorMessage = $ErrorObject.ErrorDetails.Message
}
elseif ($ErrorObject.Exception.GetType().FullName -eq "System.Net.WebException") {
$httpErrorObj.ErrorMessage = [System.IO.StreamReader]::new($ErrorObject.Exception.Response.GetResponseStream()).ReadToEnd()
}
Write-Output $httpErrorObj
}
}
function Get-ErrorMessage {
[CmdletBinding()]
param (
[Parameter(Mandatory,
ValueFromPipeline
)]
[object]$ErrorObject
)
process {
$errorMessage = [PSCustomObject]@{
VerboseErrorMessage = $null
AuditErrorMessage = $null
}
if ( $($ErrorObject.Exception.GetType().FullName -eq "Microsoft.PowerShell.Commands.HttpResponseException") -or $($ErrorObject.Exception.GetType().FullName -eq "System.Net.WebException")) {
$httpErrorObject = Resolve-HTTPError -Error $ErrorObject
$errorMessage.VerboseErrorMessage = $httpErrorObject.ErrorMessage
$errorMessage.AuditErrorMessage = $httpErrorObject.ErrorMessage
}
# If error message empty, fall back on $ex.Exception.Message
if ([String]::IsNullOrEmpty($errorMessage.VerboseErrorMessage)) {
$errorMessage.VerboseErrorMessage = $ErrorObject.Exception.Message
}
if ([String]::IsNullOrEmpty($errorMessage.AuditErrorMessage)) {
$errorMessage.AuditErrorMessage = $ErrorObject.Exception.Message
}
Write-Output $errorMessage
}
}
#endregion functions
try {
# Check if required fields are available in configuration object
$incompleteConfiguration = $false
foreach ($requiredConfigurationField in $requiredConfigurationFields) {
if ($requiredConfigurationField -notin $c.PsObject.Properties.Name) {
$incompleteConfiguration = $true
Write-Warning "Required configuration object field [$requiredConfigurationField] is missing"
}
elseif ([String]::IsNullOrEmpty($c.$requiredConfigurationField)) {
$incompleteConfiguration = $true
Write-Warning "Required configuration object field [$requiredConfigurationField] has a null or empty value"
}
}
if ($incompleteConfiguration -eq $true) {
throw "Configuration object incomplete, cannot continue."
}
try {
# Import module
$moduleName = "ExchangeOnlineManagement"
# If module is imported say that and do nothing
if (Get-Module -Verbose:$false | Where-Object { $_.Name -eq $ModuleName }) {
Write-Verbose "Module [$ModuleName] is already imported."
}
else {
# If module is not imported, but available on disk then import
if (Get-Module -ListAvailable -Verbose:$false | Where-Object { $_.Name -eq $ModuleName }) {
$module = Import-Module $ModuleName -Cmdlet $commands -Verbose:$false
Write-Verbose "Imported module [$ModuleName]"
}
else {
# If the module is not imported, not available and not in the online gallery then abort
throw "Module [$ModuleName] is not available. Please install the module using: Install-Module -Name [$ModuleName] -Force"
}
}
}
catch {
$ex = $PSItem
$errorMessage = Get-ErrorMessage -ErrorObject $ex
Write-Verbose "Error at Line [$($ex.InvocationInfo.ScriptLineNumber)]: $($ex.InvocationInfo.Line). Error: $($errorMessage.VerboseErrorMessage)"
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "Error importing module [$ModuleName]. Error Message: $($errorMessage.AuditErrorMessage)"
IsError = $True
})
# Skip further actions, as this is a critical error
continue
}
# Connect to Exchange
try {
# Create access token
Write-Verbose "Creating Access Token"
$baseUri = "https://login.microsoftonline.com/"
$authUri = $baseUri + "$AADTenantId/oauth2/token"
$body = @{
grant_type = "client_credentials"
client_id = "$AADAppID"
client_secret = "$AADAppSecret"
resource = "https://outlook.office365.com"
}
$Response = Invoke-RestMethod -Method POST -Uri $authUri -Body $body -ContentType "application/x-www-form-urlencoded" -UseBasicParsing:$true
$accessToken = $Response.access_token
# Connect to Exchange Online in an unattended scripting scenario using an access token.
Write-Verbose "Connecting to Exchange Online"
$exchangeSessionParams = @{
Organization = $AADOrganization
AppID = $AADAppID
AccessToken = $accessToken
CommandName = $commands
ShowBanner = $false
ShowProgress = $false
TrackPerformance = $false
ErrorAction = "Stop"
}
$exchangeSession = Connect-ExchangeOnline @exchangeSessionParams
Write-Information "Successfully connected to Exchange Online"
}
catch {
$ex = $PSItem
$errorMessage = Get-ErrorMessage -ErrorObject $ex
Write-Verbose "Error at Line [$($ex.InvocationInfo.ScriptLineNumber)]: $($ex.InvocationInfo.Line). Error: $($errorMessage.VerboseErrorMessage)"
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "Error connecting to Exchange Online. Error Message: $($errorMessage.AuditErrorMessage)"
IsError = $True
})
# Skip further actions, as this is a critical error
continue
}
#region Change mapping here
$desiredPermissions = @{}
if ($o -ne "revoke") {
# Example: Contract Based Logic:
foreach ($contract in $p.Contracts) {
Write-Verbose ("Contract in condition: {0}" -f $contract.Context.InConditions)
if ($contract.Context.InConditions -OR ($dryRun -eq $True)) {
# Example: department_<departmentname>
$groupName = "department_" + $contract.Department.DisplayName
# Example: title_<titlename>
# $groupName = "title_" + $contract.Title.Name
# Get group to use objectGuid to avoid name change issues
$filter = "IsDirSynced -eq 'False' -and DisplayName -eq '$groupName'"
Write-Verbose "Querying EXO group that matches filter [$($filter)]"
$group = Get-DistributionGroup -Filter $filter -ResultSize Unlimited
if (($group | Measure-Object).count -eq 0) {
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "No Group found that matches filter [$($filter)]"
IsError = $true
})
continue
}
elseif (($group | Measure-Object).count -gt 1) {
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "Multiple Groups found that matches filter [$($filter)]. Please correct this so the groups are unique."
IsError = $true
})
continue
}
# Add group to desired permissions with the id as key and the displayname as value (use id to avoid issues with name changes and for uniqueness)
$desiredPermissions["$($group.Guid)"] = $group.DisplayName
}
}
# Example: Person Based Logic:
# Example: location_<locationname>
# $groupName = "location_" + $p.Location.Name
# # Get group to use objectGuid to avoid name change issues
# $filter = "IsDirSynced -eq 'False' -and DisplayName -eq '$groupName'"
# Write-Verbose "Querying EXO group that matches filter [$($filter)]"
# $group = Get-DistributionGroup -Filter $filter -ResultSize Unlimited
# if (($group | Measure-Object).count -eq 0) {
# $auditLogs.Add([PSCustomObject]@{
# # Action = "" # Optional
# Message = "No Group found that matches filter [$($filter)]"
# IsError = $true
# })
# }
# elseif (($group | Measure-Object).count -gt 1) {
# $auditLogs.Add([PSCustomObject]@{
# # Action = "" # Optional
# Message = "Multiple Groups found that matches filter [$($filter)]. Please correct this so the groups are unique."
# IsError = $true
# })
# }
# # Add group to desired permissions with the id as key and the displayname as value (use id to avoid issues with name changes and for uniqueness)
# $desiredPermissions["$($group.Guid)"] = $group.DisplayName
}
Write-Warning ("Desired Permissions: {0}" -f ($desiredPermissions.Values | ConvertTo-Json))
Write-Warning ("Existing Permissions: {0}" -f ($eRef.CurrentPermissions.DisplayName | ConvertTo-Json))
#region Execute
# Compare desired with current permissions and grant permissions
foreach ($permission in $desiredPermissions.GetEnumerator()) {
$subPermissions.Add([PSCustomObject]@{
DisplayName = $permission.Value
Reference = [PSCustomObject]@{ Id = $permission.Name }
})
if (-Not $currentPermissions.ContainsKey($permission.Name)) {
# Grant Exchange Online Groupmembership
try {
Write-Verbose "Granting permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
$dgSplatParams = @{
Identity = $permission.Name
Member = $aRef.Guid
BypassSecurityGroupManagerCheck = $true
}
if ($dryRun -eq $false) {
$addDGMember = Add-DistributionGroupMember @dgSplatParams -Confirm:$false -ErrorAction Stop
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "Successfully granted permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
IsError = $false
})
}
else {
Write-Warning "DryRun: would grant permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
}
}
catch {
$ex = $PSItem
$errorMessage = Get-ErrorMessage -ErrorObject $ex
Write-Verbose "Error at Line [$($ex.InvocationInfo.ScriptLineNumber)]: $($ex.InvocationInfo.Line). Error: $($errorMessage.VerboseErrorMessage)"
if ($($errorMessage.AuditErrorMessage) -like "*Microsoft.Exchange.Management.Tasks.MemberAlreadyExistsException*") {
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "User [$($aRef.UserPrincipalName) ($($aRef.Guid))] is already a member of the group [$($permission.Value) ($($permission.Name))]. Skipped grant of permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
IsError = $false
})
}
else {
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "Error granting permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]. Error Message: $($errorMessage.AuditErrorMessage)"
IsError = $True
})
}
}
}
}
# Compare current with desired permissions and revoke permissions
$newCurrentPermissions = @{}
foreach ($permission in $currentPermissions.GetEnumerator()) {
if (-Not $desiredPermissions.ContainsKey($permission.Name) -AND $permission.Name -ne "No Groups Defined") {
# Revoke Exchange Online Groupmembership
try {
Write-Verbose "Revoking permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
$dgSplatParams = @{
Identity = $permission.Name
Member = $aRef.Guid
BypassSecurityGroupManagerCheck = $true
}
if ($dryRun -eq $false) {
$addDGMember = Remove-DistributionGroupMember @dgSplatParams -Confirm:$false -ErrorAction Stop
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "Successfully revoked permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
IsError = $false
})
}
else {
Write-Warning "DryRun: would revoke permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
}
}
catch {
$ex = $PSItem
$errorMessage = Get-ErrorMessage -ErrorObject $ex
Write-Verbose "Error at Line [$($ex.InvocationInfo.ScriptLineNumber)]: $($ex.InvocationInfo.Line). Error: $($errorMessage.VerboseErrorMessage)"
if ($($errorMessage.AuditErrorMessage) -like "*Microsoft.Exchange.Management.Tasks.MemberNotFoundException*") {
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "User [$($aRef.UserPrincipalName) ($($aRef.Guid))] isn't a member of the group [$($permission.Value) ($($permission.Name))]. Skipped revoke of permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
IsError = $false
})
}
elseif ($($errorMessage.AuditErrorMessage) -like "*Microsoft.Exchange.Configuration.Tasks.ManagementObjectNotFoundException*" -and $($errorMessage.AuditErrorMessage) -like "*$($permission.Name)*") {
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "Group [$($permission.Value) ($($permission.Name))] couldn't be found. Possibly no longer exists. Skipped revoke of permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
IsError = $false
})
}
elseif ($($errorMessage.AuditErrorMessage) -like "*Microsoft.Exchange.Configuration.Tasks.ManagementObjectNotFoundException*" -and $($errorMessage.AuditErrorMessage) -like "*$($aRef.Guid)*") {
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "User [$($aRef.UserPrincipalName) ($($aRef.Guid))] couldn't be found. Possibly no longer exists. Skipped revoke of permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
IsError = $false
})
}
else {
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "Error revoking permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]. Error Message: $($errorMessage.AuditErrorMessage)"
IsError = $True
})
}
}
}
else {
$newCurrentPermissions[$permission.Name] = $permission.Value
}
}
# # Update current permissions
# # Warning! This example will grant all permissions again! Only uncomment this when this is needed (e.g. force update)
# if ($o -eq "update") {
# # Grant all desired permissions, ignoring current permissions
# foreach ($permission in $desiredPermissions.GetEnumerator()) {
# $subPermissions.Add([PSCustomObject]@{
# DisplayName = $permission.Value
# Reference = [PSCustomObject]@{ Id = $permission.Name }
# })
# if (-Not $currentPermissions.ContainsKey($permission.Name)) {
# # Grant Exchange Online Groupmembership
# try {
# Write-Verbose "Granting permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
# $dgSplatParams = @{
# Identity = $permission.Name
# Member = $aRef.Guid
# BypassSecurityGroupManagerCheck = $true
# }
# if ($dryRun -eq $false) {
# $addDGMember = Add-DistributionGroupMember @dgSplatParams -Confirm:$false -ErrorAction Stop
# $auditLogs.Add([PSCustomObject]@{
# # Action = "" # Optional
# Message = "Successfully granted permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
# IsError = $false
# })
# }
# else {
# Write-Warning "DryRun: would grant permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
# }
# }
# catch {
# $ex = $PSItem
# $errorMessage = Get-ErrorMessage -ErrorObject $ex
# Write-Verbose "Error at Line [$($ex.InvocationInfo.ScriptLineNumber)]: $($ex.InvocationInfo.Line). Error: $($errorMessage.VerboseErrorMessage)"
# if ($($errorMessage.AuditErrorMessage) -like "*Microsoft.Exchange.Management.Tasks.MemberAlreadyExistsException*") {
# $auditLogs.Add([PSCustomObject]@{
# # Action = "" # Optional
# Message = "User [$($aRef.UserPrincipalName) ($($aRef.Guid))] is already a member of the group [$($permission.Value) ($($permission.Name))]. Skipped grant of permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
# IsError = $false
# }
# )
# }
# else {
# $auditLogs.Add([PSCustomObject]@{
# # Action = "" # Optional
# Message = "Error granting permission to group [$($permission.Value) ($($permission.Name))] for user [$($aRef.UserPrincipalName) ($($aRef.Guid))]. Error Message: $($errorMessage.AuditErrorMessage)"
# IsError = $True
# })
# }
# }
# }
# }
# }
# Handle case of empty defined dynamic permissions. Without this the entitlement will error.
if ($o -match "update|grant" -AND $subPermissions.count -eq 0) {
$subPermissions.Add([PSCustomObject]@{
DisplayName = "No Groups Defined"
Reference = [PSCustomObject]@{ Id = "No Groups Defined" }
})
}
}
#endregion Execute
finally {
# Check if auditLogs contains errors, if no errors are found, set success to true
if (-NOT($auditLogs.IsError -contains $true)) {
$success = $true
}
#region Build up result
$result = [PSCustomObject]@{
Success = $success
SubPermissions = $subPermissions
AuditLogs = $auditLogs
}
Write-Output ($result | ConvertTo-Json -Depth 10)
#endregion Build up result
}