ariaieboy/laravel-safe-browsing

LARAVEL 的 Google 安全浏览 API 集成

1.3.0 2024-03-01 20:36 UTC

This package is auto-updated.

Last update: 2024-08-30 21:42:50 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

使用此 LaravelSafeBrowsing 包,您可以将 Google 安全浏览 API (v4) 添加到您的 Laravel 应用程序中。

在用户生成网站内容的场景中,检查内容是否安全是必要的。

此包的一个重要特性是,它将帮助您检查 URL,如果它不安全,它将使用 Google 安全浏览 API v4 返回不安全的原因。

安装

您可以通过 Composer 安装此包

composer require ariaieboy/laravel-safe-browsing

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="safe-browsing-config"

这是发布配置文件的内容

return [
    'google'=>[
        'api_domain'=>env('SAFEBROWSING_GOOGLE_API_DOMAIN','https://safebrowsing.googleapis.com/'),
        'api_key'=>env('SAFEBROWSING_GOOGLE_API_KEY',null),
        'timeout'=>30,
        'threatTypes' => [
            'THREAT_TYPE_UNSPECIFIED',
            'MALWARE',
            'SOCIAL_ENGINEERING',
            'UNWANTED_SOFTWARE',
            'POTENTIALLY_HARMFUL_APPLICATION',
        ],

        'threatPlatforms' => [
            'ANY_PLATFORM'
        ],
        'clientId' => 'ariaieboy-safebrowsing',
        'clientVersion' => '1.0.0',
    ]
];

在您的配置文件中设置 api_key 或使用 ENV SAFEBROWSING_GOOGLE_API_KEY

使用方法

    $result = LaravelSafeBrowsing::isSafeUrl('http://malware.testing.google.test/testing/malware/',true);
    // Return: (string) MALWARE

第一个参数是要检查的 URL,第二个参数是可选的布尔值。如果不传递第二个参数或传递 false,函数将返回 URL 安全时为 true 或不安全时为 false。如果传递 true,函数将返回不安全的威胁类型。如果 URL 安全,它将返回 true。

待办事项

  • 添加中间件以检查 URL 是否安全
  • 添加验证规则以检查 URL 是否安全
  • 使用更新 API 添加缓存机制

测试

composer test

变更日志

有关最近更改的更多信息,请参阅 变更日志

贡献

有关详细信息,请参阅 贡献指南

安全漏洞

有关如何报告安全漏洞的详细信息,请参阅 我们的安全策略

致谢

许可

MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件