rattfieldnz/shodan

一个用于通过 Shodan API 检查 URL 的 Laravel 扩展包。


README

PHP Version PHP Version License: MIT Latest Version on Packagist Total Downloads Build Status StyleCI Scrutinizer Code Quality codecov

一个用于通过 Shodan API 检查 URL 的 Laravel 扩展包。

安装

通过 composer 安装

composer require rattfieldnz/shodan

注册服务提供者

注意!如果你使用 laravel>=5.5 并且启用了包自动发现功能,这一步和下一步是可选的。

将服务提供者添加到 config/app.php 中的 providers 部分。

RattfieldNz\Shodan\ShodanServiceProvider::class,

注册外观

config/app.php 中的 aliases 部分注册包外观

RattfieldNz\Shodan\Facades\ShodanFacade::class,

发布配置文件

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

设置你的 Shodan API 密钥

在你的 .env 文件中添加

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

使用方法

使用 Blade 语法

@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) 返回 JSON 编码的字符串。

使用外观

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

或者

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

输入和输出的示例(关联数组)

查看 EXAMPLE_INPUT_OUTPUT_ASSOCIATIVEARRAY.md.

输入和输出的示例(JSON)

查看 EXAMPLE_INPUT_OUTPUT_JSON.md.

测试

在此包的根目录内

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

将 YOUR_SHODAN_API_KEY 替换为你的实际密钥。你可以通过访问 https://developer.shodan.io/api 获取一个。

安全

如果你发现任何安全问题,请通过电子邮件 emailme@robertattfield.com 反馈,而不是使用问题跟踪器。

致谢

此包是通过 melihovv/laravel-package-generator 帮助启动的。