jhonhuanuco-dev/security-pe

Security-pe提供一套简单的API认证和安全系统。

1.0.5 2024-07-12 17:02 UTC

This package is auto-updated.

Last update: 2024-09-12 17:19:16 UTC


README

  1. 安装包请使用以下命令
  composer require jhonhuanuco-dev/security-pe
  1. config/app.php文件中注册服务提供者
return [
  'providers' => [
    /*
      * Package Service Providers...
      */

    Jhonhdev\SecurityPe\SecurityPeServiceProvider::class,
  ]
];
  1. 使用以下命令发布配置文件config/securitype.php
  php artisan vendor:publish --provider="Jhonhdev\SecurityPe\SecurityPeServiceProvider"
  1. 删除以下迁移以避免冲突,因为默认情况下将使用Security.pe迁移
  • users
  • personal_access_tokens
  1. 修改你的app/Models/User.php模型。
namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Notifications\Notifiable;
use Jhonhdev\SecurityPe\Models\Schemas\Security\Users;

class User extends Users
{
  use HasFactory, Notifiable;
}
  1. config/database.php中为你的数据库添加一个默认连接字符串,名称为default
return [
  'connections' => [
    //...

    'default' => [
      //...
    ]
  ]
];
  1. App\Http\Kernel.php中注册ActivityUserRequest中间件。
protected $middleware = [

  //...
  \Jhonhdev\SecurityPe\Http\Middleware\ActivityUserRequest::class,

];
  1. 在运行迁移之前,根据需要更新你的配置文件config/securitype.php

  2. 执行以下命令以运行迁移

  php artisan migrate

用法

登录

认证你的应用程序用户,并在数据库中注册加密令牌。

  POST /securitype/auth/login
{
  "status": true,
  "message": "Bienvenido John Smith",
  "user": {
    "branch_id": 1,
    "username": "jhsm",
    "name": "John",
    "last_name": "Smith",
    "email": "example@company.com",
    "extension": 102,
    "state": true
  },
  "token": {
    "key": "1|iplxuLz78Ff9nS1ECDalNv2wJUFJMFVLemBOQJvz",
    "expired": "2024-05-16 22:30:09"
  }
}

登出

移除已认证用户的会话令牌。

  GET /securitype/auth/logout
{
  "status": true,
  "message": "Hasta pronto.",
}

验证令牌。

验证令牌是否有效以及/或未过期。用户必须经过认证,并且携带令牌必须包含在请求头中。

  POST /securitype/auth/validatetoken
{
  "status": true,
  "message": "Ok.",
}

作者

许可证

Security.pe是开源软件,根据MIT许可证授权。