Functions/Get-CCPCredential.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 |
function Get-CCPCredential { <# .SYNOPSIS Use the GetPassword REST Web Service to retrieve passwords from the CyberArk AAM Central Credential Provider. .DESCRIPTION When the AAM Central Credential Provider for Windows is published via IIS and the Central Credential Provider Web Service, this function can be used to retrieve credentials. Passwords stored in the CyberArk Vault are retrieved to the Central Credential Provider, where they can be accessed by authorized remote applications/scripts using a web service call. .PARAMETER AppID Specifies the unique ID of the application issuing the password request. .PARAMETER Safe Specifies the name of the Safe where the password is stored. .PARAMETER Folder Specifies the name of the folder where the password is stored. .PARAMETER Object Specifies the name of the password object to retrieve. .PARAMETER UserName Defines search criteria according to the UserName account property. .PARAMETER Address Defines search criteria according to the Address account property. .PARAMETER Database Defines search criteria according to the Database account property. .PARAMETER PolicyID Defines the format that will be used in the set PolicyID method. .PARAMETER Reason The reason for retrieving the password. This reason will be audited in the Credential Provider audit log .PARAMETER Query A query value to be specified in the URL to filter the result. .PARAMETER ConnectionTimeout The number of seconds that the Central Credential Provider will try to retrieve the password. The timeout is calculated when the request is sent from the web service to the Vault and returned back to the web service. .PARAMETER Credential Specify the credentials object if OS User authentication is required for an AAM CCP Application. Enter a PSCredential object generated by the Get-Credential cmdlet. .PARAMETER UseDefaultCredentials Indicates that the the credentials of the current user are used for CCP OS User authentication. This can't be used with the Credential parameter and may not be supported on all platforms. .PARAMETER Certificate Specifies the client certificate from a local storethat is used for the AIMWebService request. Enter a variable that contains a certificate or a command or expression that gets the certificate. To find a certificate, use Get-PfxCertificate or use the Get-ChildItem cmdlet in the Certificate (Cert:) drive. .PARAMETER CertificateThumbPrint Enter the certificate thumbprint of the certificate. To get a certificate thumbprint, use the Get-Item or Get-ChildItem command in the PowerShell Cert: drive. .PARAMETER WebServiceName The name the CCP WebService is configured under in IIS. Defaults to AIMWebService .PARAMETER URL The URL for the CCP Host .PARAMETER SkipCertificateCheck Skips certificate validation checks. Using this parameter is not secure and is not recommended. This switch is only intended to be used against known hosts using a self-signed certificate for testing purposes. Use at your own risk. .EXAMPLE Get-CCPCredential -AppID PSScript -Safe PSAccounts -Object PSPlatform-AccountName -URL https://cyberark.yourcompany.com Uses the PSScript App ID to retrieve password for the PSPlatform-AccountName object in the PSAccounts safe from the https://cyberark.yourcompany.com/AIMWebService CCP Web Service. .EXAMPLE Get-CCPCredential -AppID PowerShell -Safe PSAccounts -UserName svc-psProvision -WebServiceName DevAIM -URL https://cyberark-dev.yourcompany.com Uses the PowerShell App ID to search for and retrieve the password for the svc-psProvision account in the PSAccounts safe from the https://cyberark-dev.yourcompany.com/DevAIM CCP Web Service. .EXAMPLE $result = Get-CCPCredential -AppID PS -Safe PS -Object PSP-AccountName -URL https://cyberark.yourcompany.com $result.ToSecureSting() Returns the password retrieved from CCP as a Secure String .EXAMPLE $result = Get-CCPCredential -AppID PS -Safe PS -Object PSP-AccountName -URL https://cyberark.yourcompany.com $result.ToCredential() Returns the username & password retrieved from CCP as a PSCredential object .EXAMPLE Get-CCPCredential -AppID PS -Safe PS -Object PSP-AccountName -URL https://cyberark.yourcompany.com -UseDefaultCredentials Calls Invoke-RestMethod with the UseDefaultCredentials switch to use OS User authentication .EXAMPLE Get-CCPCredential -AppID PS -Safe PS -Object PSP-AccountName -URL https://cyberark.yourcompany.com -Credential $creds Calls Invoke-RestMethod with the supplied Credentials for OS User authentication .EXAMPLE Get-CCPCredential -AppID PS -Safe PS -Object PSP-AccountName -URL https://cyberark.yourcompany.com -CertificateThumbPrint $Cert_ThumbPrint Calls Invoke-RestMethod with the supplied Certificate thumbprint .EXAMPLE Get-CCPCredential -AppID PS -Safe PS -Object PSP-AccountName -URL https://cyberark.yourcompany.com -Certificate $Cert Calls Invoke-RestMethod with the supplied Certificate for Certificate authentication .EXAMPLE Get-CCPCredential -Query 'AppID=PS&Object=PSP-AccountName&Safe=PS&QueryFormat=Exact' -URL https://cyberark.yourcompany.com Calls Invoke-RestMethod with a prepared query string .EXAMPLE Get-CCPCredential -Query 'AppID=PS&Object=PSP-AccountName&Safe=PS;CustomFileCategoryName1=Yourcompany Data' -URL https://cyberark.yourcompany.com Calls Invoke-RestMethod with a prepared query string that includes a custom file category and a space #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '', Justification = 'Suppress alert from ToSecureString ScriptMethod')] [CmdletBinding(DefaultParameterSetName = 'Default')] Param( # Unique ID of the application [Parameter( Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [string] $AppID, # Safe name [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [string] $Safe, # Folder name [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [string] $Folder, # Object name [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [string] $Object, # Search username [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [string] $UserName, # Search address [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [string] $Address, # Search database [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [string] $Database, # SetPolicyID format [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [string] $PolicyID, # Reason to record in audit log [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [string] $Reason, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Query' )] [string] $Query, # Number of seconds to try [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Query' )] [int] $ConnectionTimeout, # Credentials to send in request to CCP [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Query' )] [ValidateNotNullOrEmpty()] [PSCredential] $Credential, # Use current system credentials for request to CCP [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Query' )] [Switch] $UseDefaultCredentials, # Use certificate to authenticate to CCP [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Query' )] [X509Certificate] $Certificate, # Use certificate to authenticate to CCP [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Query' )] [string] $CertificateThumbPrint, # Unique ID of the CCP webservice in IIS [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Query' )] [string] $WebServiceName = 'AIMWebService', # CCP URL [Parameter( Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Default' )] [Parameter( Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'Query' )] [string] $URL, [parameter( Mandatory = $false, ValueFromPipeline = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Default' )] [parameter( Mandatory = $false, ValueFromPipeline = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Query' )] [switch]$SkipCertificateCheck ) Begin { #Collection of parameters which are to be excluded from the request URL [array]$CommonParameters += [System.Management.Automation.PSCmdlet]::CommonParameters [array]$CommonParameters += [System.Management.Automation.PSCmdlet]::OptionalCommonParameters [array]$CommonParameters += 'URL', 'WebServiceName', 'Credential', 'UseDefaultCredentials', 'CertificateThumbPrint', 'Certificate', 'SkipCertificateCheck' #If Tls12 Security Protocol is available if (([Net.SecurityProtocolType].GetEnumNames() -contains 'Tls12') -and #And Tls12 is not already in use (-not ([System.Net.ServicePointManager]::SecurityProtocol -match 'Tls12'))) { #Use Tls12 Write-Verbose 'Setting Security Protocol to TLS12' [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 } } Process { Switch -Regex ($($PSCmdlet.ParameterSetName)) { 'Query' { $QueryString = $Query break } default { [array]$QueryArgs = @() #Enumerate bound parameters to build query string for URL $PSBoundParameters.keys | Where-Object { $CommonParameters -notcontains $_ } | ForEach-Object { $QueryArgs += "$_=$([System.Uri]::EscapeDataString($PSBoundParameters[$_]))" } #Format URL query string $QueryString = $QueryArgs -join '&' } } #Create hashtable of request parameters $Request = @{ 'URI' = "$URL/$WebServiceName/api/Accounts?$QueryString" 'Method' = 'GET' 'ContentType' = 'application/json' 'ErrorAction' = 'Stop' 'ErrorVariable' = 'RequestError' 'UseBasicParsing' = $true } #Add authentication parameters to request Switch ($($PSBoundParameters.keys)) { { $PSItem -contains 'Credential' } { $Request['Credential'] = $Credential } { $PSItem -contains 'UseDefaultCredentials' } { $Request['UseDefaultCredentials'] = $true } { $PSItem -contains 'CertificateThumbPrint' } { $Request['CertificateThumbPrint'] = $CertificateThumbPrint } { $PSItem -contains 'Certificate' } { $Request['Certificate'] = $Certificate } } #in PSCore Use SslProtocol TLS1.2 & SkipCertificateCheck parameter if ($PSEdition -eq 'Core') { $Request.Add('SslProtocol', 'TLS12') $Request.Add('SkipCertificateCheck', $SkipCertificateCheck.IsPresent) } elseif ($SkipCertificateCheck) { #Skip SSL Validation Skip-CertificateCheck } Try { #send request $result = Invoke-RestMethod @Request } Catch { try { $err = $_ | ConvertFrom-Json -ErrorAction Stop $ErrorMessage = $err.ErrorMsg $ErrorID = $err.ErrorCode } catch { $ErrorMessage = $RequestError.ErrorRecord.Exception $ErrorID = $RequestError.ErrorRecord.FullyQualifiedErrorId } Finally { #throw the error $PSCmdlet.ThrowTerminatingError( [System.Management.Automation.ErrorRecord]::new( $ErrorMessage, $ErrorID, [System.Management.Automation.ErrorCategory]::NotSpecified, $PSItem ) ) } } Finally { if ($null -ne $result) { #Add ScriptMethod to output object to convert password to Secure String $result | Add-Member -MemberType ScriptMethod -Name ToSecureString -Value { $this.Content | ConvertTo-SecureString -AsPlainText -Force } -Force #Add ScriptMethod to output object to convert username & password to Credential Object $result | Add-Member -MemberType ScriptMethod -Name ToCredential -Value { New-Object System.Management.Automation.PSCredential($this.UserName, $this.ToSecureString()) } -Force #Return the result from CCP $result } } } End { } } |