rattfieldnz/shodan

A laravel package to check URLs with Shodan API.

1.0.2 2021-03-05 02:10 UTC

Requires

• php: >=7.2
• ext-curl: *
• ext-json: *
• curl/curl: ^2.2
• illuminate/support: ~8.31.0

Requires (Dev)

• barryvdh/laravel-ide-helper: 2.9.*
• fzaninotto/faker: ~1.8
• mockery/mockery: ^1.4
• orchestra/testbench: ^6.13.0
• php-cs-fixer/phpunit-constraint-isidenticalstring: ^1.2
• phpspec/prophecy: ^1.10.3
• phpunit/php-code-coverage: ^9.2.5
• phpunit/phpunit: ~9.5
• sempro/phpunit-pretty-print: ^1.4
• squizlabs/php_codesniffer: ^3.5

MIT

• Robert Attfield

• api
• shodan
• websites
• check urls
• safe urls

README

A laravel package to check URLs with Shodan API.

• Installation
  • Register Service Provider
  • Register Facade
  • Register Facade
  • Publish Configuration File
  • Set your Shodan API key
• Usage
  • Using Blade Syntax
  • Using Facades
• Example with input and output (associative array)
• Example with input and output (JSON)
• Testing
• Security
• Credits

Installation

Install via composer

composer require rattfieldnz/shodan

Register Service Provider

Note! This and next step are optional if you use laravel>=5.5 with package auto discovery feature.

Add service provider to config/app.php in providers section.

RattfieldNz\Shodan\ShodanServiceProvider::class,

Register Facade

Register package facade in config/app.php in aliases section

RattfieldNz\Shodan\Facades\ShodanFacade::class,

Publish Configuration File

php artisan vendor:publish --provider="RattfieldNz\Shodan\ShodanServiceProvider" --tag="shodan"

Set your Shodan API key

In your .env, add:

SHODAN_API_KEY=YOUR-ACTUAL-API-KEY
SHODAN_REQUEST_TIMEOUT=10

Usage

Using Blade Syntax

@if(isset(Shodan::setUrl('https://github.com')->check()->getResults()))
    // Iterate over associative array results.
    // getResults(true) returns results as JSON-encoded string.
@else
    <p>No results were found</p>
@endif

getResults(true) returns results as JSON-encoded string.

Using Facades

Shodan::setUrl('https://github.com');
Shodan::check();
Shodan::getResults();

Or:

Shodan::setUrl('https://github.com')->check()->getResults();

Example with input and output (associative array)

View EXAMPLE_INPUT_OUTPUT_ASSOCIATIVEARRAY.md.

Example with input and output (JSON)

View EXAMPLE_INPUT_OUTPUT_JSON.md.

Testing

From inside the root folder of this package:

$ chmod u+x run_phpunit && ./run_phpunit YOUR_SHODAN_API_KEY

Replace YOUR_SHODAN_API_KEY with your actual key. Get one by visiting https://developer.shodan.io/api.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Robert Attfield
• All contributors

This package is bootstrapped with the help of melihovv/laravel-package-generator.