public/Get-VPASPSMSessionProperties.ps1
|
<#
.Synopsis GET PSM SESSION PROPERTIES CREATED BY: Vadim Melamed, EMAIL: vmelamed5@gmail.com .DESCRIPTION USE THIS FUNCTION TO GET PSM SESSION PROPERTIES .PARAMETER token HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc). If -token is not passed, function will use last known hashtable generated by New-VPASToken .PARAMETER SearchQuery Search string to find target resource via username, address, safe, platform, etc. Comma separated for multiple fields, or to search all pass a blank value like so: " " .PARAMETER PSMSessionID Unique ID that maps to the target PSMSession Supply the PSMSessionID to skip any querying to find the target PSMSession .EXAMPLE $GetPSMSessionPropertiesJSON = Get-VPASPSMSessionProperties -SearchQuery {SEARCHQUERY VALUE} .EXAMPLE $GetPSMSessionPropertiesJSON = Get-VPASPSMSessionProperties -PSMSessionID {PSM SESSION ID VALUE} .OUTPUTS If successful: { "SessionID": "36_102", "SessionGuid": "fjklsdhf28734-2345-sdfg-xcvb-kjadhf5678249", "SafeName": "PSMRecordings", "FolderName": "Root", "IsLive": false, "FileName": "fjklsdhf28734-2345-sdfg-xcvb-kjadhf5678249.session", "Start": 1712111269, "End": 1712111328, "Duration": 59, "User": "vadim@vman.com", "RemoteMachine": "192.168.111.111", "ProtectionDate": 0, "ProtectedBy": "", "ProtectionEnabled": false, "AccountUsername": "vmanda", "AccountPlatformID": "VadimWindowsDomain", "AccountAddress": "vman.com", "PIMSuCommand": "", "PIMSuCWD": "", "ConnectionComponentID": "PSM-RDP", "PSMRecordingEntity": "SessionRecording", "TicketID": "", "FromIP": "192.168.222.222", "Protocol": "RDP", "Client": "RDP", "RiskScore": -1, "Severity": "", "IncidentDetails": null, "RawProperties": { "Address": "vman.com", "ConnectionComponentID": "PSM-RDP", "DeviceType": "Operating System", "EntityVersion": "1.0", "ExpectedRecordingsList": "fjklsdhf28734-2345-sdfg-xcvb-kjadhf5678249.WIN.txt,fjklsdhf28734-2345-sdfg-xcvb-kjadhf5678249.VID.avi", "PSMClientApp": "mstsc.exe", "PSMPasswordID": "9", "PSMProtocol": "RDP", "PSMRecordingEntity": "SessionRecording", "PSMRemoteMachine": "192.168.111.111", "PSMSafeID": "68", "PSMSourceAddress": "192.168.222.222", "PSMStartTime": "1712111269", "PSMStatus": "Final", "PSMVaultUserName": "vadim@vman.com", "PolicyID": "VadimWindowsDomain", "ProviderID": "PSMApp_VmanCon01", "UserName": "vmanda", "PSMEndTime": "1712111328", "ActualRecordings": "fjklsdhf28734-2345-sdfg-xcvb-kjadhf5678249.WIN.txt;187,fjklsdhf28734-2345-sdfg-xcvb-kjadhf5678249.VID.avi;188", "Safe": "PSMRecordings", "Folder": "Root", "Name": "fjklsdhf28734-2345-sdfg-xcvb-kjadhf5678249.session" }, "RecordingFiles": [ { "FileName": "fjklsdhf28734-2345-sdfg-xcvb-kjadhf5678249.VID.avi", "RecordingType": 2, "LastReviewBy": "", "LastReviewDate": 0, "FileSize": 1675264, "CompressedFileSize": 1772412, "Format": "VID" }, { "FileName": "fjklsdhf28734-2345-sdfg-xcvb-kjadhf5678249.WIN.txt", "RecordingType": 1, "LastReviewBy": "", "LastReviewDate": 0, "FileSize": 89, "CompressedFileSize": 3048, "Format": "WIN" } ], "RecordedActivities": null, "VideoSize": 1772412, "TextSize": 3048, "DetailsUrl": "recordingdetails.aspx?Data=skjdhf8o7wh73jwt9o834to9d38hdt9834pcmchf3fjdp3kfp834muj834mcp9k3pq3k4dp83jfp89mpk9dj92375om3o4tmdfhl8p9m4td" } --- $false if failed #> function Get-VPASPSMSessionProperties{ [OutputType('System.Object',[bool])] [CmdletBinding()] Param( [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=0)] [String]$SearchQuery, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=1)] [String]$PSMSessionID, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=2)] [hashtable]$token ) Begin{ $tokenval,$sessionval,$PVWA,$Header,$ISPSS,$IdentityURL,$EnableTextRecorder,$AuditTimeStamp,$NoSSL,$VaultVersion,$HideWarnings,$AuthenticatedAs,$SubDomain = Get-VPASSession -token $token $CommandName = $MyInvocation.MyCommand.Name $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType COMMAND } Process{ Write-Verbose "SUCCESSFULLY PARSED PVWA VALUE" Write-Verbose "SUCCESSFULLY PARSED TOKEN VALUE" try{ if([String]::IsNullOrEmpty($PSMSessionID)){ Write-Verbose "NO PSM SESSION ID PROVIDED...INVOKING HELPER FUNCTION TO RETRIEVE UNIQUE PSM SESSION ID BASED ON SPECIFIED PARAMETERS" $PSMSessionID = Get-VPASRecordingIDHelper -token $token -SearchQuery $SearchQuery Write-Verbose "RETURNING PSM SESSION ID" } else{ Write-Verbose "PSM SESSION ID SUPPLIED, SKIPPING HELPER FUNCTION" } if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$PVWA/PasswordVault/API/recordings/$PSMSessionID/properties" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$PVWA/PasswordVault/API/recordings/$PSMSessionID/properties" } $log = Write-VPASTextRecorder -inputval $uri -token $token -LogType URI $log = Write-VPASTextRecorder -inputval "GET" -token $token -LogType METHOD write-verbose "MAKING API CALL TO CYBERARK" if($sessionval){ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method GET -ContentType "application/json" -WebSession $sessionval } else{ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method GET -ContentType "application/json" } $log = Write-VPASTextRecorder -inputval $response -token $token -LogType RETURN Write-Verbose "RETURNING JSON OBJECT" return $response }catch{ $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "UNABLE TO GET PSM SESSION PROPERTIES" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |