public/Get-VPASDiscoveredAccountsDependencies.ps1
|
<#
.Synopsis GET DISCOVERED ACCOUNTS DEPENDENCIES CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO GET DISCOVERED ACCOUNTS DEPENDENCIES IN THE PENDING SAFE LIST .LINK https://vpasmodule.com/commands/Get-VPASDiscoveredAccountsDependencies .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 PlatformType Limit the scope of accounts returned based on PlatformType Possible values: Windows Server Local, Windows Desktop Local, Windows Domain, Unix, Unix SSH Key, AWS, AWS Access Keys, Azure Password Management .PARAMETER Privileged Limit the scope of accounts returned based on Privileged status Possible values: true, false .PARAMETER Enabled Limit the scope of accounts returned based in account status Possible values: true, false .PARAMETER Confirm Skip the confirmation prompt confirming to run against all discovered accounts .PARAMETER InputParameters HashTable of values containing the parameters required to make the API call .PARAMETER AcctID Unique ID that maps to a single account, passing this variable will skip any query functions .EXAMPLE $DiscoveredAccountsDependenciesJSON = Get-VPASDiscoveredAccountsDependencies -SearchQuery {SEARCHQUERY VALUE} .EXAMPLE $InputParameters = @{ SearchQuery = "domainadmin01" PlatformType = "Windows Server Local"|"Windows Desktop Local"|"Windows Domain"|"Unix"|"Unix SSH Key"|"AWS"|"AWS Access Keys"|"Azure Password Management" Privileged = "true"|"false" Enabled = "true"|"false" Confirm = $true|$false } $DiscoveredAccountsDependenciesJSON = Get-VPASDiscoveredAccountsDependencies -InputParameters $InputParameters .EXAMPLE $InputParameters = @{ AcctID = "36_1003" } $DiscoveredAccountsDependenciesJSON = Get-VPASDiscoveredAccountsDependencies -InputParameters $InputParameters .OUTPUTS If successful: { "count": 1, "value": [ { "id": "19_15", "name": "vman.com-vmanda-aa06b546-f19d-4716-a89b-d3bedfbb6858", "userName": "vmanda", "address": "vman.com", "discoveryDateTime": 1724216092, "accountEnabled": true, "osGroups": "Administrators, Remote Desktop Users", "platformType": "Windows Domain", "domain": "vman.com", "lastLogonDateTime": 1724213492, "lastPasswordSetDateTime": 1718764060, "passwordNeverExpires": true, "osVersion": "Windows Server 2022 Standard Evaluation", "privileged": true, "userDisplayName": "vmanda", "passwordExpirationDateTime": 0, "osFamily": "Server", "organizationalUnit": "CN=vmanda,CN=Users,DC=vman,DC=com", "additionalProperties": "@{AccountType=Domain; CreationMethod=AutoDetected}", "platformTypeAccountProperties": "@{SID=S-1-5-21-859712872-1750767134-752027284-1104}", "numberOfDependencies": 0 "dependencies": [ { "name": "ServiceDep", "address": "win8.example.com", "type": "Windows Service" }, { "name": "MyScheduledTask", "address": "win8.example.com", "type": "Windows Scheduled Task", "taskFolder": "Tasks" } ] } ] } --- $false if failed #> function Get-VPASDiscoveredAccountsDependencies{ [OutputType([bool],'System.Collections.Hashtable')] [CmdletBinding(DefaultParameterSetName='Set1')] Param( [Parameter(Mandatory=$true,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true,HelpMessage="Enter wildcard search to query for target Discovered Accounts")] [String]$SearchQuery, [Parameter(Mandatory=$false,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true)] [ValidateSet('Windows Server Local','Windows Desktop Local','Windows Domain','Unix','Unix SSH Key','AWS','AWS Access Keys','Azure Password Management')] [String]$PlatformType, [Parameter(Mandatory=$false,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true)] [ValidateSet('true','false')] [String]$Privileged, [Parameter(Mandatory=$false,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true)] [ValidateSet('true','false')] [String]$Enabled, [Parameter(Mandatory=$true,ParameterSetName='Set2',ValueFromPipelineByPropertyName=$true,HelpMessage="Unique AccountID of the target account (for example: 22_123)")] [String]$AcctID, [Parameter(Mandatory=$false,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true)] [Switch]$Confirm, [Parameter(Mandatory=$true,ParameterSetName='InputParameters',ValueFromPipelineByPropertyName=$true,HelpMessage="Hashtable of parameters required to make API call, refer to get-help -examples for valid inputs")] [hashtable]$InputParameters, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true)] [hashtable]$token ) Begin{ $tokenval,$sessionval,$PVWA,$Header,$ISPSS,$IdentityURL,$EnableTextRecorder,$AuditTimeStamp,$NoSSL,$VaultVersion,$HideWarnings,$AuthenticatedAs,$SubDomain,$EnableTroubleshooting = Get-VPASSession -token $token $CommandName = $MyInvocation.MyCommand.Name $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType COMMAND } Process{ try{ if($PSCmdlet.ParameterSetName -eq "InputParameters"){ $KeyHash = @{ set1 = @{ AcceptableKeys = @("SearchQuery","PlatformType","Privileged","Enabled","Confirm") MandatoryKeys = @("SearchQuery") } set2 = @{ AcceptableKeys = @("AcctID") MandatoryKeys = @("AcctID") } } $CheckSet = Test-VPASHashtableKeysHelper -InputHash $InputParameters -KeyHash $KeyHash if(!$CheckSet){ $log = Write-VPASTextRecorder -inputval "FAILED TO FIND TARGET PARAMETER SET" -token $token -LogType MISC Write-Verbose "FAILED TO FIND TARGET PARAMETER SET" Write-VPASOutput -str "FAILED TO FIND TARGET PARAMETER SET...VIEW EXAMPLES BELOW:" -type E $examples = Write-VPASExampleHelper -CommandName $CommandName return $false } else{ foreach($key in $InputParameters.Keys){ Set-Variable -Name $key -Value $InputParameters.$key } } } }catch{ $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "FAILED TO RETRIEVE DISCOVERED ACCOUNTS" Write-VPASOutput -str $_ -type E return $false } try{ if(![String]::IsNullOrEmpty($PlatformType)){Write-Verbose "PARSING PLATFORMTYPE VALUE: $PlatformType"} if(![String]::IsNullOrEmpty($Privileged)){Write-Verbose "PARSING PRIVILEGED VALUE: $Privileged"} if(![String]::IsNullOrEmpty($Enabled)){Write-Verbose "PARSING ENABLED VALUE: $Enabled"} if([String]::IsNullOrEmpty($AcctID)){ if($Confirm){ $SearchQuery = "" } else{ if([String]::IsNullOrEmpty($SearchQuery)){ Write-VPASOutput "ENTER SEARCHQUERY: " -type Y $SearchQuery = Read-Host } } if([String]::IsNullOrEmpty($SearchQuery)){ if($Confirm){ $choice = "y" } else{ Write-VPASOutput -str "BLANK SEARCH QUERY PROVIDED, THIS FUNCTION WILL RUN AGAINST EVERY ACCOUNT FOUND IN THE PENDING ACCOUNTS DISCOVERY PAGE. THIS CAN TAKE A LONG TIME AND A LOT OF RESOURCES DEPENDING ON THE ENVIRONMENT. DO YOU WANT TO CONTINUE [N]: " -type Y $choice = Read-Host } if([String]::IsNullOrEmpty($choice)){ $choice = "n" } if($choice -ne "y" -or $choice -ne "Y"){ Write-Verbose "EXITING COMMAND" return $false } } Write-Verbose "NO ACCTID PROVIDED...INVOKING HELPER FUNCTION TO RETRIEVE UNIQUE ACCOUNT ID BASED ON SPECIFIED PARAMETERS" $AcctIDArr = Get-VPASDiscoveredAccountIDHelper -token $token -SearchQuery $SearchQuery Write-Verbose "RETURNING ACCOUNT ID" } else{ Write-Verbose "ACCTID SUPPLIED, SKIPPING HELPER FUNCTION" $AcctIDArr = @($AcctID) } $outputArr = @() foreach($rec in $AcctIDArr){ if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$PVWA/passwordvault/api/DiscoveredAccounts/$rec" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$PVWA/passwordvault/api/DiscoveredAccounts/$rec" } $log = Write-VPASTextRecorder -inputval $uri -token $token -LogType URI $log = Write-VPASTextRecorder -inputval "GET" -token $token -LogType METHOD 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" } if($response.numberOfDependencies -eq 0){ Write-VPASOutput "$rec DOES NOT HAVE ANY DEPENDENCIES" -type M Write-Verbose "$rec DOES NOT HAVE ANY DEPENDENCIES" } $outputArr += @($response) } $outputlog = @{ value = $outputArr } | ConvertTo-Json | ConvertFrom-Json $log = Write-VPASTextRecorder -inputval $outputlog -token $token -LogType RETURNARRAY Write-Verbose "RETURNING JSON OBJECT" return $outputArr }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 DISCOVERED ACCOUNTS FOR SEARCHQUERY: $SearchQuery" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |