DSCResources/DSC_UserAccountControl/DSC_UserAccountControl.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 |
$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules' # Import the ComputerManagementDsc Common Modules Import-Module -Name (Join-Path -Path $modulePath ` -ChildPath (Join-Path -Path 'ComputerManagementDsc.Common' ` -ChildPath 'ComputerManagementDsc.Common.psm1')) Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common') # Import Localization Strings $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US' $script:registryKey = 'HKLM:\HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Policies\System' $script:granularUserAccountControlParameterNames = @( 'FilterAdministratorToken' 'ConsentPromptBehaviorAdmin' 'ConsentPromptBehaviorUser' 'EnableInstallerDetection' 'ValidateAdminCodeSignatures' 'EnableLua' 'PromptOnSecureDesktop' 'EnableVirtualization' ) <# .SYNOPSIS Gets the current state of the User Account Control. .PARAMETER IsSingleInstance Specifies the resource is a single instance, the value must be 'Yes'. .PARAMETER SuppressRestart Specifies if a restart of the node should be suppressed. By default the node will be restarted if the value is changed. #> function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( # This is best practice when writing a single-instance DSC resource. [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [System.String] $IsSingleInstance, [Parameter()] [System.Boolean] $SuppressRestart = $false ) Write-Verbose -Message $script:localizedData.GettingStateMessage $userAccountControlValues = Get-UserAccountControl $returnValue = @{ IsSingleInstance = 'Yes' NotificationLevel = Get-NotificationLevel FilterAdministratorToken = $userAccountControlValues.FilterAdministratorToken ConsentPromptBehaviorAdmin = $userAccountControlValues.ConsentPromptBehaviorAdmin ConsentPromptBehaviorUser = $userAccountControlValues.ConsentPromptBehaviorUser EnableInstallerDetection = $userAccountControlValues.EnableInstallerDetection ValidateAdminCodeSignatures = $userAccountControlValues.ValidateAdminCodeSignatures EnableLua = $userAccountControlValues.EnableLua PromptOnSecureDesktop = $userAccountControlValues.PromptOnSecureDesktop EnableVirtualization = $userAccountControlValues.EnableVirtualization SuppressRestart = $SuppressRestart } return $returnValue } <# .SYNOPSIS Sets the current state of the User Account Control. .PARAMETER IsSingleInstance Specifies the resource is a single instance, the value must be 'Yes'. .PARAMETER NotificationLevel Specifies the desired notification level for the User Account Control setting. This parameter can not be used at the same time as any of the granular parameters. .PARAMETER FilterAdministratorToken Specifies the mode for the built-in administrator account (RID 500). .PARAMETER ConsentPromptBehaviorAdmin Specifies the prompt behavior for the Consent Administrator. .PARAMETER ConsentPromptBehaviorUser Specifies how the operations that requires elevation is handled for users. .PARAMETER EnableInstallerDetection Specifies how package installations are handled. .PARAMETER ValidateAdminCodeSignatures Specifies how cryptographic signatures on interactive applications are handled. .PARAMETER EnableLua Specifies how the 'administrator in Admin Approval Mode' user type are handled. .PARAMETER PromptOnSecureDesktop Specifies if secure desktop prompting are used. .PARAMETER EnableVirtualization Specifies how redirection of legacy application File and Registry writes are handled. .PARAMETER SuppressRestart Specifies if a restart of the node should be suppressed. By default the node will be restarted if the value is changed. #> function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [System.String] $IsSingleInstance, [Parameter()] [ValidateSet('AlwaysNotify', 'AlwaysNotifyAndAskForCredentials', 'NotifyChanges', 'NotifyChangesWithoutDimming', 'NeverNotify', 'NeverNotifyAndDisableAll')] [System.String] $NotificationLevel, [Parameter()] [ValidateSet(0, 1)] [System.UInt16] $FilterAdministratorToken, [Parameter()] [ValidateSet(0, 1, 2, 3, 4, 5)] [System.UInt16] $ConsentPromptBehaviorAdmin, [Parameter()] [ValidateSet(0, 1, 3)] [System.UInt16] $ConsentPromptBehaviorUser, [Parameter()] [ValidateSet(0, 1)] [System.UInt16] $EnableInstallerDetection, [Parameter()] [ValidateSet(0, 1)] [System.UInt16] $ValidateAdminCodeSignatures, [Parameter()] [ValidateSet(0, 1)] [System.UInt16] $EnableLua, [Parameter()] [ValidateSet(0, 1)] [System.UInt16] $PromptOnSecureDesktop, [Parameter()] [ValidateSet(0, 1)] [System.UInt16] $EnableVirtualization, [Parameter()] [System.Boolean] $SuppressRestart = $false ) $assertBoundParameterParameters = @{ BoundParameterList = $PSBoundParameters MutuallyExclusiveList1 = @( 'NotificationLevel' ) MutuallyExclusiveList2 = $script:granularUserAccountControlParameterNames } Assert-BoundParameter @assertBoundParameterParameters Write-Verbose -Message $script:localizedData.SettingStateMessage $needRestart = $false $getTargetResourceResult = Get-TargetResource -IsSingleInstance 'Yes' -SuppressRestart $SuppressRestart if ($PSBoundParameters.ContainsKey('NotificationLevel')) { if ($getTargetResourceResult.NotificationLevel -ne $NotificationLevel) { Write-Verbose -Message ( $script:localizedData.SetNotificationLevel -f $NotificationLevel ) Set-UserAccountControlToNotificationLevel -NotificationLevel $NotificationLevel $needRestart = $true } else { Write-Verbose -Message $script:localizedData.NotificationLevelInDesiredState } } else { foreach ($parameterName in $script:granularUserAccountControlParameterNames) { if ($PSBoundParameters.ContainsKey($parameterName) -and $getTargetResourceResult.$parameterName -ne $PSBoundParameters.$parameterName) { Write-Verbose -Message ( $script:localizedData.SetPropertyToValue ` -f $parameterName, $PSBoundParameters.$parameterName ) try { $setItemPropertyParameters = @{ Path = $script:registryKey Name = $parameterName Value = $PSBoundParameters.$parameterName ErrorAction = 'Stop' } Set-ItemProperty @setItemPropertyParameters } catch { New-InvalidOperationException ` -Message ($script:localizedData.FailedToSetGranularProperty -f $parameterName) ` -ErrorRecord $_ } $needRestart = $true } } if (-not $needRestart) { Write-Verbose -Message $script:localizedData.GranularPropertiesInDesiredState } } if ($needRestart) { if ($SuppressRestart) { Write-Warning -Message $script:localizedData.SuppressRestart } else { $global:DSCMachineStatus = 1 } } } <# .SYNOPSIS Tests the current state of the User Account Control. .PARAMETER IsSingleInstance Specifies the resource is a single instance, the value must be 'Yes'. .PARAMETER NotificationLevel Specifies the desired notification level for the User Account Control setting. This parameter can not be used at the same time as any of the granular parameters. .PARAMETER FilterAdministratorToken Specifies the mode for the built-in administrator account (RID 500). .PARAMETER ConsentPromptBehaviorAdmin Specifies the prompt behavior for the Consent Administrator. .PARAMETER ConsentPromptBehaviorUser Specifies how the operations that requires elevation is handled for users. .PARAMETER EnableInstallerDetection Specifies how package installations are handled. .PARAMETER ValidateAdminCodeSignatures Specifies how cryptographic signatures on interactive applications are handled. .PARAMETER EnableLua Specifies how the 'administrator in Admin Approval Mode' user type are handled. .PARAMETER PromptOnSecureDesktop Specifies if secure desktop prompting are used. .PARAMETER EnableVirtualization Specifies how redirection of legacy application File and Registry writes are handled. .PARAMETER SuppressRestart Specifies if a restart of the node should be suppressed. By default the node will be restarted if the value is changed. #> function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [System.String] $IsSingleInstance, [Parameter()] [ValidateSet('AlwaysNotify', 'AlwaysNotifyAndAskForCredentials', 'NotifyChanges', 'NotifyChangesWithoutDimming', 'NeverNotify', 'NeverNotifyAndDisableAll')] [System.String] $NotificationLevel, [Parameter()] [ValidateSet(0, 1)] [System.UInt16] $FilterAdministratorToken, [Parameter()] [ValidateSet(0, 1, 2, 3, 4, 5)] [System.UInt16] $ConsentPromptBehaviorAdmin, [Parameter()] [ValidateSet(0, 1, 3)] [System.UInt16] $ConsentPromptBehaviorUser, [Parameter()] [ValidateSet(0, 1)] [System.UInt16] $EnableInstallerDetection, [Parameter()] [ValidateSet(0, 1)] [System.UInt16] $ValidateAdminCodeSignatures, [Parameter()] [ValidateSet(0, 1)] [System.UInt16] $EnableLua, [Parameter()] [ValidateSet(0, 1)] [System.UInt16] $PromptOnSecureDesktop, [Parameter()] [ValidateSet(0, 1)] [System.UInt16] $EnableVirtualization, [Parameter()] [System.Boolean] $SuppressRestart = $false ) Write-Verbose -Message $script:localizedData.TestingStateMessage $assertBoundParameterParameters = @{ BoundParameterList = $PSBoundParameters MutuallyExclusiveList1 = @( 'NotificationLevel' ) MutuallyExclusiveList2 = $script:granularUserAccountControlParameterNames } Assert-BoundParameter @assertBoundParameterParameters $getTargetResourceResult = Get-TargetResource -IsSingleInstance 'Yes' -SuppressRestart $SuppressRestart if ($PSBoundParameters.ContainsKey('NotificationLevel')) { if ($getTargetResourceResult.NotificationLevel -ne $NotificationLevel) { $testTargetResourceReturnValue = $false Write-Verbose -Message ($script:localizedData.NotificationLevelNoInDesiredState -f $getTargetResourceResult.NotificationLevel, $NotificationLevel) } else { $testTargetResourceReturnValue = $true Write-Verbose -Message $script:localizedData.NotificationLevelInDesiredState } } else { $testTargetResourceReturnValue = $true foreach ($parameterName in $script:granularUserAccountControlParameterNames) { if ($PSBoundParameters.ContainsKey($parameterName) -and $getTargetResourceResult.$parameterName -ne $PSBoundParameters.$parameterName) { $testTargetResourceReturnValue = $false Write-Verbose -Message ($script:localizedData.GranularPropertyNoInDesiredState -f $parameterName, $getTargetResourceResult.$parameterName, $PSBoundParameters.$parameterName) } } if ($testTargetResourceReturnValue) { Write-Verbose -Message $script:localizedData.GranularPropertiesInDesiredState } } return $testTargetResourceReturnValue } <# .SYNOPSIS Gets the current values of the User Account Control registry entries. .OUTPUTS Returns a hashtable containing the values. #> function Get-UserAccountControl { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param () return @{ FilterAdministratorToken = Get-RegistryPropertyValue -Path $script:registryKey -Name 'FilterAdministratorToken' ConsentPromptBehaviorAdmin = Get-RegistryPropertyValue -Path $script:registryKey -Name 'ConsentPromptBehaviorAdmin' ConsentPromptBehaviorUser = Get-RegistryPropertyValue -Path $script:registryKey -Name 'ConsentPromptBehaviorUser' EnableInstallerDetection = Get-RegistryPropertyValue -Path $script:registryKey -Name 'EnableInstallerDetection' ValidateAdminCodeSignatures = Get-RegistryPropertyValue -Path $script:registryKey -Name 'ValidateAdminCodeSignatures' EnableLua = Get-RegistryPropertyValue -Path $script:registryKey -Name 'EnableLUA' PromptOnSecureDesktop = Get-RegistryPropertyValue -Path $script:registryKey -Name 'PromptOnSecureDesktop' EnableVirtualization = Get-RegistryPropertyValue -Path $script:registryKey -Name 'EnableVirtualization' } } <# .SYNOPSIS Gets the current notification level string value. .OUTPUTS Returns the notification level string value. If the registry values does not match a predefined notification level then $null is returned. #> function Get-NotificationLevel { [CmdletBinding()] [OutputType([System.String])] param () $notificationLevelStringValue = $null $userAccountControlValues = Get-UserAccountControl if ($userAccountControlValues.ConsentPromptBehaviorAdmin -eq 2 ` -and $userAccountControlValues.EnableLua -eq 1 ` -and $userAccountControlValues.PromptOnSecureDesktop -eq 1 ) { $notificationLevelStringValue = 'AlwaysNotify' } if ($userAccountControlValues.ConsentPromptBehaviorAdmin -eq 1 ` -and $userAccountControlValues.EnableLua -eq 1 ` -and $userAccountControlValues.PromptOnSecureDesktop -eq 1 ) { $notificationLevelStringValue = 'AlwaysNotifyAndAskForCredentials' } if ($userAccountControlValues.ConsentPromptBehaviorAdmin -eq 5 ` -and $userAccountControlValues.EnableLua -eq 1 ` -and $userAccountControlValues.PromptOnSecureDesktop -eq 1 ) { $notificationLevelStringValue = 'NotifyChanges' } if ($userAccountControlValues.ConsentPromptBehaviorAdmin -eq 5 ` -and $userAccountControlValues.EnableLua -eq 1 ` -and $userAccountControlValues.PromptOnSecureDesktop -eq 0 ) { $notificationLevelStringValue = 'NotifyChangesWithoutDimming' } if ($userAccountControlValues.ConsentPromptBehaviorAdmin -eq 0 ` -and $userAccountControlValues.EnableLua -eq 1 ` -and $userAccountControlValues.PromptOnSecureDesktop -eq 0 ) { $notificationLevelStringValue = 'NeverNotify' } if ($userAccountControlValues.ConsentPromptBehaviorAdmin -eq 0 ` -and $userAccountControlValues.EnableLua -eq 0 ` -and $userAccountControlValues.PromptOnSecureDesktop -eq 0 ) { $notificationLevelStringValue = 'NeverNotifyAndDisableAll' } return $notificationLevelStringValue } <# .SYNOPSIS Gets the current notification level string value. .OUTPUTS Returns the notification level string value. If the registry values does not match a predefined notification level then $null is returned. #> function Set-UserAccountControlToNotificationLevel { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateSet('AlwaysNotify', 'AlwaysNotifyAndAskForCredentials', 'NotifyChanges', 'NotifyChangesWithoutDimming', 'NeverNotify', 'NeverNotifyAndDisableAll')] [System.String] $NotificationLevel ) try { $defaultSetItemPropertyParameters = @{ Path = $script:registryKey ErrorAction = 'Stop' } switch ($NotificationLevel) { 'AlwaysNotify' { Set-ItemProperty @defaultSetItemPropertyParameters -Name 'ConsentPromptBehaviorAdmin' -Value 2 Set-ItemProperty @defaultSetItemPropertyParameters -Name 'EnableLUA' -Value 1 Set-ItemProperty @defaultSetItemPropertyParameters -Name 'PromptOnSecureDesktop' -Value 1 } 'AlwaysNotifyAndAskForCredentials' { Set-ItemProperty @defaultSetItemPropertyParameters -Name 'ConsentPromptBehaviorAdmin' -Value 1 Set-ItemProperty @defaultSetItemPropertyParameters -Name 'EnableLUA' -Value 1 Set-ItemProperty @defaultSetItemPropertyParameters -Name 'PromptOnSecureDesktop' -Value 1 } 'NotifyChanges' { Set-ItemProperty @defaultSetItemPropertyParameters -Name 'ConsentPromptBehaviorAdmin' -Value 5 Set-ItemProperty @defaultSetItemPropertyParameters -Name 'EnableLUA' -Value 1 Set-ItemProperty @defaultSetItemPropertyParameters -Name 'PromptOnSecureDesktop' -Value 1 } 'NotifyChangesWithoutDimming' { Set-ItemProperty @defaultSetItemPropertyParameters -Name 'ConsentPromptBehaviorAdmin' -Value 5 Set-ItemProperty @defaultSetItemPropertyParameters -Name 'EnableLUA' -Value 1 Set-ItemProperty @defaultSetItemPropertyParameters -Name 'PromptOnSecureDesktop' -Value 0 } 'NeverNotify' { Set-ItemProperty @defaultSetItemPropertyParameters -Name 'ConsentPromptBehaviorAdmin' -Value 0 Set-ItemProperty @defaultSetItemPropertyParameters -Name 'EnableLUA' -Value 1 Set-ItemProperty @defaultSetItemPropertyParameters -Name 'PromptOnSecureDesktop' -Value 0 } 'NeverNotifyAndDisableAll' { Set-ItemProperty @defaultSetItemPropertyParameters -Name 'ConsentPromptBehaviorAdmin' -Value 0 Set-ItemProperty @defaultSetItemPropertyParameters -Name 'EnableLUA' -Value 0 Set-ItemProperty @defaultSetItemPropertyParameters -Name 'PromptOnSecureDesktop' -Value 0 } } } catch { New-InvalidOperationException ` -Message ($script:localizedData.FailedToSetNotificationLevel -f $NotificationLevel) ` -ErrorRecord $_ } } |