documentation

Author: sysgoblin

src/Public/Get-UrlScanioDOM.ps1

@@ -1,7 +1,29 @@
 function Get-UrlScanioDOM {
+<#
+.SYNOPSIS
+Return raw DOM of web page scanned by urlscan.io
+
+.DESCRIPTION
+Returns raw DOM of the specified scan id by urlscan.io. If no path is specified DOM will write to console.
+
+.PARAMETER id
+Unique ID of scan to return raw DOM of.
+
+.PARAMETER Path
+Path to save copy of DOM as txt file.
+
+.EXAMPLE
+Get-UrlScanioDOM -id b14db0aa-013c-4aa9-ad5a-ec947a2278c7 -Path c:\temp
+Saves output of specified id as C:\temp\b14db0aa-013c-4aa9-ad5a-ec947a2278c7.txt
+#>
+
     [CmdletBinding()]
     param (
-        [Parameter(ValueFromPipelineByPropertyName)]
+        [Parameter(Mandatory = $true,
+        Position = 0,
+        ValueFromPipelineByPropertyName,
+        ValueFromPipeline)]
+        [ValidatePattern('[\d\w]{8}-[\d\w]{4}-[\d\w]{4}-[\d\w]{4}-[\d\w]{12}')]
         [string]$id,
         [string]$Path
     )
@@ -10,15 +32,15 @@ function Get-UrlScanioDOM {
         if ($PSBoundParameters.Path) {
             if (Test-Path $Path -PathType Container) {
                 try {
-                    Invoke-WebRequest "https://urlscan.io/dom/$id/" -OutFile "$id.txt"
+                    Invoke-WebRequest "https://urlscan.io/dom/$id/" -OutFile "$id.txt" -UseBasicParsing
                     Write-Verbose "DOM saved to $Path\$id.txt"
                 } catch {
                     $_.Exception.Message
                 }
             }
         }
 
-        $dom = Invoke-WebRequest "https://urlscan.io/dom/$id/"
+        $dom = Invoke-WebRequest "https://urlscan.io/dom/$id/" -UseBasicParsing
 
         return $dom.Content
     }

src/Public/Get-UrlScanioScan.ps1

@@ -12,6 +12,12 @@ Guid of scan to get details on.
 .PARAMETER DataType
 Data type to return. Provides quick access to specific  subsets of data for interrogation.
 
+.PARAMETER IncludeTaskDetails
+Includes details of scan along with data type specified.
+
+.PARAMETER SimilarDomains
+List structurally similar domains.
+
 .EXAMPLE
 Get-UrlScanioScan -uuid b14db0aa-013c-4aa9-ad5a-ec947a2278c7
 Get urlscan.io report for the scan with uuid b14db0aa-013c-4aa9-ad5a-ec947a2278c7

src/Public/Get-UrlScanioScreenshot.ps1

@@ -1,7 +1,32 @@
 function Get-UrlScanioScreenshot {
+<#
+.SYNOPSIS
+Get copy of last screenshot taken by urlscan.io
+
+.DESCRIPTION
+Retreives copy of screenshot present on urlscan.io result page and saves to the specified location.
+
+.PARAMETER id
+Unique ID of scan to retrieve the screenshot of.
+
+.PARAMETER Path
+Path to save the screenshot file to.
+
+.EXAMPLE
+Get-UrlScanioScreenshot -id b14db0aa-013c-4aa9-ad5a-ec947a2278c7 -Path c:\temp
+Saves screenshot of specified id as C:\temp\b14db0aa-013c-4aa9-ad5a-ec947a2278c7.png
+#>
+
     [CmdletBinding()]
     param (
+        [Parameter(Mandatory = $true,
+        Position = 0,
+        ValueFromPipelineByPropertyName,
+        ValueFromPipeline)]
+        [ValidatePattern('[\d\w]{8}-[\d\w]{4}-[\d\w]{4}-[\d\w]{4}-[\d\w]{12}')]
+        [Alias('uuid', '_id')]
         [string]$id,
+        [Parameter(Mandatory = $true)]
         [string]$Path
     )
 
@@ -12,7 +37,7 @@ function Get-UrlScanioScreenshot {
 
         if (Test-Path $Path -PathType Container) {
             try {
-                Invoke-WebRequest " https://urlscan.io/screenshots/$id.png" -OutFile "$id.png"
+                Invoke-WebRequest " https://urlscan.io/screenshots/$id.png" -OutFile "$id.png" -UseBasicParsing
                 Write-Verbose "Screenshot saved to $Path\$id.png"
             } catch {
                 $_.Exception.Message