Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s1syphos/uniform-simple-captcha
Simple captcha guard for 'mzur/kirby-uniform' & Kirby v3
https://github.com/s1syphos/uniform-simple-captcha
Last synced: 1 day ago
JSON representation
Simple captcha guard for 'mzur/kirby-uniform' & Kirby v3
- Host: GitHub
- URL: https://github.com/s1syphos/uniform-simple-captcha
- Owner: S1SYPHOS
- License: mit
- Created: 2022-06-10T18:06:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-10T18:07:19.000Z (over 2 years ago)
- Last Synced: 2024-09-16T10:18:04.717Z (about 2 months ago)
- Language: PHP
- Size: 1.76 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple captcha
This plugin implements a simple captcha guard for Martin Zurowietz' [`kirby-uniform`](https://github.com/mzur/kirby-uniform) plugin for Kirby v3 - dependency-free & GDPR-friendly, powered by [`php-simple-captcha`](https://codeberg.org/S1SYPHOS/php-simple-captcha), a fork of [`Gregwar/Captcha`](https://github.com/Gregwar/Captcha).
**Note:** The generated image uses a data URI as its `src` attribute, everything else is handled by Kirby's [session object](https://getkirby.com/docs/reference/objects/cms/app/session).
## Getting started
Use one of the following methods to install & use `refbw/uniform-simple-captcha`:
### Git submodule
If you know your way around Git, you can download this plugin as a [submodule](https://github.com/blog/2104-working-with-submodules):
```text
git submodule add https://codeberg.org/refbw/uniform-simple-captcha.git site/plugins/uniform-simple-captcha
```
### Composer
```text
composer require s1syphos/refbw/uniform-simple-captcha
```
### Clone or download
1. [Clone](https://codeberg.org/refbw/uniform-simple-captcha.git) or [download](https://codeberg.org/refbw/uniform-simple-captcha/archive/main.zip) this repository.
2. Unzip / Move the folder to `site/plugins`.
## Usage
### Template
There are two helper functions:
- `simpleCaptcha()` for the captcha `img` tag
- `simpleCaptchaField()` for its `input` field
You may use them in your template like so:
```php
# Captcha image
# Vanilla
= simpleCaptcha() ?>
# Custom attributes
= simpleCaptcha(['class' => 'some-class', 'title' => 'solve me!' ]) ?>
# Input field
= simpleCaptchaField() ?>
# Custom `id` (eg for use with a label)
Not so fast!
= simpleCaptchaField('my-captcha', ['class' => 'some-class']) ?>
```
### Controller
After that, you have to enable the guard by calling `simplecaptchaGuard()` on the `$form` object.
For more information, check out the `kirby-uniform` docs on its [magic methods](https://kirby-uniform.readthedocs.io/en/latest/guards/guards/#magic-methods):
```php
$form = new Form();
if ($kirby->request()->is('POST')) {
# Call security
$form->simplecaptchaGuard();
# .. more code
}
```
### Configuration
You may change certain options from your `config.php` globally (`'simple-captcha.optionName'`):
| Option | Type | Default | Description |
| ---------------------- | ------------ | ------------- | ---------------------------------------------------------- |
| `'length'` | int | `5` | Number of characters |
| `'charset'` | string | a-z, A-Z, 0-9 | Allowed characters (as string) |
| `'width'` | int | `150` | Captcha image `width` |
| `'height'` | int | `40` | Captcha image `height` |
| `'fonts'` | string/array | see `fonts` | Path(s) to font file(s) |
| `'distort'` | bool | `true` | Whether to distort the image |
| `'interpolate'` | bool | `true` | Whether to interpolate the image |
| `'maxLinesBehind'` | int | random | Maximum number of lines behind the captcha phrase |
| `'maxLinesFront'` | int | random | Maximum number of lines in front of the captcha phrase |
| `'maxAngle'` | int | `8` | Maximum character angle |
| `'maxOffset'` | int | `5` | Maximum character offset |
| `'bgColor'` | array/string | random | Background color, RGB, HEX or `'transparent'` |
| `'lineColor'` | array/string | random | Line color, RGB or HEX |
| `'textColor'` | array/string | random | Text color, RGB or HEX |
| `'bgImage'` | array/string | none | Path to background image |
| `'applyEffects'` | bool | `true` | Whether to apply (any) effects |
| `'applyNoise'` | bool | `true` | Whether to apply background noise (using random letters) |
| `'noiseFactor'` | int | `2` | Multiples of phrase length to be used for noise generation |
| `'applyPostEffects'` | bool | `true` | Whether to apply post effects |
| `'applyScatterEffect'` | bool | `true` | Whether to enable scatter effect |
| `'randomizeFonts'` | bool | `true` | Whether to use random font for each symbol |
**Note:**
- RGB = array with RGB values, eg `[0, 255, 0]`
- HEX = hexadecimal notation, eg `'#fafafa'`
## License
This plugin is licensed under the [MIT License](LICENSE), but **using Kirby in production** requires you to [buy a license](https://getkirby.com/buy).