Skip to content

Latest commit

 

History

History
129 lines (93 loc) · 4.26 KB

README.md

File metadata and controls

129 lines (93 loc) · 4.26 KB
Raw

Laravel Geetest Captcha, the best alternative to Google reCaptcha

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

Laravel Geetest Captcha is a package that provides a simple way to integrate Geetest Captcha in your Laravel application.

20240705-122929d

Support us

Does your business depend on our contributions? Reach out and support us on Github sponsor. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.

Installation

  1. You can install the package via composer:
composer require salahhusa9/laravel-geetest-captcha
  1. You need to add @geetestCaptchaAssets() in head tag in your layout file:
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
    @geetestCaptchaAssets()
</head>
<body>
    ...
</body>
</html>
  1. Sign up and activate your GeeTest account on the official website
  2. Create an ID and Key on the dashboard
  3. add GEETEST_ID and GEETEST_KEY in .env file

Usage

Use in form

You can use in form like this:

In first add @geetestCaptchaInit('captcha-id') in footer of page as script tag, captcha-id is the id of the captcha div.

<form method="POST" action="{{ route('login') }}">
    @csrf
    <div class="form-group">
        <label for="email">Email</label>
        <input type="email" name="email" id="email" class="form-control" required>
    </div>
    <div class="form-group">
        <label for="password">Password</label>
        <input type="password" name="password" id="password" class="form-control" required>
    </div>
    <div class="form-group">
        <div id="captcha-id">
            <!-- hire we render geetest captcha -->
        </div>
    </div>
    <button type="submit" class="btn btn-primary">Login</button>
</form>

@geetestCaptchaInit('captcha-id')

and for validation you can use geetest_captcha rule in your controller like this:

use Salahhusa9\GeetestCaptcha\Rules\GeetestCaptchaValidate;

public function login(Request $request)
{
    $request->validate([
        'email' => 'required|email',
        'password' => 'required',
        'geetest_captcha' => ['required', new GeetestCaptchaValidate]
    ]);

    // your logic
}

Validate via middleware

You can use in middleware like this:

    use Salahhusa9\GeetestCaptcha\Http\Middleware\ValidateGeetestCaptcha;

    Route::post('login', [LoginController::class, 'login'])->middleware(ValidateGeetestCaptcha::class);

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.