Functions/Authentication/New-PASSession.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
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
function New-PASSession {
    <#
    .SYNOPSIS
    Authenticates a user to CyberArk Vault/API.

    .DESCRIPTION
    Authenticates a user to a CyberArk Vault and stores an authentication token and a webrequest session object
    which are used in subsequent calls to the API.
    In addition, this method allows you to set a new password.
    Will attempt authentication against the V10 API by default.
    For older CyberArk versions, specify the -UseClassicAPI switch parameter to force use of the V9 API endpoint.
    Windows authentication is only supported (from CyberArk 10.4+).
    Authenticate using CyberArk, LDAP, RADIUS, SAML or Shared authentication (From CyberArk version 9.7+),
    For CyberArk version older than 9.7:
        Only CyberArk Authentication method is supported.
        newPassword Parameter is not supported.
        useRadiusAuthentication Parameter is not supported.
        connectionNumber Parameter is not supported.

    .PARAMETER Credential
    A Valid PSCredential object.

    .PARAMETER UseClassicAPI
    Specify the UseClassicAPI to send the authentication request via the Classic (v9) API endpoint.

    .PARAMETER newPassword
    Optional parameter, enables you to change a CyberArk users password.
    Must be supplied as a SecureString (Not Plain Text).

    .PARAMETER SAMLToken
    SAML token that identifies the session, encoded in BASE 64.

    .PARAMETER UseSharedAuthentication
    Specify the UseSharedAuthentication switch to use the Shared Authentication API endpoint to logon

    .PARAMETER useRadiusAuthentication
    Whether or not users will be authenticated via a RADIUS server.

    .PARAMETER type
    When using the version 10 API endpoint, specify the type of authentication to use.
    Valid values are CyberArk, LDAP, Windows or RADIUS
    Windows is only a valid option for version 10.4 onward.

    .PARAMETER OTP
    One Time Passcode for RADIUS authentication.

    .PARAMETER OTPMode
    Specify if OTP is to be sent in 'Append' (appended to the password) or 'Challenge' mode (sent in response to RADIUS Challenge).

    .PARAMETER OTPDelimiter
    The character to use as a delimiter when appending the OTP to the password. Defaults to comma ",".

    .PARAMETER RadiusChallenge
    Specify if Radius challenge is satisfied by 'OTP' or 'Password'.
    If "OTP" (Default), Password will be sent first, with OTP as the challenge response.
    If "Password", then OTP value will be sent first, and Password will be sent as the challenge response.

    .PARAMETER connectionNumber
    In order to allow more than one connection for the same user simultaneously, each request
    should be sent with different 'connectionNumber'.
    Valid values: 1-100

    .PARAMETER SkipVersionCheck
    If the SkipVersionCheck switch is specified, Get-PASServer will not be called after
    successfully authenticating. Get-PASServer is not supported before version 9.7.

    .PARAMETER BaseURI
    A string containing the base web address to send te request to.
    Pass the portion the PVWA HTTP address.
    Do not include "/PasswordVault/"

    .PARAMETER PVWAAppName
    The name of the CyberArk PVWA Virtual Directory.
    Defaults to PasswordVault

    .PARAMETER UseDefaultCredentials
    See Invoke-WebRequest
    Uses the credentials of the current user to send the web request

    .PARAMETER CertificateThumbprint
    See Invoke-WebRequest
    The thumbprint of the certificate to use for client certificate authentication.

    .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
    New-PASSession -Credential $cred -BaseURI https://PVWA -type LDAP

    Logon to Version 10 with LDAP credential

    .EXAMPLE
    New-PASSession -Credential $cred -BaseURI https://PVWA -type CyberArk

    Logon to Version 10 with CyberArk credential

    .EXAMPLE
    New-PASSession -BaseURI https://PVWA -UseDefaultCredentials

    Logon to Version 10 with Windows Integrated Authentication

    .EXAMPLE
    New-PASSession -Credential $cred -BaseURI https://PVWA -UseClassicAPI

    Logon to Version 9 with credential
    Request would be sent to PVWA URL https://PVWA/PasswordVault/

    .EXAMPLE
    New-PASSession -Credential $cred -BaseURI https://PVWA -PVWAAppName CustomVault -UseClassicAPI

    Logon to Version 9 where PVWA Virtual Directory has non-default name
    Request would be sent to PVWA URL https://PVWA/CustomVault/

    .EXAMPLE
    New-PASSession -UseSharedAuthentication -BaseURI https://PVWA.domain.com

    Gets authorisation token by authenticating to a CyberArk Vault using shared authentication.

    .EXAMPLE
    New-PASSession -SAMLToken $SAMLToken -BaseURI https://PVWA.domain.com

    Authenticates to a CyberArk Vault using SAML authentication.

    .EXAMPLE
    New-PASSession -Credential $cred -BaseURI https://PVWA -type RADIUS

    Logon to Version 10 using RADIUS

    .EXAMPLE
    New-PASSession -Credential $cred -BaseURI https://PVWA -useRadiusAuthentication $True

    Logon using RADIUS via the Classic API

    .EXAMPLE
    New-PASSession -Credential $cred -BaseURI https://PVWA -type RADIUS -OTP 123456 -OTPMode Challenge

    Logon to Version 10 using RADIUS (Challenge) & OTP (Response)

    .EXAMPLE
    New-PASSession -Credential $cred -BaseURI https://PVWA -UseClassicAPI -useRadiusAuthentication $True -OTP 123456 -OTPMode Append

    Logon using RADIUS & OTP (Append Mode) via the Classic API

    .EXAMPLE
    New-PASSession -Credential $cred -BaseURI https://PVWA -type RADIUS -OTP push -OTPMode Append

    Logon to Version 10 using RADIUS & Push Authentication (works with DUO 2FA)

    .EXAMPLE
    New-PASSession -UseSharedAuthentication -BaseURI https://pvwa.some.co -CertificateThumbprint 0e194289c57e666115109d6e2800c24fb7db6edb

    If authentication via certificates is configured, provide CertificateThumbprint details.

    .EXAMPLE
    New-PASSession -Credential $cred -BaseURI $url -SkipCertificateCheck

    Skip SSL Certificate validation for the session.
    #>

    [CmdletBinding(SupportsShouldProcess, DefaultParameterSetName = "v10")]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipeline = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10"
        )]
        [parameter(
            Mandatory = $true,
            ValueFromPipeline = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10Radius"
        )]
        [parameter(
            Mandatory = $true,
            ValueFromPipeline = $true,
            ParameterSetName = "v9"
        )]
        [parameter(
            Mandatory = $true,
            ValueFromPipeline = $true,
            ParameterSetName = "v9Radius"
        )]
        [ValidateNotNullOrEmpty()]
        [PSCredential]$Credential,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v9"
        )]
        [parameter(
            Mandatory = $true,
            ValueFromPipeline = $true,
            ParameterSetName = "v9Radius"
        )]
        [switch]$UseClassicAPI,

        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10"
        )]
        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v9"
        )]
        [SecureString]$newPassword,

        [Parameter(
            Mandatory = $true,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "saml"
        )]
        [String]$SAMLToken,

        [Parameter(
            Mandatory = $True,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "shared"
        )]
        [switch]$UseSharedAuthentication,

        [Parameter(
            Mandatory = $true,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v9Radius"
        )]
        [bool]$useRadiusAuthentication,

        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10"
        )]
        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10Radius"
        )]
        [ValidateSet("CyberArk", "LDAP", "Windows", "RADIUS")]
        [string]$type = "CyberArk",

        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10Radius"
        )]
        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v9Radius"
        )]
        [string]$OTP,

        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10Radius"
        )]
        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v9Radius"
        )]
        [ValidateSet("Append", "Challenge")]
        [string]$OTPMode,

        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10Radius"
        )]
        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v9Radius"
        )]
        [ValidateLength(1, 1)]
        [string]$OTPDelimiter,

        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10Radius"
        )]
        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v9Radius"
        )]
        [ValidateSet("Password", "OTP")]
        [string]$RadiusChallenge,

        [parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "integrated"
        )]
        [switch]$UseDefaultCredentials,

        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v9"
        )]
        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v9Radius"
        )]
        [ValidateRange(1, 100)]
        [int]$connectionNumber,

        [parameter(
            Mandatory = $true,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$BaseURI,

        [parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$PVWAAppName = "PasswordVault",

        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $false
        )]
        [switch]$SkipVersionCheck,

        [parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $false
        )]
        [string]$CertificateThumbprint,

        [parameter(
            Mandatory = $false,
            ValueFromPipeline = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [switch]$SkipCertificateCheck

    )

    BEGIN {

        #Hashtable to hold Logon Request
        $LogonRequest = @{ }

        #Define Logon Request Parameters
        $LogonRequest["Method"] = "POST"
        $LogonRequest["SessionVariable"] = "PASSession"
        $LogonRequest["UseDefaultCredentials"] = $UseDefaultCredentials.IsPresent
        $LogonRequest["SkipCertificateCheck"] = $SkipCertificateCheck.IsPresent
        If ($CertificateThumbprint) {
            $LogonRequest["CertificateThumbprint"] = $CertificateThumbprint
        }

        Switch -Wildcard ($PSCmdlet.ParameterSetName) {

            "v10" {

                $LogonRequest["Uri"] = "$baseURI/$PVWAAppName/api/Auth/$type/Logon"
                break

            }

            "v10Radius" {

                $LogonRequest["Uri"] = "$baseURI/$PVWAAppName/api/Auth/RADIUS/Logon"
                break

            }

            "integrated" {

                $LogonRequest["Uri"] = "$baseURI/$PVWAAppName/api/Auth/Windows/Logon"  #hardcode Windows for integrated auth
                break

            }

            "v9*" {

                $LogonRequest["Uri"] = "$baseURI/$PVWAAppName/WebServices/auth/Cyberark/CyberArkAuthenticationService.svc/Logon"
                break

            }

            "saml" {

                $LogonRequest["Uri"] = "$baseURI/$PVWAAppName/WebServices/auth/SAML/SAMLAuthenticationService.svc/Logon"
                break

            }

            "shared" {

                $LogonRequest["Uri"] = "$baseURI/$PVWAAppName/WebServices/auth/Shared/RestfulAuthenticationService.svc/Logon"
                break

            }

        }

    }#begin

    PROCESS {

        #Get request parameters
        $boundParameters = $PSBoundParameters | Get-PASParameter -ParametersToRemove Credential, SkipVersionCheck, SkipCertificateCheck,
        UseDefaultCredentials, CertificateThumbprint, BaseURI, PVWAAppName, OTP, type, OTPMode, OTPDelimiter, RadiusChallenge

        If (($PSCmdlet.ParameterSetName -match "^v9*") -or ($PSCmdlet.ParameterSetName -match "^v10*") ) {

            #Add user name from credential object
            $boundParameters["username"] = $($Credential.UserName)
            #Add decoded password value from credential object
            $boundParameters["password"] = $($Credential.GetNetworkCredential().Password)

            #RADIUS Auth
            If ($PSCmdlet.ParameterSetName -match "Radius$") {

                #OTP in Append Mode
                If (($PSBoundParameters.ContainsKey("OTP")) -and ($PSBoundParameters["OTPMode"] -eq "Append")) {

                    If ($PSBoundParameters.ContainsKey("OTPDelimiter")) {

                        #Use specified delimiter to append OTP
                        $Delimiter = $OTPDelimiter

                    } Else {

                        #delimit with comma by default
                        $Delimiter = ","

                    }

                    #Append OTP to password
                    $boundParameters["password"] = "$($boundParameters["password"])$Delimiter$OTP"

                }

                #RADIUS Challenge Mode
                ElseIf (($PSBoundParameters.ContainsKey("OTP")) -and ($PSBoundParameters["OTPMode"] -eq "Challenge")) {

                    If ($RadiusChallenge -eq "Password") {

                        #Send OTP first + then Password
                        $boundParameters["password"] = $OTP
                        $OTP = $($Credential.GetNetworkCredential().Password)

                    }

                }

            }

            #deal with newPassword SecureString
            If ($PSBoundParameters.ContainsKey("newPassword")) {

                #Include decoded password in request
                $boundParameters["newPassword"] = $(ConvertTo-InsecureString -SecureString $newPassword)

            }

            #Construct Request Body
            $LogonRequest["Body"] = $boundParameters | ConvertTo-Json

        } Elseif ($PSCmdlet.ParameterSetName -eq "saml") {

            #add token to header
            $LogonRequest["Headers"] = @{"Authorization" = $SAMLToken }

        }

        if ($PSCmdlet.ShouldProcess("$BaseURI/$PVWAAppName", "Logon")) {

            try {

                #Send Logon Request
                $PASSession = Invoke-PASRestMethod @LogonRequest

            } catch {

                if ($PSItem.FullyQualifiedErrorId -notmatch "ITATS542I") {

                    #Throw all errors not related to ITATS542I
                    throw $PSItem

                } Else {

                    #ITATS542I is expected for RADIUS Challenge
                    If (($PSCmdlet.ParameterSetName -match "Radius$") -and ($PSBoundParameters["OTPMode"] -eq "Challenge")) {

                        If ($PSBoundParameters.ContainsKey("OTP")) {

                            #$OTP as RADIUS response
                            #If $RadiusChallenge = Password, $OTP will be password value
                            $boundParameters["password"] = $OTP

                            #Construct Request Body
                            $LogonRequest["Body"] = $boundParameters | ConvertTo-Json

                            #Use WebSession from initial request
                            $LogonRequest.Remove("SessionVariable")
                            $LogonRequest["WebSession"] = $Script:WebSession

                            #Respond to RADIUS challenge
                            $PASSession = Invoke-PASRestMethod @LogonRequest

                        } Else {

                            #No OTP
                            throw $PSItem

                        }

                    } Else {

                        #Not RADIUS/Challenge Mode
                        throw $PSItem

                    }

                }

            } finally {

                #If Logon Result
                If ($PASSession) {

                    #Version 10
                    If ($PASSession.length -ge 180) {

                        #V10 Auth Token.
                        $CyberArkLogonResult = $PASSession

                    }

                    #Shared Auth
                    ElseIf ($PASSession.LogonResult) {

                        #Shared Auth LogonResult.

                        $CyberArkLogonResult = $PASSession.LogonResult


                    }

                    #Classic
                    Else {

                        #Classic CyberArkLogonResult

                        $CyberArkLogonResult = $PASSession.CyberArkLogonResult

                    }

                    #?SAML Auth?

                    #BaseURI set in Module Scope
                    Set-Variable -Name BaseURI -Value "$BaseURI/$PVWAAppName" -Scope Script

                    #Auth token added to WebSession
                    $Script:WebSession.Headers["Authorization"] = [string]$CyberArkLogonResult

                    #Initial Value for Version variable
                    [System.Version]$Version = "0.0"

                    if ( -not ($SkipVersionCheck)) {

                        Try {

                            #Get CyberArk ExternalVersion number.
                            [System.Version]$Version = Get-PASServer -ErrorAction Stop |
                            Select-Object -ExpandProperty ExternalVersion

                        } Catch { [System.Version]$Version = "0.0" }

                    }

                    #Version information available in module scope.
                    Set-Variable -Name ExternalVersion -Value $Version -Scope Script

                }

            }

        }

    }#process

    END { }#end

}