-
Notifications
You must be signed in to change notification settings - Fork 139
/
MSFT_xADDomainTrust.psm1
676 lines (555 loc) · 20.3 KB
/
MSFT_xADDomainTrust.psm1
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
$script:resourceModulePath = Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent
$script:modulesFolderPath = Join-Path -Path $script:resourceModulePath -ChildPath 'Modules'
$script:localizationModulePath = Join-Path -Path $script:modulesFolderPath -ChildPath 'xActiveDirectory.Common'
Import-Module -Name (Join-Path -Path $script:localizationModulePath -ChildPath 'xActiveDirectory.Common.psm1')
$script:localizedData = Get-LocalizedData -ResourceName 'MSFT_xADDomainTrust'
<#
.SYNOPSIS
Returns the current state of the Active Directory trust.
.PARAMETER SourceDomainName
Specifies the name of the Active Directory domain that is requesting the
trust.
.PARAMETER TargetDomainName
Specifies the name of the Active Directory domain that is being trusted.
.PARAMETER TargetDomainAdministratorCredential
Specifies the credentials to authenticate to the target domain.
.PARAMETER TrustType
Specifies the type of trust. The value 'External' means the context Domain,
while the value 'Forest' means the context 'Forest'.
.PARAMETER TrustDirection
Specifies the direction of the trust.
#>
function Get-TargetResource
{
[CmdletBinding()]
[OutputType([System.Collections.Hashtable])]
param
(
[Parameter(Mandatory = $true)]
[System.String]
$SourceDomainName,
[Parameter(Mandatory = $true)]
[System.String]
$TargetDomainName,
[Parameter(Mandatory = $true)]
[System.Management.Automation.PSCredential]
$TargetDomainAdministratorCredential,
[Parameter(Mandatory = $true)]
[ValidateSet('External', 'Forest')]
[System.String]
$TrustType,
[Parameter(Mandatory = $true)]
[ValidateSet('Bidirectional', 'Inbound', 'Outbound')]
[System.String]
$TrustDirection
)
# Return a credential object without the password.
$cimCredentialInstance = New-CimCredentialInstance -Credential $TargetDomainAdministratorCredential
$returnValue = @{
SourceDomainName = $SourceDomainName
TargetDomainName = $TargetDomainName
TargetDomainAdministratorCredential = $cimCredentialInstance
}
$getTrustTargetAndSourceObject = @{
SourceDomainName = $SourceDomainName
TargetDomainName = $TargetDomainName
TargetDomainAdministratorCredential = $TargetDomainAdministratorCredential
TrustType = $TrustType
}
$trustSource, $trustTarget = Get-TrustSourceAndTargetObject @getTrustTargetAndSourceObject
try
{
# Find trust between source & destination.
Write-Verbose -Message (
$script:localizedData.CheckingTrustMessage -f $SourceDomainName, $TargetDomainName, $directoryContextTyp
)
$trust = $trustSource.GetTrustRelationship($trustTarget)
$returnValue['TrustDirection'] = $trust.TrustDirection
$returnValue['TrustType'] = ConvertFrom-DirectoryContextType -DirectoryContextType $trust.TrustType
Write-Verbose -Message ($script:localizedData.TrustPresentMessage -f $SourceDomainName, $TargetDomainName, $directoryContextType)
$returnValue['Ensure'] = 'Present'
}
catch
{
Write-Verbose -Message ($script:localizedData.TrustAbsentMessage -f $SourceDomainName, $TargetDomainName, $directoryContextType)
$returnValue['Ensure'] = 'Absent'
$returnValue['TrustDirection'] = $null
$returnValue['TrustType'] = $null
}
return $returnValue
}
<#
.SYNOPSIS
Creates, removes, or updates the Active Directory trust so it is in the
desired state.
.PARAMETER SourceDomainName
Specifies the name of the Active Directory domain that is requesting the
trust.
.PARAMETER TargetDomainName
Specifies the name of the Active Directory domain that is being trusted.
.PARAMETER TargetDomainAdministratorCredential
Specifies the credentials to authenticate to the target domain.
.PARAMETER TrustType
Specifies the type of trust. The value 'External' means the context Domain,
while the value 'Forest' means the context 'Forest'.
.PARAMETER TrustDirection
Specifies the direction of the trust.
.PARAMETER Ensure
Specifies whether the computer account is present or absent. Default
value is 'Present'.
#>
function Set-TargetResource
{
[CmdletBinding()]
param
(
[Parameter(Mandatory = $true)]
[System.String]
$SourceDomainName,
[Parameter(Mandatory = $true)]
[System.String]
$TargetDomainName,
[Parameter(Mandatory = $true)]
[System.Management.Automation.PSCredential]
$TargetDomainAdministratorCredential,
[Parameter(Mandatory = $true)]
[ValidateSet('External', 'Forest')]
[System.String]
$TrustType,
[Parameter(Mandatory = $true)]
[ValidateSet('Bidirectional', 'Inbound', 'Outbound')]
[System.String]
$TrustDirection,
[Parameter()]
[ValidateSet('Present', 'Absent')]
[System.String]
$Ensure = 'Present'
)
$getTrustTargetAndSourceObject = @{
SourceDomainName = $SourceDomainName
TargetDomainName = $TargetDomainName
TargetDomainAdministratorCredential = $TargetDomainAdministratorCredential
TrustType = $TrustType
}
$trustSource, $trustTarget = Get-TrustSourceAndTargetObject @getTrustTargetAndSourceObject
$compareTargetResourceStateResult = Compare-TargetResourceState @PSBoundParameters
# Get all properties that are not in desired state.
$propertiesNotInDesiredState = $compareTargetResourceStateResult |
Where-Object -FilterScript {
-not $_.InDesiredState
}
if ($propertiesNotInDesiredState.Where({ $_.ParameterName -eq 'Ensure' }))
{
if ($Ensure -eq 'Present')
{
# Create trust.
$trustSource.CreateTrustRelationship($trustTarget, $TrustDirection)
Write-Verbose -Message (
$script:localizedData.AddedTrust -f @(
$SourceDomainName,
$TargetDomainName,
$TrustType,
$TrustDirection
)
)
}
else
{
# Remove trust.
$trustSource.DeleteTrustRelationship($trustTarget)
Write-Verbose -Message (
$script:localizedData.RemovedTrust -f @(
$SourceDomainName,
$TargetDomainName,
$TrustType,
$TrustDirection
)
)
}
}
else
{
if ($Ensure -eq 'Present')
{
$trustRecreated = $false
# Check properties.
$trustTypeProperty = $propertiesNotInDesiredState.Where({ $_.ParameterName -eq 'TrustType' })
if ($trustTypeProperty)
{
Write-Verbose -Message (
$script:localizedData.NeedToRecreateTrust -f @(
$SourceDomainName,
$TargetDomainName,
(ConvertFrom-DirectoryContextType -DirectoryContextType $trustTypeProperty.Actual),
$TrustType
)
)
$trustSource.DeleteTrustRelationship($trustTarget)
$trustSource.CreateTrustRelationship($trustTarget, $TrustDirection)
Write-Verbose -Message (
$script:localizedData.RecreatedTrustType -f @(
$SourceDomainName,
$TargetDomainName,
$TrustType,
$TrustDirection
)
)
$trustRecreated = $true
}
<#
In case the trust direction property should be wrong, there
is no need to update that property twice since it was set
to the correct value when the trust was recreated.
#>
if (-not $trustRecreated)
{
if ($propertiesNotInDesiredState.Where({ $_.ParameterName -eq 'TrustDirection' }))
{
$trustSource.UpdateTrustRelationship($trustTarget, $TrustDirection)
Write-Verbose -Message (
$script:localizedData.SetTrustDirection -f $TrustDirection
)
}
}
Write-Verbose -Message $script:localizedData.InDesiredState
}
else
{
# The trust is already absent, so in desired state.
Write-Verbose -Message $script:localizedData.InDesiredState
}
}
}
<#
.SYNOPSIS
Determines if the properties of the Active Directory trust is in
the desired state.
.PARAMETER SourceDomainName
Specifies the name of the Active Directory domain that is requesting the
trust.
.PARAMETER TargetDomainName
Specifies the name of the Active Directory domain that is being trusted.
.PARAMETER TargetDomainAdministratorCredential
Specifies the credentials to authenticate to the target domain.
.PARAMETER TrustType
Specifies the type of trust. The value 'External' means the context Domain,
while the value 'Forest' means the context 'Forest'.
.PARAMETER TrustDirection
Specifies the direction of the trust.
.PARAMETER Ensure
Specifies whether the computer account is present or absent. Default
value is 'Present'.
#>
function Test-TargetResource
{
[CmdletBinding()]
[OutputType([System.Boolean])]
param
(
[Parameter(Mandatory = $true)]
[System.String]
$SourceDomainName,
[Parameter(Mandatory = $true)]
[System.String]
$TargetDomainName,
[Parameter(Mandatory = $true)]
[System.Management.Automation.PSCredential]
$TargetDomainAdministratorCredential,
[Parameter(Mandatory = $true)]
[ValidateSet('External', 'Forest')]
[System.String]
$TrustType,
[Parameter(Mandatory = $true)]
[ValidateSet('Bidirectional', 'Inbound', 'Outbound')]
[System.String]
$TrustDirection,
[Parameter()]
[ValidateSet('Present', 'Absent')]
[System.String]
$Ensure = 'Present'
)
Write-Verbose -Message (
$script:localizedData.TestConfiguration -f $SourceDomainName, $TargetDomainName, $TrustType
)
<#
This returns array of hashtables which contain the properties ParameterName,
Expected, Actual, and InDesiredState.
#>
$compareTargetResourceStateResult = Compare-TargetResourceState @PSBoundParameters
if ($false -in $compareTargetResourceStateResult.InDesiredState)
{
$testTargetResourceReturnValue = $false
Write-Verbose -Message $script:localizedData.NotInDesiredState
}
else
{
$testTargetResourceReturnValue = $true
Write-Verbose -Message $script:localizedData.InDesiredState
}
return $testTargetResourceReturnValue
}
<#
.SYNOPSIS
Compares the properties in the current state with the properties of the
desired state and returns a hashtable with the comparison result.
.PARAMETER SourceDomainName
Specifies the name of the Active Directory domain that is requesting the
trust.
.PARAMETER TargetDomainName
Specifies the name of the Active Directory domain that is being trusted.
.PARAMETER TargetDomainAdministratorCredential
Specifies the credentials to authenticate to the target domain.
.PARAMETER TrustType
Specifies the type of trust. The value 'External' means the context Domain,
while the value 'Forest' means the context 'Forest'.
.PARAMETER TrustDirection
Specifies the direction of the trust.
.PARAMETER Ensure
Specifies whether the computer account is present or absent. Default
value is 'Present'.
#>
function Compare-TargetResourceState
{
[CmdletBinding()]
param
(
[Parameter(Mandatory = $true)]
[System.String]
$SourceDomainName,
[Parameter(Mandatory = $true)]
[System.String]
$TargetDomainName,
[Parameter(Mandatory = $true)]
[System.Management.Automation.PSCredential]
$TargetDomainAdministratorCredential,
[Parameter(Mandatory = $true)]
[ValidateSet('External', 'Forest')]
[System.String]
$TrustType,
[Parameter(Mandatory = $true)]
[ValidateSet('Bidirectional', 'Inbound', 'Outbound')]
[System.String]
$TrustDirection,
[Parameter()]
[ValidateSet('Present', 'Absent')]
[System.String]
$Ensure = 'Present'
)
$getTargetResourceParameters = @{
SourceDomainName = $SourceDomainName
TargetDomainName = $TargetDomainName
TargetDomainAdministratorCredential = $TargetDomainAdministratorCredential
TrustType = $TrustType
TrustDirection = $TrustDirection
}
$getTargetResourceResult = Get-TargetResource @getTargetResourceParameters
<#
If the desired state should be Absent, then there is no need to
compare properties other than 'Ensure'. If the other properties
would be compared, they would return a false negative during test.
#>
if ($Ensure -eq 'Present')
{
$propertiesToEvaluate = @(
'Ensure'
'TrustType'
'TrustDirection'
)
}
else
{
$propertiesToEvaluate = @(
'Ensure'
)
}
<#
If the user did not specify Ensure property, then it is not part of
the $PSBoundParameters, but it still needs to be compared.
Copy the hashtable $PSBoundParameters and add 'Ensure' property to make
sure it is part of the DesiredValues.
#>
$desiredValues = @{ } + $PSBoundParameters
$desiredValues['Ensure'] = $Ensure
$compareResourcePropertyStateParameters = @{
CurrentValues = $getTargetResourceResult
DesiredValues = $desiredValues
Properties = $propertiesToEvaluate
}
return Compare-ResourcePropertyState @compareResourcePropertyStateParameters
}
<#
.SYNOPSIS
This returns a new object of the type System.DirectoryServices.ActiveDirectory.Domain
which is a class that represents an Active Directory Domain Services domain.
.PARAMETER DirectoryContext
The Active Directory context from which the domain object is returned.
Calling the Get-ADDirectoryContext gets a value that can be provided in
this parameter.
.NOTES
This is a wrapper to enable unit testing of this resource.
see issue https://github.com/PowerShell/xActiveDirectory/issues/324
for more information.
#>
function Get-ActiveDirectoryDomain
{
[CmdletBinding()]
[OutputType([System.DirectoryServices.ActiveDirectory.Domain])]
param
(
[Parameter(Mandatory = $true)]
[System.DirectoryServices.ActiveDirectory.DirectoryContext]
$DirectoryContext
)
return [System.DirectoryServices.ActiveDirectory.Domain]::GetDomain($DirectoryContext)
}
<#
.SYNOPSIS
This returns a new object of the type System.DirectoryServices.ActiveDirectory.Forest
which is a class that represents an Active Directory Domain Services forest.
.PARAMETER DirectoryContext
The Active Directory context from which the forest object is returned.
Calling the Get-ADDirectoryContext gets a value that can be provided in
this parameter.
.NOTES
This is a wrapper to enable unit testing of this resource.
see issue https://github.com/PowerShell/xActiveDirectory/issues/324
for more information.
#>
function Get-ActiveDirectoryForest
{
[CmdletBinding()]
[OutputType([System.DirectoryServices.ActiveDirectory.Forest])]
param
(
[Parameter(Mandatory = $true)]
[System.DirectoryServices.ActiveDirectory.DirectoryContext]
$DirectoryContext
)
return [System.DirectoryServices.ActiveDirectory.Forest]::GetForest($DirectoryContext)
}
<#
.SYNOPSIS
This returns the converted value from a Trust Type value to the correct
Directory Context Type value.
.PARAMETER TrustType
The trust type value to convert.
#>
function ConvertTo-DirectoryContextType
{
[CmdletBinding()]
[OutputType([System.String])]
param
(
[Parameter(Mandatory = $true)]
[System.String]
$TrustType
)
switch ($TrustType)
{
'External'
{
$directoryContextType = 'Domain'
}
'Forest'
{
$directoryContextType = 'Forest'
}
}
return $directoryContextType
}
<#
.SYNOPSIS
This returns the converted value from a Directory Context Type value to
the correct Trust Type value.
.PARAMETER DirectoryContextType
The Directory Context Type value to convert.
#>
function ConvertFrom-DirectoryContextType
{
[CmdletBinding()]
[OutputType([System.String])]
param
(
[Parameter(Mandatory = $true)]
[System.String]
$DirectoryContextType
)
switch ($DirectoryContextType)
{
'Domain'
{
$trustType = 'External'
}
'Forest'
{
$trustType = 'Forest'
}
}
return $trustType
}
<#
.SYNOPSIS
Returns two objects where the first object is for the source domain and
the second object is for the target domain.
.PARAMETER SourceDomainName
Specifies the name of the Active Directory domain that is requesting the
trust.
.PARAMETER TargetDomainName
Specifies the name of the Active Directory domain that is being trusted.
.PARAMETER TargetDomainAdministratorCredential
Specifies the credentials to authenticate to the target domain.
.PARAMETER TrustType
Specifies the type of trust. The value 'External' means the context Domain,
while the value 'Forest' means the context 'Forest'.
.OUTPUTS
For both objects the type returned is either of the type
System.DirectoryServices.ActiveDirectory.Domain or of the type
System.DirectoryServices.ActiveDirectory.Forest.
#>
function Get-TrustSourceAndTargetObject
{
[CmdletBinding()]
[OutputType([System.Object[]])]
param
(
[Parameter(Mandatory = $true)]
[System.String]
$SourceDomainName,
[Parameter(Mandatory = $true)]
[System.String]
$TargetDomainName,
[Parameter(Mandatory = $true)]
[System.Management.Automation.PSCredential]
$TargetDomainAdministratorCredential,
[Parameter(Mandatory = $true)]
[ValidateSet('External', 'Forest')]
[System.String]
$TrustType
)
$directoryContextType = ConvertTo-DirectoryContextType -TrustType $TrustType
# Create the target object.
$getADDirectoryContextParameters = @{
DirectoryContextType = $directoryContextType
Name = $TargetDomainName
Credential = $TargetDomainAdministratorCredential
}
$targetDirectoryContext = Get-ADDirectoryContext @getADDirectoryContextParameters
# Create the source object.
$getADDirectoryContextParameters = @{
DirectoryContextType = $directoryContextType
Name = $SourceDomainName
}
$sourceDirectoryContext = Get-ADDirectoryContext @getADDirectoryContextParameters
if ($directoryContextType -eq 'Domain')
{
$trustSource = Get-ActiveDirectoryDomain -DirectoryContext $sourceDirectoryContext
$trustTarget = Get-ActiveDirectoryDomain -DirectoryContext $targetDirectoryContext
}
else
{
$trustSource = Get-ActiveDirectoryForest -DirectoryContext $sourceDirectoryContext
$trustTarget = Get-ActiveDirectoryForest -DirectoryContext $targetDirectoryContext
}
return $trustSource, $trustTarget
}
Export-ModuleMember -Function *-TargetResource