README

laravel API 鉴权

laravel 的 API 鉴权包， api-auth 采用密钥加密的鉴权方式，只要客户端不被反编译从而泄露密钥，该鉴权方式理论上来说是安全的(不考虑量子计算机的出现)。

安装

composer require dsweixin/api-auth

配置

发布配置文件和中间件

php artisan vendor:publish --provider="ApiAuth\ApiServiceProvider"

在 App\Http\Kernal 中注册中间件

protected $routeMiddleware = [
    'api_auth' => \App\Http\Middleware\ApiAuth::class,
    // other ...
];

添加 role

php artisan api_auth

然后按照格式把 access_key 和 secret_key 添加到, config/api_auth.php 里面的 roles 数组中。

'roles' => [
    '{access_key}' => [
        'name' => '{role_name}',        // 角色名字，例如 android
        'secret_key' => '{secret_key}',
    ],
],

自定义签名方法 (可选) config/api_auth.php 中的 encrypting 可以修改为自定义的签名函数，该函数将传入三个参数: 密钥: $secret_key、随机字符串: $echostr、时间戳: $timestamp，返回签名后的字符串。该函数默认为:
```
/**
 * @param $secret_key
 * @param $echostr
 * @param $timestamp
 * @return string
 */
function encrypting($secret_key, $echostr, $timestamp) {
    return md5($secret_key . $echostr . $timestamp);
}
```
自定义签名校验规则(可选) config/api_auth.php 中的 rule 可以修改为自定义的校验函数，该函数将传入三个参数: 密钥: $secret_key、客户端签名: $signature、服务端签名: $server_signature，必须返回布尔值。该函数默认为:
```
/**
 * @param $secret_key
 * @param $signature
 * @param $server_signature
 * @return bool
 */
function rule($secret_key, $signature, $server_signature)
{
    return $signature === $server_signature;
}
```
自定义错误处理(可选) config/api_auth.php 中的 error_handler 可以修改为自定义的错误处理函数，该函数将传入两个参数: 请求: $request、错误码: $code。该函数默认为:
```
/**
 * @param Request $request
 * @param int $code
 * @return \Illuminate\Http\JsonResponse
 */
public static function error_handler($msg , $status = 200)
{
   $data = array(
       "msg"   => isset($msg) ? self::_lang($msg) : "参数错误",
       "error" => $msg,
       "data"  => new \stdClass()
   );
   return response()->json($data, $status, ["Content-Type" => "application/json;charset=utf-8"]);
}  
```
$code 可能是以下几个值中的一个:
- LaravelApiAuth::LACK_HEADER -> 缺少请求头。
- LaravelApiAuth::ACCESS_KEY_ERROR -> access_key 错误。
- LaravelApiAuth::SIGNATURE_ERROR -> 签名错误。
- LaravelApiAuth::SIGNATURE_LAPSE -> 签名失效，客户端签名时间和服务端签名时间差超过设置的 timeout 值。
- LaravelApiAuth::SIGNATURE_REPETITION -> 签名重复，规定时间内出现两次或以上相同的签名。

使用

路由中

Route::get('api/example', function(Request $request){
    // $request->get('client_role');
    // todo...
})->middleware(['api_auth']);

\\ or

Route::group(['middleware'=>'api_auth'], function(){
    // routes...
});

通过验证后 $request 会添加一个 client_role 字段，该字段为客户端的角色名称。

前端

import axios from 'axios';

const access_key = '{access_key}';  // 服务端生成的 access_key
const secret_key = '{secret_key}';  // 服务端生成的 secret_key

const timestamp = Date.parse(new Date()) / 1000;    // 取时间戳
const echostr = 'abcdef';      // 随机字符串自行生成

function encrypting(secret_key, echostr, timestamp){
    return md5(secret_key + echostr + timestamp);    // md5 库自行引入
}

const requestConfig = {
    headers: {
        "signature": encrypting(secret_key, echostr, timestamp),
        "echostr": echostr,
        "timestamp": timestamp,
        "access-key": access_key
    }
};

axios.post('/api/example',{},requestConfig).then(res=>{
    // todo
});

本例子为 web 前端的例子，其他客户端同理，生成签名并且带上指定参数即可正常请求。通过自定义签名方法和自定义校验方法，可以使用其他加密方法进行签名，例如 哈希 等其他加密算法。更多自定义可以直接修改 App\Http\Middleware\ApiAuth 中间件。有问题请开 issue 。

dsweixin / api-auth

Maintainers

Details

README

安装

配置

使用

路由中

前端