refbw/uniform-simple-captcha

Simple captcha guard for 'mzur/kirby-uniform' & Kirby v3

2.1.1 2022-05-16 08:49 UTC

Requires

• getkirby/composer-installer: ^1.1
• mzur/kirby-uniform: ^5.0
• s1syphos/php-simple-captcha: ^2.1

MIT

README

This plugin implements a simple captcha guard for Martin Zurowietz' kirby-uniform plugin for Kirby v3 - dependency-free & GDPR-friendly, powered by php-simple-captcha, a fork of Gregwar/Captcha.

Note: The generated image uses a data URI as its src attribute, everything else is handled by Kirby's session object.

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:

git submodule add https://codeberg.org/refbw/uniform-simple-captcha.git site/plugins/uniform-simple-captcha

Composer

composer require s1syphos/refbw/uniform-simple-captcha

Clone or download

1. Clone or download 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:

# Captcha image
# Vanilla
<?= simpleCaptcha() ?>

# Custom attributes
<?= simpleCaptcha(['class' => 'some-class', 'title' => 'solve me!' ]) ?>

# Input field
<?= simpleCaptchaField() ?>

# Custom `id` (eg for use with a label)
<label for="my-captcha">Not so fast!</label>
<?= 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:

$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, but using Kirby in production requires you to buy a license.