README

Min Auth

Min Auth 是一个 Laravel 扩展包，允许你在 Laravel 网络应用程序上创建和管理基于客户端的身份验证系统。

安装

此包需要 PHP >= 7.2 及以上版本。（Laravel 8 和 PHP 8 支持）。

你可以通过 composer 安装此包。

composer require bencoderus/min-auth

发布迁移和配置。

php artisan min-auth:install

运行迁移。

php artisan migrate

使用方法

Min Auth 命令

发布迁移和配置。

php artisan min-auth:install

创建客户端

php artisan min-auth:create-client {name}

使用中间件保护你的路由。

在你的路由中添加 auth.client

Route::get('test', function(){
    return "Hello world";
})->middleware('auth.client');

在你的控制器中添加 auth.client

public function __construct(){
    $this->middleware('auth.client');
}

使用助手函数

导入 Min Auth 助手函数

use Bencoderus\MinAuth\MinAuth;

创建客户端

MinAuth::createClient($name);
// Optional
MinAuth::createClient($name, $ip, $isBlacklisted);

通过 API 密钥查找客户端

MinAuth::findByApiKey($apiKey);

将客户端加入黑名单

MinAuth::blacklistClient($client);

将客户端加入白名单

MinAuth::whitelistClient($client);

刷新客户端 API 密钥

MinAuth::refreshApiKey($client);

更新客户端 IP 地址

$ip = "127.0.0.8";
MinAuth::updateIpAddress($client, $ip);

配置

你可以在 config/min-auth.php 中关闭 IP 地址验证。

测试

composer test

更新日志

请参阅更新日志了解最近的变化信息。

贡献

请参阅贡献指南获取详细信息。

安全

如果你发现任何安全相关的问题，请通过电子邮件发送至 bencoderus@gmail.com 而不是使用问题跟踪器。

致谢

许可协议

MIT 许可协议（MIT）。请参阅许可文件了解更多信息。

bencoderus / min-auth

维护者

详细信息