laravel-gridCaptcha
Laravel quickly creates a verification code tool similar to Google verification code
laravel 快速创建一个类似于 Google 点图验证码的本地验证码扩展
介绍
laravel-gridCaptcha
生成类似于谷歌点图验证码的小扩展,因为现在PHP大部分生成的验证码,对于恶意者来说很容易识别,而这套小扩展很简单但是对于机器人来说需要进行深度的机器学习,恶意者攻击的成本也就增加了,但是这套小扩展不同于谷歌验证码需要机器学习,只需要在本地配置好相应的文件即可。因为生成的验证码图片都是读取文件进行生成,所以建议使用Redis进行缓存,代码默认有使用缓存。
ps: 如有不足之处,欢迎大佬提出修改意见。
预览
安装
支持 Laravel 8 以上版本:
composer require deletedb/laravel-captcha-grid
配置项说明
- 发布配置文件
php artisan vendor:publish --provider="Deletedb\Laravel\Providers\LaravelServiceProvider"
config/gridcaptcha.php
return [
//生成验证码图片配置
'image' => [
//验证码图片路径
'path' => env('GRID_CAPTCHA_IMAGE_PATH', storage_path('gridcaptcha\image')),
//从验证码图片路径中获取的文件后缀名
'suffix' => env('GRID_CAPTCHA_IMAGE_SUFFIX', 'jpg'),
//生成验证码质量
'quality' => env('GRID_CAPTCHA_IMAGE_QUALITY', 70),
//生产验证码宽
'wide' => env('GRID_CAPTCHA_IMAGE_WIDE', 300),
//生产验证码高
'high' => env('GRID_CAPTCHA_IMAGE_HIGH', 300),
],
//验证码配置
'captcha' => [
//生成的验证码过期时间 单位秒
'validity' => env('GRID_CAPTCHA_IMAGE_VALIDITY', 180),
//验证码缓存的key
'cache_key' => env('GRID_CAPTCHA_IMAGE_CACHE_KEY', 'grid_captcha'),
//验证码生成的key长度
'key_length' => env('GRID_CAPTCHA_IMAGE_KEY_LENGTH', 64),
//自定义效验验证码key字段
'key_string' => env('GRID_CAPTCHA_IMAGE_KEY_STRING', 'captcha_key'),
//自定义效验验证码code字段
'code_string' => env('GRID_CAPTCHA_IMAGE_CODE_STRING', 'captcha_code'),
],
];
使用
- 生成验证码
namespace App\Http\Controllers;
class TestController extends Controller
{
/**
* 辅助函数生成验证码
* @return array
*/
public function helpers()
{
return grid_captcha([
'mobile' => '100xxxxx121'
]);
}
/**
* 门面方式生成验证码
* @return array
*/
public function facade()
{
return \Deletedb\Laravel\Facades\GridCaptcha::get([
'mobile' => '100xxxxx121'
]);
}
/**
* 对象方式生成验证码
* @return array
*/
public function object()
{
$captcha = new \Deletedb\Laravel\GridCaptcha();
return $captcha->get([
'mobile' => '100xxxxx121'
]);
}
}
- 生成结果
{
"hint": "猴子",//提示文本
"captcha_key": "Qh8kHYF4C....",//验证码key
"image": "data:image/jpeg;base64,/9j/...."//base64验证码图片 -- 前端渲染显示
}
- 效验验证码
<div> <img src="data:image/jpeg;base64...." width="300" height="300" alt="" style="display: block;"> <div id="0">div> <div id="1">div> <div id="2">div> <div id="3">div> <div id="4">div> <div id="5">div> <div id="6">div> <div id="7">div> <div id="8">div> div>
namespace App\Http\Controllers;
use Illuminate\Http\Request;
class TestController extends Controller
{
/**
* 辅助函数方式效验
* @param Request $request
* @return array|false|\Illuminate\Http\JsonResponse
*/
public function helpersCheck(Request $request)
{
/**
* 传参效验
*/
if ($captcha_data = grid_captcha()->check('Qh8kHYF4C....', '1540') === false) {
return response()->json(['message' => '验证码错误', 'code' => 401]);
}
/**
* 传递 Request 对象效验
*/
if ($captcha_data = grid_captcha()->checkRequest($request)) {
return response()->json(['message' => '验证码错误', 'code' => 401]);
}
return $captcha_data;
}
/**
* 门面方式效验
* @param Request $request
* @return array|false|\Illuminate\Http\JsonResponse
*/
public function facadeCheck(Request $request)
{
/**
* 传参效验
*/
if ($captcha_data = \Deletedb\Laravel\Facades\GridCaptcha::check('Qh8kHYF4C....', '1540') === false) {
return response()->json(['message' => '验证码错误', 'code' => 401]);
}
/**
* 传递 Request 对象效验
*/
if ($captcha_data = \Deletedb\Laravel\Facades\GridCaptcha::checkRequest($request)) {
return response()->json(['message' => '验证码错误', 'code' => 401]);
}
return $captcha_data;
}
/**
* 对象方式效验
* @param Request $request
* @return array|false|\Illuminate\Http\JsonResponse
*/
public function objectCheck(Request $request)
{
$captcha = new \Deletedb\Laravel\GridCaptcha();
/**
* 传参效验
*/
if ($captcha_data = $captcha->check('Qh8kHYF4C....', '1540') === false) {
return response()->json(['message' => '验证码错误', 'code' => 401]);
}
/**
* 传递 Request 对象效验
*/
if ($captcha_data = $captcha->checkRequest($request)) {
return response()->json(['message' => '验证码错误', 'code' => 401]);
}
return $captcha_data;
}
}
//效验完成正确后 您可以进行业务逻辑处理,比如可以获取到上方设置在验证码中的数据 如:上方设置的是手机号,您这里可以获取验证码中的手机号,当效验成功发送短信验证码等...
- 效验成功返回: 返回的是您在生成验证时传递的数据,默认返回空数组
- 效验失败返回: false
{
"mobile" : "100xxxxx121"
}
- 本地化提示
resources/lang/zh_CN/grid-captcha.php
//一个图片目录对应一个提示
return [
'banmaxian' => '斑马线',
'gongjiaoche' => '公交车',
'heiban' => '黑板',
'honglvdeng' => '红绿灯',
'hongzao' => '红枣',
'houzi' => '猴子',
'qianbi' => '铅笔',
'shutiao' => '薯条',
'xiaofangshuan' => '消防栓',
'zhenglong' => '蒸笼',
];
-
新增验证码图片
例:新增一个类型为
pingguo
验证码类型的图片,需要在配置文件中的image.path
目录下创建名为pingguo
的目录并且把相关类型的图片文件存放在pingguo
目录,新增一个类型至少要有四张相关类型的图片,不限制文件名,只要文件后缀名是配置文件中指定的即可如下:
─storage
└─gridcaptcha
└─image
├─pingguo
│ 1.jpg
│ 10.jpg
│ 11.jpg
│ 12.jpg
│ 13.jpg
特别说明
因为读取文件是缓存消耗I/O的操作所以我推荐使用Redis进行缓存,此工具默认使用了缓存,缓存有当前验证码图片目录信息、图片;使用Redis缓存只需要在 .env
文件修改 CACHE_DRIVER=redis
,并且添加Redis配置即可;在添加新分类之后建议删除之前的缓存,如果不进行删除将在缓存过期后自动更新。
License
MIT