-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathreadme.txt
100 lines (58 loc) · 4.11 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
=== Really Simple CAPTCHA ===
Contributors: takayukister
Donate link: https://contactform7.com/donate/
Tags: captcha
Requires at least: 6.6
Tested up to: 6.7
Stable tag: 2.3
Requires PHP: 7.4
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Really Simple CAPTCHA is a CAPTCHA module intended to be called from other plugins. It is originally created for my Contact Form 7 plugin.
== Description ==
Really Simple CAPTCHA does not work alone and is intended to work with other plugins. It is originally created for [Contact Form 7](https://contactform7.com/), however, you can use it with your own plugin.
Note: This product is "really simple" as its name suggests, i.e., it is not strongly secure. If you need perfect security, you should try other solutions.
= How does it work? =
Really Simple CAPTCHA does not use PHP "Sessions" for storing states, unlike many other PHP CAPTCHA solutions, but stores them as temporary files. This allows you to embed it into WordPress without worrying about conflicts.
When you generate a CAPTCHA, Really Simple CAPTCHA creates two files for it; one is an image file of CAPTCHA, and the other is a text file which stores the correct answer to the CAPTCHA.
The two files have the same (random) prefix in their file names, for example, "a7hk3ux8p.png" and "a7hk3ux8p.txt." In this case, for example, when the respondent answers "K5GF" as an answer to the "a7hk3ux8p.png" image, then Really Simple CAPTCHA calculates hash of "K5GF" and tests it against the hash stored in the "a7hk3ux8p.txt" file. If the two match, the answer is confirmed as correct.
= How to use with your plugin =
Note: Below are instructions for plugin developers.
First, create an instance of ReallySimpleCaptcha class:
$captcha_instance = new ReallySimpleCaptcha();
You can change the instance variables as you wish.
// Change the background color of CAPTCHA image to black
$captcha_instance->bg = array( 0, 0, 0 );
See really-simple-captcha.php if you are interested in other variables.
Generate a random word for CAPTCHA.
$word = $captcha_instance->generate_random_word();
Generate an image file and a corresponding text file in the temporary directory.
$prefix = wp_rand();
$captcha_instance->generate_image( $prefix, $word );
Then, show the image and get an answer from respondent.
Check the correctness of the answer.
$correct = $captcha_instance->check( $prefix, $the_answer_from_respondent );
If the $correct is true, go ahead. Otherwise, block the respondent -- as it would appear not to be human.
And last, remove the temporary image and text files, as they are no longer in use.
$captcha_instance->remove( $prefix );
That's all.
If you wish to see a live sample of this, you can try [Contact Form 7](https://contactform7.com/captcha/).
== Installation ==
In most cases you can install automatically from WordPress.
However, if you install this manually, follow these steps:
1. Upload the entire `really-simple-captcha` folder to the `/wp-content/plugins/` directory.
1. Activate the plugin through the 'Plugins' menu in WordPress.
FYI: There is no "control panel" for this plugin.
== Frequently Asked Questions ==
= CAPTCHA does not work; the image does not show up. =
Really Simple CAPTCHA needs GD and FreeType library installed on your server. Ask your server administrator if they are installed.
Also, make the temporary file folder writable. The location of the temporary file folder is managed by the instance variable `tmp_dir` of ReallySimpleCaptcha class. Note that the setting varies depending on the calling plugin. For example, Contact Form 7 uses `wp-contents/uploads/wpcf7_captcha` as the temporary folder basically, but it can use different folder depending on your settings.
If you have any further questions, please submit them [to the support forum](https://wordpress.org/support/plugin/really-simple-captcha).
== Screenshots ==
1. screenshot-1.png
== Changelog ==
= 2.4 =
* Bumps up the minimum required WordPress version to 6.6.
* Introduces the ReallySimpleCaptcha_Filesystem trait.
* Uses SHA-256 as the hash algorithm.
* Uses `wp_rand()` instead of `mt_rand()`.