darkoperator / posh-shodan

PowerShell Module to interact with the Shodan service

Posh-Shodan

PowerShell Module to interact with the Shodan REST API https://developer.shodan.io/ provided with the proper API key.

Install

To install the module including all source code you can just run in a PowerShell v3 or higher session the following command:

iex (New-Object Net.WebClient).DownloadString("https://gist.githubusercontent.com/darkoperator/9378450/raw/7244d3db5c0234549a018faa41fc0a2af4f9592d/PoshShodanInstall.ps1")

The installation process should look like:

PS C:\> iex (New-Object Net.WebClient).DownloadString("https://gist.githubusercontent.com/darkoperator/9378450/raw/7244d3db5c0234549a018faa41fc0a2af4f9592d/PoshShodanInstall.ps1")
Downloading latest version of Posh-Shodan from https://github.com/darkoperator/Posh-Shodan/archive/master.zip
File saved to C:\Users\Carlos\AppData\Local\Temp\Posh-Shodan.zip
Uncompressing the Zip file to C:\Users\Carlos\Documents\WindowsPowerShell\Modules
Renaming folder
Module has been installed

CommandType     Name                                               ModuleName
-----------     ----                                               ----------
Function        Get-ShodanAPIInfo                                  Posh-Shodan
Function        Get-ShodanDNSResolve                               Posh-Shodan
Function        Get-ShodanDNSReverse                               Posh-Shodan
Function        Get-ShodanHostServices                             Posh-Shodan
Function        Get-ShodanMyIP                                     Posh-Shodan
Function        Get-ShodanServices                                 Posh-Shodan
Function        Measure-ShodanExploit                              Posh-Shodan
Function        Measure-ShodanHost                                 Posh-Shodan
Function        Read-ShodanAPIKey                                  Posh-Shodan
Function        Search-ShodanExploit                               Posh-Shodan
Function        Search-ShodanHost                                  Posh-Shodan
Function        Set-ShodanAPIKey                                   Posh-Shodan

After install set your API key and use a Master Password to encrypt it on disk:

PS C:\> Set-ShodanAPIKey -APIKey 238784665352425277288393 -MasterPassword (Read-Host -AsSecureString)

The key is now saved in a secure manner on disk and set as the key for use for all other commands. For loading a stored key after opening a new session just issue the command to read the key with you master password:

Read-ShodanAPIKey -MasterPassword (Read-Host -AsSecureString)

posh-shodan's Issues

Save-APIKey fails when the Master password length isn't divisible by 4

Just setting up the module and when I try to use the Save-APIKey cmdlet I get an error setting it.

ConvertFrom-SecureString : The specified key is not valid. Valid key length settings are either 128 bits, 192 bits, or
256 bits.
At C:\Program Files\WindowsPowerShell\Modules\Posh-Shodan\Posh-Shodan.psm1:34 char:47
+ ... SecureKeyString | ConvertFrom-SecureString -SecureKey $MasterPassword
+                       ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidArgument: (:) [ConvertFrom-SecureString], PSArgumentException
    + FullyQualifiedErrorId : Argument,Microsoft.PowerShell.Commands.ConvertFromSecureStringCommand

Initially I thought it was a problem with the API Key length, but from experimenting with different password length it seems that the cmdlet works fine when the password length is divisible by 4 (e.g. 8, 12, 16 chars in length) and the error occurs when it's not.

Set-ShodanAPIKey fails in pwsh 7.3.3

PS C:\Users\[redacted]> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      7.3.3
PSEdition                      Core
GitCommitId                    7.3.3
OS                             Microsoft Windows 10.0.22621
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

PS C:\Users\[redacted]> Get-Module -Name Posh-Shodan

ModuleType Version    PreRelease Name                                ExportedCommands
---------- -------    ---------- ----                                ----------------
Script     1.2                   Posh-Shodan                         {Get-ShodanAPIInfo, Get-ShodanDNSResolve, Get-ShodanDNSReverse, Get-ShodanHostService…}

PS C:\Users\[redacted]> Set-ShodanAPIKey

cmdlet Set-ShodanAPIKey at command pipeline position 1
Supply values for the following parameters:
APIKey: [redacted]
MasterPassword: [redacted]
Set-Content: Cannot process argument transformation on parameter 'Encoding'. 'Byte' is not a supported encoding name. For information on defining a custom encoding, see the documentation for the Encoding.RegisterProvider method. (Parameter 'name')