DSCResources/xDSCVault_ADDomain/xDSCVault_ADDomain.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
# User name and password needed for this resource and Write-Verbose Used in helper functions
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingUserNameAndPassWordParams', '')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSDSCUseVerboseMessageInDSCResource', '')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '')]
param ()
$errorActionPreference = 'Stop'

Import-Module -Name (Join-Path -Path (Split-Path -Path $PSScriptRoot -Parent) `
-ChildPath 'CommonResourceHelper.psm1')

# Localized messages for verbose and error statements in this resource
$script:localizedData = Get-LocalizedData -ResourceName 'xDSCVault_ADDomain'

<#
    .SYNOPSIS
    Retrieves the name of the file that tracks the status of the xADDomain resource with the
    specified domain name.
 
    .PARAMETER DomainName
    The domain name of the xADDomain resource to retrieve the tracking file name of.
 
    .NOTES
    The tracking file is currently output to the environment's temp directory.
         
    This file is NOT removed when a configuration completes, so if another call to a xADDomain
    resource with the same domain name occurs in the same environment, this file will already
    be present.
         
    This is so that when another call is made to the same resource, the resource will not
    attempt to promote the machine to a domain controller again (which would cause an error).
         
    If the resource should be promoted to a domain controller once again, you must first remove
    this file from the environment's temp directory (usually C:\Temp).
 
    If in the future this functionality needs to change so that future configurations are not
    affected, $env:temp should be changed to the resource's cache location which is removed
    after each configuration.
    ($env:systemRoot\system32\Configuration\BuiltinProvCache\MSFT_xADDomain)
#>

function Get-TrackingFilename
{
  [OutputType([String])]
  [CmdletBinding()]
  param(
    [Parameter(Mandatory = $true)]
    [String]
    $DomainName
  )

  return Join-Path -Path ($env:temp) -ChildPath ('{0}.xADDomain.completed' -f $DomainName)
}

function Get-TargetResource
{
  [OutputType([System.Collections.Hashtable])]
  param
  (
    [parameter(Mandatory = $true)]
    [System.String]
    $VaultAddress,

    [System.String]
    $ApiPrefix = 'v1',

    [Parameter(Mandatory)]
    [System.String] $DomainName,

    [parameter(Mandatory = $true)]
    [System.String]
    $DomainAdministratorUsername,

    [parameter(Mandatory = $true)]
    [System.String]
    $DomainAdministratorVaultPath,

    [parameter(Mandatory = $true)]
    [System.String]
    $SafemodeAdministratorPasswordVaultPath,

    [Parameter()] [ValidateNotNullOrEmpty()]
    [System.String] $ParentDomainName,

    [Parameter()] [ValidateNotNullOrEmpty()]
    [System.String] $DomainNetBIOSName,

    [System.String]
    $DnsDelegationUserName,

    [System.String]
    $DnsDelegationVaultPath,

    [Parameter()] [ValidateNotNullOrEmpty()]
    [System.String] $DatabasePath,

    [Parameter()] [ValidateNotNullOrEmpty()]
    [System.String] $LogPath,

    [Parameter()] [ValidateNotNullOrEmpty()]
    [System.String] $SysvolPath,

    [System.String]
    $AuthBackend = 'approle'
  )
    
  Assert-Module -ModuleName 'ADDSDeployment'
  $domainFQDN = Resolve-DomainFQDN -DomainName $DomainName -ParentDomainName $ParentDomainName
  $isDomainMember = Test-DomainMember

  $clientToken = Start-VaultAuth -VaultAddress $VaultAddress -ApiPrefix $ApiPrefix -AuthBackend $AuthBackend
  $currentVaultValue = Read-VaultData -VaultAddress $VaultAddress -ClientToken $clientToken.auth.client_token -VaultPath $DomainAdministratorVaultPath
  $VaultValue = ConvertTo-SecureString -String $currentVaultValue.data.value -AsPlainText -Force
  $DomainAdministratorCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList (("$DomainName" + '\' + "$DomainAdministratorUsername"), $VaultValue)

  if ($clientToken.auth.client_token -ne $null) 
  {
    $clientTokenResult = ConvertTo-SecureString -String $clientToken.auth.client_token -AsPlainText -Force
  }
  else 
  {
    $clientTokenResult = 'Error obtaining client token'
  }
    
  if ($currentVaultValue -ne 404) 
  {
    $currentVaultValueOutput = ConvertTo-SecureString -String $currentVaultValue -AsPlainText -Force
  }
  else 
  {
    $currentVaultValueOutput = 'No value retrieved'
  }
    
  if ($currentVaultValue -eq 404) 
  {
    $readResult = $currentVaultValue
  }
  else 
  {
    $readResult = 200
  }
    
  $retries = 0
  $maxRetries = 5
  $retryIntervalInSeconds = 30
  $domainShouldExist = (Test-Path (Get-TrackingFilename -DomainName $DomainName))
  do
  {            
    try
    {
      if ($isDomainMember)
      {
        ## We're already a domain member, so take the credentials out of the equation
        Write-Verbose -Message ($localizedData.QueryDomainADWithLocalCredentials -f $domainFQDN)
        $domain = Get-ADDomain -Identity $domainFQDN -ErrorAction Stop
      }
      else
      {
        Write-Verbose -Message ($localizedData.QueryDomainWithCredential -f $domainFQDN)
        $domain = Get-ADDomain -Identity $domainFQDN -Credential $DomainAdministratorCredential -ErrorAction Stop
      }

      ## No need to check whether the node is actually a domain controller. If we don't throw an exception,
      ## the domain is already UP - and this resource shouldn't run. Domain controller functionality
      ## should be checked by the xADDomainController resource?
      Write-Verbose -Message ($localizedData.DomainFound -f $domain.DnsRoot)
        
      $targetResource = @{
        DomainName                             = $domain.DnsRoot
        ParentDomainName                       = $domain.ParentDomain
        DomainNetBIOSName                      = $domain.NetBIOSName
        VaultAddress                           = $VaultAddress
        ClientToken                            = $clientTokenResult
        CurrentVaultValue                      = $currentVaultValueOutput
        ReadResultStatus                       = $readResult
        AuthBackend                            = $AuthBackend
        SysvolPath                             = $SysvolPath
        SafemodeAdministratorPasswordVaultPath = ($VaultAddress + '/' + $ApiPrefix + '/' + $SafemodeAdministratorPasswordVaultPath)
        LogPath                                = $LogPath
        DomainAdministratorVaultPath           = ($VaultAddress + '/' + $ApiPrefix + '/' + $DomainAdministratorVaultPath)
        ApiPrefix                              = $ApiPrefix
        DatabasePath                           = $DatabasePath
        DnsDelegationUserName                  = $DnsDelegationUserName
        DnsDelegationVaultPath                 = ($VaultAddress + '/' + $ApiPrefix + '/' + $DnsDelegationVaultPath)
      }
        
      return $targetResource
    }
    catch [Microsoft.ActiveDirectory.Management.ADIdentityNotFoundException]
    {
      $errorMessage = $localizedData.ExistingDomainMemberError -f $DomainName
      ThrowInvalidOperationError -ErrorId 'xADDomain_DomainMember' -ErrorMessage $errorMessage
    }
    catch [Microsoft.ActiveDirectory.Management.ADServerDownException]
    {
      Write-Verbose -Message ($localizedData.DomainNotFound -f $domainFQDN)
      $domain = @{ }
      # will fall into retry mechanism
    }
    catch [System.Security.Authentication.AuthenticationException]
    {
      $errorMessage = $localizedData.InvalidCredentialError -f $DomainName
      ThrowInvalidOperationError -ErrorId 'xADDomain_InvalidCredential' -ErrorMessage $errorMessage
    }
    catch
    {
      $errorMessage = $localizedData.UnhandledError -f ($_.Exception |
        Format-List -Force |
      Out-String)
      Write-Verbose -Message $errorMessage

      if ($domainShouldExist -and ($_.Exception.InnerException -is [System.ServiceModel.FaultException]))
      {
        Write-Verbose -Message $localizedData.FaultExceptionAndDomainShouldExist
        # will fall into retry mechanism
      }
      else
      {
        ## Not sure what's gone on here!
        throw $_
      }
    }

    if ($domainShouldExist)
    {
      $retries++
      Write-Verbose -Message ($localizedData.RetryingGetADDomain -f $retries, $maxRetries, $retryIntervalInSeconds)
      Start-Sleep -Seconds ($retries * $retryIntervalInSeconds)
    }
  }
  while ($domainShouldExist -and ($retries -le $maxRetries) )
} #end function Get-TargetResource

function Test-TargetResource
{
  [OutputType([System.Boolean])]
  param
  (
    [parameter(Mandatory = $true)]
    [System.String]
    $VaultAddress,

    [System.String]
    $ApiPrefix = 'v1',

    [Parameter(Mandatory)]
    [System.String] $DomainName,

    [parameter(Mandatory = $true)]
    [System.String]
    $DomainAdministratorUsername,

    [parameter(Mandatory = $true)]
    [System.String]
    $DomainAdministratorVaultPath,

    [parameter(Mandatory = $true)]
    [System.String]
    $SafemodeAdministratorPasswordVaultPath,

    [Parameter()] [ValidateNotNullOrEmpty()]
    [System.String] $ParentDomainName,

    [Parameter()] [ValidateNotNullOrEmpty()]
    [System.String] $DomainNetBIOSName,

    [System.String]
    $DnsDelegationUserName,

    [System.String]
    $DnsDelegationVaultPath,

    [Parameter()] [ValidateNotNullOrEmpty()]
    [System.String] $DatabasePath,

    [Parameter()] [ValidateNotNullOrEmpty()]
    [System.String] $LogPath,

    [Parameter()] [ValidateNotNullOrEmpty()]
    [System.String] $SysvolPath,

    [System.String]
    $AuthBackend = 'approle'
  )

  $targetResource = Get-TargetResource @PSBoundParameters
  $isCompliant = $true

  ## The Get-Target resource returns .DomainName as the domain's FQDN. Therefore, we
  ## need to resolve this before comparison.
  $domainFQDN = Resolve-DomainFQDN -DomainName $DomainName -ParentDomainName $ParentDomainName
  if ($domainFQDN -ne $targetResource.DomainName)
  {
    $message = $localizedData.ResourcePropertyValueIncorrect -f 'DomainName', $domainFQDN, $targetResource.DomainName
    Write-Verbose -Message $message
    $isCompliant = $false   
  }
    
  $propertyNames = @('ParentDomainName', 'DomainNetBIOSName')
  foreach ($propertyName in $propertyNames)
  {
    if ($PSBoundParameters.ContainsKey($propertyName))
    {
      $propertyValue = (Get-Variable -Name $propertyName).Value
      if ($targetResource.$propertyName -ne $propertyValue)
      {
        $message = $localizedData.ResourcePropertyValueIncorrect -f $propertyName, $propertyValue, $targetResource.$propertyName
        Write-Verbose -Message $message
        $isCompliant = $false        
      }
    }
  }
        
  if ($isCompliant)
  {
    Write-Verbose -Message ($localizedData.ResourceInDesiredState -f $domainFQDN)
    return $true
  }
  else
  {
    Write-Verbose -Message ($localizedData.ResourceNotInDesiredState -f $domainFQDN)
    return $false
  }
} #end function Test-TargetResource

function Set-TargetResource
{
  param
  (
    [parameter(Mandatory = $true)]
    [System.String]
    $VaultAddress,

    [System.String]
    $ApiPrefix = 'v1',
    
    [Parameter(Mandatory)]
    [System.String] $DomainName,

    [parameter(Mandatory = $true)]
    [System.String]
    $DomainAdministratorUsername,

    [parameter(Mandatory = $true)]
    [System.String]
    $DomainAdministratorVaultPath,

    [parameter(Mandatory = $true)]
    [System.String]
    $SafemodeAdministratorPasswordVaultPath,

    [Parameter()] [ValidateNotNullOrEmpty()]
    [System.String] $ParentDomainName,

    [Parameter()] [ValidateNotNullOrEmpty()]
    [System.String] $DomainNetBIOSName,

    [System.String]
    $DnsDelegationUserName,

    [System.String]
    $DnsDelegationVaultPath,

    [Parameter()] [ValidateNotNullOrEmpty()]
    [System.String] $DatabasePath,

    [Parameter()] [ValidateNotNullOrEmpty()]
    [System.String] $LogPath,

    [Parameter()] [ValidateNotNullOrEmpty()]
    [System.String] $SysvolPath,

    [System.String]
    $AuthBackend = 'approle'
  )

  # Debug can pause Install-ADDSForest/Install-ADDSDomain, so we remove it.
  [ref] $null = $PSBoundParameters.Remove('Debug')
  ## Not entirely necessary, but run Get-TargetResouece to ensure we raise any pre-flight errors.
  $targetResource = Get-TargetResource @PSBoundParameters

  if ($targetResource.ClientToken.GetType().Name -eq 'SecureString')
  {
    Write-Verbose -Message ($script:localizedData.DecryptingClientTokenSecureString)
    $clientToken = [System.Runtime.InteropServices.marshal]::PtrToStringAuto([System.Runtime.InteropServices.marshal]::SecureStringToBSTR($targetResource.ClientToken)) 
  }
  else
  {
    Write-Error -Message ($script:localizedData.ClientTokenMissing)
  }

  $currentVaultValue = Read-VaultData -VaultAddress $VaultAddress -ClientToken $clientToken.auth.client_token -VaultPath $SafemodeAdministratorPasswordVaultPath
  $VaultValue = ConvertTo-SecureString -String $currentVaultValue.data.value -AsPlainText -Force
  $SafemodeAdministratorPassword = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList ('SafeModePlaceHolderUser', $VaultValue)

  $installADDSParams = @{
    SafeModeAdministratorPassword = $SafemodeAdministratorPassword.Password
    NoRebootOnCompletion          = $true
    Force                         = $true
  }
    
  if ($PSBoundParameters.ContainsKey('DnsDelegationVaultPath'))
  {
    $currentVaultValue = Read-VaultData -VaultAddress $VaultAddress -ClientToken $clientToken.auth.client_token -VaultPath $SafemodeAdministratorPasswordVaultPath
    $VaultValue = ConvertTo-SecureString -String $currentVaultValue.data.value -AsPlainText -Force
    $DnsDelegationCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList ($DnsDelegationUserName, $VaultValue)
    $installADDSParams['DnsDelegationCredential'] = $DnsDelegationCredential
    $installADDSParams['CreateDnsDelegation'] = $true
  }
  if ($PSBoundParameters.ContainsKey('DatabasePath'))
  {
    $installADDSParams['DatabasePath'] = $DatabasePath
  }
  if ($PSBoundParameters.ContainsKey('LogPath'))
  {
    $installADDSParams['LogPath'] = $LogPath
  }
  if ($PSBoundParameters.ContainsKey('SysvolPath'))
  {
    $installADDSParams['SysvolPath'] = $SysvolPath
  }
    
  if ($PSBoundParameters.ContainsKey('ParentDomainName'))
  {
    $currentVaultValue = Read-VaultData -VaultAddress $VaultAddress -ClientToken $clientToken.auth.client_token -VaultPath $DomainAdministratorUsername
    $VaultValue = ConvertTo-SecureString -String $currentVaultValue.data.value -AsPlainText -Force
    $DomainAdministratorCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList ($DomainAdministratorUsername, $VaultValue)    
    Write-Verbose -Message ($localizedData.CreatingChildDomain -f $DomainName, $ParentDomainName)
    $installADDSParams['Credential'] = $DomainAdministratorCredential
    $installADDSParams['NewDomainName'] = $DomainName
    $installADDSParams['ParentDomainName'] = $ParentDomainName
    $installADDSParams['DomainType'] = 'ChildDomain'
    if ($PSBoundParameters.ContainsKey('DomainNetBIOSName'))
    {
      $installADDSParams['NewDomainNetbiosName'] = $DomainNetBIOSName
    }
    Install-ADDSDomain @installADDSParams
    Write-Verbose -Message ($localizedData.CreatedChildDomain)
  }
  else
  {
    Write-Verbose -Message ($localizedData.CreatingForest -f $DomainName)
    $installADDSParams['DomainName'] = $DomainName
    if ($PSBoundParameters.ContainsKey('DomainNetbiosName'))
    {
      $installADDSParams['DomainNetbiosName'] = $DomainNetBIOSName
    }
    Install-ADDSForest @installADDSParams
    Write-Verbose -Message ($localizedData.CreatedForest -f $DomainName) 
  }  

  'Finished' | Out-File -FilePath (Get-TrackingFilename -DomainName $DomainName) -Force

  # Signal to the LCM to reboot the node to compensate for the one we
  # suppressed from Install-ADDSForest/Install-ADDSDomain
  $global:DSCMachineStatus = 1
} #end function Set-TargetResource

## Import the common AD functions
$adCommonFunctions = Join-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -ChildPath '\MSFT_xADCommon\MSFT_xADCommon.ps1'
. $adCommonFunctions

Export-ModuleMember -Function *-TargetResource