public/Export-TNScan.ps1
|
function Export-TNScan { <# .SYNOPSIS Exports a list of scans .DESCRIPTION Exports a list of scans .PARAMETER SessionObject Optional parameter to force using specific SessionObjects. By default, each command will connect to all connected servers that have been connected to using Connect-TNServer .PARAMETER ScanId The ID of the target scan .PARAMETER Format The format of the output. Defaults to PDF. Options include: Nessus, HTML, PDF, CSV, DB .PARAMETER Path The destination file .PARAMETER PSObject Export as PSObject .PARAMETER Chapter The desired chapter. Options include: Vuln_Hosts_Summary, Vuln_By_Host, Compliance_Exec, Remediations, Vuln_By_Plugin, Compliance, All .PARAMETER HistoryID The ID of the target history .PARAMETER Password The required password. This is a securestring type. The easiest way to get this is by using (Get-Credential).Password which extracts the password in a secure manner (and does not care about the username.) .PARAMETER Name The name of the target scan .PARAMETER Credential The credential object (from Get-Credential) used to log into the target server. Specifies a user account that has permission to send the request. .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with 'sea of red' exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this 'nice by default' feature off and enables you to catch exceptions with your own try/catch. .EXAMPLE PS C:\> Export-TNScan -ScanId 10 -Path C:\temp\scan.pdf Exports scan ID 10 to C:\temp\scan.pdf .EXAMPLE PS C:\> Export-TNScan -ScanId 10 -Type CSV -Path C:\temp\scan.csv -Chapter Compliance Exports scan ID 10 to C:\temp\scan.pdf with only the Compliance subset #> [CmdletBinding()] param ( [Parameter(ValueFromPipelineByPropertyName)] [object[]]$SessionObject = (Get-TNSession), [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [int32]$ScanId, [Parameter(Position = 2)] [ValidateSet('Nessus', 'HTML', 'PDF', 'CSV', 'DB')] [string]$Format = 'PDF', [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [String]$Path, [Parameter(ValueFromPipelineByPropertyName)] [Switch]$PSObject, [Parameter(ValueFromPipelineByPropertyName)] [ValidateSet('Vuln_Hosts_Summary', 'Vuln_By_Host', 'Compliance_Exec', 'Remediations', 'Vuln_By_Plugin', 'Compliance', 'All')] [string[]]$Chapter, [Parameter(ValueFromPipelineByPropertyName)] [Int32]$HistoryID, [Parameter(ValueFromPipelineByPropertyName)] [securestring]$Password, [Parameter(ValueFromPipelineByPropertyName)] [string]$Name, [securestring]$Credential, [switch]$EnableException ) begin { $ExportParams = @{ } if ($Format -eq 'DB' -and ($Password -or $Credential)) { if (-not $Credential) { $Credential = New-Object System.Management.Automation.PSCredential -ArgumentList 'user', $Password } $ExportParams.Add('password', $Credential.GetNetworkCredential().Password) } if ($Format) { $ExportParams.Add('format', $Format.ToLower()) } if ($Chapter) { if ($Chapter -contains 'All') { $ExportParams.Add('chapters', 'vuln_hosts_summary;vuln_by_host;compliance_exec;remediations;vuln_by_plugin;compliance') } else { $ExportParams.Add('chapters', $Chapter.ToLower()) } } if (-not (Test-Path -Path $Path)) { $null = New-Item -Type Directory -Path $Path } } process { foreach ($session in $SessionObject) { $PSDefaultParameterValues["*:SessionObject"] = $session if ($HistoryId) { $urlpath = "/scans/$ScanId/export?history_id=$HistoryId" } else { $urlpath = "/scans/$ScanId/export" } Write-PSFMessage -Level Verbose -Message "Exporting scan with Id of $ScanId in $($Format) format" foreach ($fileid in (Invoke-TNRequest -SessionObject $session -EnableException:$EnableException -Path $urlpath -Method 'Post' -Parameter $ExportParams)) { $FileStatus = '' while ($FileStatus.status -ne 'ready') { try { $FileStatus = Invoke-TNRequest -SessionObject $session -EnableException:$EnableException -Path "/scans/$ScanId/export/$($fileid.file)/status" -Method GET Write-PSFMessage -Level Verbose -Message "Status of export is $($FileStatus.status)" } catch { break } Start-Sleep -Seconds 1 } if ($FileStatus.status -eq 'ready' -and $Format -eq 'CSV' -and $PSObject.IsPresent) { Write-PSFMessage -Level Verbose -Message "Converting report to PSObject" Invoke-TNRequest -SessionObject $session -EnableException:$EnableException -Path "/scans/$ScanId/export/$($fileid.file)/download" -Method GET | ConvertFrom-Csv } elseif ($FileStatus.status -eq 'ready') { Write-PSFMessage -Level Verbose -Message "Downloading report to $($Path)" $filepath = Resolve-PSFPath -Path "$path\$name-$scanid.$($Format.ToLower())" -NewChild Invoke-TNRequest -SessionObject $session -EnableException:$EnableException -Path "/scans/$ScanId/export/$($fileid.file)/download" -Method GET -OutFile $filepath } Get-ChildItem -Path $Path } } } } |