-
Notifications
You must be signed in to change notification settings - Fork 9
/
securimage.php
2229 lines (1937 loc) · 71.6 KB
/
securimage.php
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
// error_reporting(E_ALL); ini_set('display_errors', 1); // uncomment this line for debugging
/**
* Project: Securimage: A PHP class dealing with CAPTCHA images, audio, and validation
* File: securimage.php
*
* Copyright (c) 2017, Drew Phillips
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* Any modifications to the library should be indicated clearly in the source code
* to inform users that the changes are not a part of the original software.
*
* If you found this script useful, please take a quick moment to rate it.
* http://www.hotscripts.com/rate/49400.html Thanks.
*
* @link http://www.phpcaptcha.org Securimage PHP CAPTCHA
* @link http://www.phpcaptcha.org/latest.zip Download Latest Version
* @link http://www.phpcaptcha.org/Securimage_Docs/ Online Documentation
* @copyright 2017 Drew Phillips
* @author Drew Phillips <[email protected]>
* @version 3.6.6 (Nov 20 2017)
* @package Securimage
*
*/
/**
ChangeLog
3.6.6
- Not critical: Fix potential HTML injection in example form via HTTP_USER_AGENT (CVE-2017-14077)
3.6.5
- Fix regex in replaceElements in securimage.js
- Update examples
- Exclude certain examples from Git autogenerated archives
3.6.4
- Fix XSS vulnerability in example_form.ajax.php (Discovered by RedTeam. advisory rt-sa-2016-002)
- Update example_form.ajax.php to use Securimage::getCaptchaHtml()
3.6.3
- Add support for multibyte wordlist files
- Fix code generation issues with UTF-8 charsets
- Add parameter to getCaptchaHtml() method to control display components of captcha HTML
- Fix database audio storage issue with multiple namespaces
3.6.2
- Support HTTP range requests with audio playback (iOS requirement)
- Add optional config.inc.php for storing global configuration settings
3.6.1
- Fix copyElement bug in securimage.js for IE Flash fallback
3.6
- Implement CAPTCHA audio using HTML5 <audio> with optional Flash fallback
- Support MP3 audio using LAME MP3 Encoder (Internet Explorer 9+ does not support WAV format in <audio> tags)
- Add getCaptchaHtml() options to support full framework integration (ruifil)
3.5.4
- Fix email validation code in example form files
- Fix backslashes in getCaptchaHtml for img attribute on Windows systems
3.5.3
- Add options for audio button to getCaptchaHtml(), fix urlencoding of flash parameters that was breaking button
3.5.2
- Add Securimage::getCaptchaHtml() for getting automatically generated captcha html code
- Option for using SoX to add effects to captcha audio to make identification by neural networks more difficult
- Add setNamespace() method
- Add getTimeToSolve() method
- Add session_status() check so session still starts if one had previously been opened and closed
- Add .htaccess file to audio directory to deny access; update audio files
- Option to skip checking of database tables during connection
- Add composer.json to package, submit to packagist
- Add font_ratio variable to determine size of font (github.com/wilkor)
- Add hint if sqlite3 database is not writeable. Improve database error handling, add example database options to securimage_play.php
- Fixed issue regarding database storage and math captcha breaking audio output (github.com/SoftwareAndOutsourcing)
3.5.1
- Fix XSS vulnerability in example_form.php (discovered by Gjoko Krstic - <[email protected]>)
3.5
- Release new version
- MB string support for charlist
- Modify audio file path to use language directories
- Changed default captcha appearance
3.2RC4
- Add MySQL, PostgreSQL, and SQLite3 support for database storage
- Deprecate "use_sqlite_db" option and remove SQLite2/sqlite_* functions
- Add new captcha type that displays 2 dictionary words on one image
- Update examples
3.2RC3
- Fix canSendHeaders() check which was breaking if a PHP startup error was issued
3.2RC2
- Add error handler (https://github.com/dapphp/securimage/issues/15)
- Fix flash examples to use the correct value name for audio parameter
3.2RC1
- New audio captcha code. Faster, fully dynamic audio, full WAV support
(Paul Voegler, Drew Phillips) <http://voegler.eu/pub/audio>
- New Flash audio streaming button. User defined image and size supported
- Additional options for customizing captcha (noise_level, send_headers,
no_exit, no_session, display_value
- Add captcha ID support. Uses sqlite and unique captcha IDs to track captchas,
no session used
- Add static methods for creating and validating captcha by ID
- Automatic clearing of old codes from SQLite database
3.0.3Beta
- Add improved mixing function to WavFile class (Paul Voegler)
- Improve performance and security of captcha audio (Paul Voegler, Drew Phillips)
- Add option to use random file as background noise in captcha audio
- Add new securimage options for audio files
3.0.2Beta
- Fix issue with session variables when upgrading from 2.0 - 3.0
- Improve audio captcha, switch to use WavFile class, make mathematical captcha audio work
3.0.1
- Bugfix: removed use of deprecated variable in addSignature method that would cause errors with display_errors on
3.0
- Rewrite class using PHP5 OOP
- Remove support for GD fonts, require FreeType
- Remove support for multi-color codes
- Add option to make codes case-sensitive
- Add namespaces to support multiple captchas on a single page or page specific captchas
- Add option to show simple math problems instead of codes
- Remove support for mp3 files due to vulnerability in decoding mp3 audio files
- Create new flash file to stream wav files instead of mp3
- Changed to BSD license
2.0.2
- Fix pathing to make integration into libraries easier (Nathan Phillip Brink [email protected])
2.0.1
- Add support for browsers with cookies disabled (requires php5, sqlite) maps users to md5 hashed ip addresses and md5 hashed codes for security
- Add fallback to gd fonts if ttf support is not enabled or font file not found (Mike Challis http://www.642weather.com/weather/scripts.php)
- Check for previous definition of image type constants (Mike Challis)
- Fix mime type settings for audio output
- Fixed color allocation issues with multiple colors and background images, consolidate allocation to one function
- Ability to let codes expire after a given length of time
- Allow HTML color codes to be passed to Securimage_Color (suggested by Mike Challis)
2.0.0
- Add mathematical distortion to characters (using code from HKCaptcha)
- Improved session support
- Added Securimage_Color class for easier color definitions
- Add distortion to audio output to prevent binary comparison attack (proposed by Sven "SavageTiger" Hagemann [insecurity.nl])
- Flash button to stream mp3 audio (Douglas Walsh www.douglaswalsh.net)
- Audio output is mp3 format by default
- Change font to AlteHaasGrotesk by yann le coroller
- Some code cleanup
1.0.4 (unreleased)
- Ability to output audible codes in mp3 format to stream from flash
1.0.3.1
- Error reading from wordlist in some cases caused words to be cut off 1 letter short
1.0.3
- Removed shadow_text from code which could cause an undefined property error due to removal from previous version
1.0.2
- Audible CAPTCHA Code wav files
- Create codes from a word list instead of random strings
1.0
- Added the ability to use a selected character set, rather than a-z0-9 only.
- Added the multi-color text option to use different colors for each letter.
- Switched to automatic session handling instead of using files for code storage
- Added GD Font support if ttf support is not available. Can use internal GD fonts or load new ones.
- Added the ability to set line thickness
- Added option for drawing arced lines over letters
- Added ability to choose image type for output
*/
/**
* Securimage CAPTCHA Class.
*
* A class for creating and validating secure CAPTCHA images and audio.
*
* The class contains many options regarding appearance, security, storage of
* captcha data and image/audio generation options.
*
* @package Securimage
* @subpackage classes
* @author Drew Phillips <[email protected]>
*
*/
class Securimage
{
// All of the public variables below are securimage options
// They can be passed as an array to the Securimage constructor, set below,
// or set from securimage_show.php and securimage_play.php
/**
* Constant for rendering captcha as a JPEG image
* @var int
*/
const SI_IMAGE_JPEG = 1;
/**
* Constant for rendering captcha as a PNG image (default)
* @var int
*/
const SI_IMAGE_PNG = 2;
/**
* Constant for rendering captcha as a GIF image
* @var int
*/
const SI_IMAGE_GIF = 3;
/**
* Constant for generating a normal alphanumeric captcha based on the
* character set
*
* @see Securimage::$charset charset property
* @var int
*/
const SI_CAPTCHA_STRING = 0;
/**
* Constant for generating a captcha consisting of a simple math problem
*
* @var int
*/
const SI_CAPTCHA_MATHEMATIC = 1;
/**
* Constant for generating a word based captcha using 2 words from a list
*
* @var int
*/
const SI_CAPTCHA_WORDS = 2;
/**
* MySQL option identifier for database storage option
*
* @var string
*/
const SI_DRIVER_MYSQL = 'mysql';
/**
* PostgreSQL option identifier for database storage option
*
* @var string
*/
const SI_DRIVER_PGSQL = 'pgsql';
/**
* SQLite option identifier for database storage option
*
* @var string
*/
const SI_DRIVER_SQLITE3 = 'sqlite';
/**
* getCaptchaHtml() display constant for HTML Captcha Image
*
* @var integer
*/
const HTML_IMG = 1;
/**
* getCaptchaHtml() display constant for HTML5 Audio code
*
* @var integer
*/
const HTML_AUDIO = 2;
/**
* getCaptchaHtml() display constant for Captcha Input text box
*
* @var integer
*/
const HTML_INPUT = 4;
/**
* getCaptchaHtml() display constant for Captcha Text HTML label
*
* @var integer
*/
const HTML_INPUT_LABEL = 8;
/**
* getCaptchaHtml() display constant for HTML Refresh button
*
* @var integer
*/
const HTML_ICON_REFRESH = 16;
/**
* getCaptchaHtml() display constant for all HTML elements (default)
*
* @var integer
*/
const HTML_ALL = 0xffffffff;
/*%*********************************************************************%*/
// Properties
/**
* The width of the captcha image
* @var int
*/
public $image_width = 215;
/**
* The height of the captcha image
* @var int
*/
public $image_height = 80;
/**
* Font size is calculated by image height and this ratio. Leave blank for
* default ratio of 0.4.
*
* Valid range: 0.1 - 0.99.
*
* Depending on image_width, values > 0.6 are probably too large and
* values < 0.3 are too small.
*
* @var float
*/
public $font_ratio;
/**
* The type of the image, default = png
*
* @see Securimage::SI_IMAGE_PNG SI_IMAGE_PNG
* @see Securimage::SI_IMAGE_JPEG SI_IMAGE_JPEG
* @see Securimage::SI_IMAGE_GIF SI_IMAGE_GIF
* @var int
*/
public $image_type = self::SI_IMAGE_PNG;
/**
* The background color of the captcha
* @var Securimage_Color|string
*/
public $image_bg_color = '#ffffff';
/**
* The color of the captcha text
* @var Securimage_Color|string
*/
public $text_color = '#707070';
/**
* The color of the lines over the captcha
* @var Securimage_Color|string
*/
public $line_color = '#707070';
/**
* The color of the noise that is drawn
* @var Securimage_Color|string
*/
public $noise_color = '#707070';
/**
* How transparent to make the text.
*
* 0 = completely opaque, 100 = invisible
*
* @var int
*/
public $text_transparency_percentage = 20;
/**
* Whether or not to draw the text transparently.
*
* true = use transparency, false = no transparency
*
* @var bool
*/
public $use_transparent_text = true;
/**
* The length of the captcha code
* @var int
*/
public $code_length = 6;
/**
* Whether the captcha should be case sensitive or not.
*
* Not recommended, use only for maximum protection.
*
* @var bool
*/
public $case_sensitive = false;
/**
* The character set to use for generating the captcha code
* @var string
*/
public $charset = 'ABCDEFGHKLMNPRSTUVWYZabcdefghklmnprstuvwyz23456789';
/**
* How long in seconds a captcha remains valid, after this time it will be
* considered incorrect.
*
* @var int
*/
public $expiry_time = 900;
/**
* The session name securimage should use.
*
* Only use if your application uses a custom session name (e.g. Joomla).
* It is recommended to set this value here so it is used by all securimage
* scripts (i.e. securimage_show.php)
*
* @var string
*/
public $session_name = null;
/**
* true to use the wordlist file, false to generate random captcha codes
* @var bool
*/
public $use_wordlist = false;
/**
* The level of distortion.
*
* 0.75 = normal, 1.0 = very high distortion
*
* @var double
*/
public $perturbation = 0.85;
/**
* How many lines to draw over the captcha code to increase security
* @var int
*/
public $num_lines = 5;
/**
* The level of noise (random dots) to place on the image, 0-10
* @var int
*/
public $noise_level = 2;
/**
* The signature text to draw on the bottom corner of the image
* @var string
*/
public $image_signature = '';
/**
* The color of the signature text
* @var Securimage_Color|string
*/
public $signature_color = '#707070';
/**
* The path to the ttf font file to use for the signature text.
* Defaults to $ttf_file (AHGBold.ttf)
*
* @see Securimage::$ttf_file
* @var string
*/
public $signature_font;
/**
* No longer used.
*
* Use an SQLite database to store data (for users that do not support cookies)
*
* @var bool
* @see Securimage::$database_driver database_driver property
* @deprecated 3.2RC4
*/
public $use_sqlite_db = false;
/**
* Use a database backend for code storage.
* Provides a fallback to users with cookies disabled.
* Required when using captcha IDs.
*
* @see Securimage::$database_driver
* @var bool
*/
public $use_database = false;
/**
* Whether or not to skip checking if Securimage tables exist when using a
* database.
*
* Turn this to true once database functionality is working to improve
* performance.
*
* @var bool true to not check if captcha_codes tables are set up, false
* to check (and create if necessary)
*/
public $skip_table_check = false;
/**
* Database driver to use for database support.
* Allowable values: *mysql*, *pgsql*, *sqlite*.
* Default: sqlite
*
* @var string
*/
public $database_driver = self::SI_DRIVER_SQLITE3;
/**
* Database host to connect to when using mysql or postgres
*
* On Linux use "localhost" for Unix domain socket, otherwise uses TCP/IP
*
* Does not apply to SQLite
*
* @var string
*/
public $database_host = 'localhost';
/**
* Database username for connection (mysql, postgres only)
* Default is an empty string
*
* @var string
*/
public $database_user = '';
/**
* Database password for connection (mysql, postgres only)
* Default is empty string
*
* @var string
*/
public $database_pass = '';
/**
* Name of the database to select (mysql, postgres only)
*
* @see Securimage::$database_file for SQLite
* @var string
*/
public $database_name = '';
/**
* Database table where captcha codes are stored
*
* Note: Securimage will attempt to create this table for you if it does
* not exist. If the table cannot be created, an E_USER_WARNING is emitted
*
* @var string
*/
public $database_table = 'captcha_codes';
/**
* Fully qualified path to the database file when using SQLite3.
*
* This value is only used when $database_driver == sqlite and does
* not apply when no database is used, or when using MySQL or PostgreSQL.
*
* On *nix, file must have permissions of 0666.
*
* **Make sure the directory containing this file is NOT web accessible**
*
* @var string
*/
public $database_file;
/**
* The type of captcha to create.
*
* Either alphanumeric based on *charset*, a simple math problem, or an
* image consisting of 2 words from the word list.
*
* @see Securimage::SI_CAPTCHA_STRING SI_CAPTCHA_STRING
* @see Securimage::SI_CAPTCHA_MATHEMATIC SI_CAPTCHA_MATHEMATIC
* @see Securimage::SI_CAPTCHA_WORDS SI_CAPTCHA_WORDS
* @see Securimage::$charset charset property
* @see Securimage::$wordlist_file wordlist_file property
* @var int
*/
public $captcha_type = self::SI_CAPTCHA_STRING; // or self::SI_CAPTCHA_MATHEMATIC, or self::SI_CAPTCHA_WORDS;
/**
* The captcha namespace used for having multiple captchas on a page or
* to separate captchas from differen forms on your site.
* Example:
*
* <?php
* // use <img src="securimage_show.php?namespace=contact_form">
* // or manually in securimage_show.php
* $img->setNamespace('contact_form');
*
* // in form validator
* $img->setNamespace('contact_form');
* if ($img->check($code) == true) {
* echo "Valid!";
* }
*
* @var string
*/
public $namespace;
/**
* The TTF font file to use to draw the captcha code.
*
* Leave blank for default font AHGBold.ttf
*
* @var string
*/
public $ttf_file;
/**
* The path to the wordlist file to use.
*
* Leave blank for default words/words.txt
*
* @var string
*/
public $wordlist_file;
/**
* Character encoding of the wordlist file.
* Requires PHP Multibyte String (mbstring) support.
* Allows word list to contain characters other than US-ASCII (requires compatible TTF font).
*
* @var string The character encoding (e.g. UTF-8, UTF-7, EUC-JP, GB2312)
* @see http://php.net/manual/en/mbstring.supported-encodings.php
* @since 3.6.3
*/
public $wordlist_file_encoding = null;
/**
* The directory to scan for background images, if set a random background
* will be chosen from this folder
*
* @var string
*/
public $background_directory;
/**
* No longer used
*
* The path to the SQLite database file to use
*
* @deprecated 3.2RC4
* @see Securimage::$database_file database_file property
* @var string
*/
public $sqlite_database;
/**
* The path to the audio files to be used for audio captchas.
*
* Can also be set in securimage_play.php
*
* Example:
*
* $img->audio_path = '/home/yoursite/public_html/securimage/audio/en/';
*
* @var string
*/
public $audio_path;
/**
* Use SoX (The Swiss Army knife of audio manipulation) for audio effects
* and processing.
*
* Using SoX should make it more difficult for bots to solve audio captchas
*
* @see Securimage::$sox_binary_path sox_binary_path property
* @var bool true to use SoX, false to use PHP
*/
public $audio_use_sox = false;
/**
* The path to the SoX binary on your system
*
* @var string
*/
public $sox_binary_path = '/usr/bin/sox';
/**
* The path to the lame (mp3 encoder) binary on your system
* Static so that Securimage::getCaptchaHtml() has access to this value.
*
* @since 3.6
* @var string
*/
public static $lame_binary_path = '/usr/bin/lame';
/**
* The path to the directory containing audio files that will be selected
* randomly and mixed with the captcha audio.
*
* @var string
*/
public $audio_noise_path;
/**
* Whether or not to mix background noise files into captcha audio
*
* Mixing random background audio with noise can help improve security of
* audio captcha.
*
* Default: securimage/audio/noise
*
* @since 3.0.3
* @see Securimage::$audio_noise_path audio_noise_path property
* @var bool true = mix, false = no
*/
public $audio_use_noise;
/**
* The method and threshold (or gain factor) used to normalize the mixing
* with background noise.
*
* See http://www.voegler.eu/pub/audio/ for more information.
*
* Default: 0.6
*
* Valid:
* >= 1
* Normalize by multiplying by the threshold (boost - positive gain).
* A value of 1 in effect means no normalization (and results in clipping).
*
* <= -1
* Normalize by dividing by the the absolute value of threshold (attenuate - negative gain).
* A factor of 2 (-2) is about 6dB reduction in volume.
*
* [0, 1) (open inverval - not including 1)
* The threshold above which amplitudes are comressed logarithmically.
* e.g. 0.6 to leave amplitudes up to 60% "as is" and compressabove.
*
* (-1, 0) (open inverval - not including -1 and 0)
* The threshold above which amplitudes are comressed linearly.
* e.g. -0.6 to leave amplitudes up to 60% "as is" and compress above.
*
* @since 3.0.4
* @var float
*/
public $audio_mix_normalization = 0.8;
/**
* Whether or not to degrade audio by introducing random noise.
*
* Current research shows this may not increase the security of audible
* captchas.
*
* Default: true
*
* @since 3.0.3
* @var bool
*/
public $degrade_audio;
/**
* Minimum delay to insert between captcha audio letters in milliseconds
*
* @since 3.0.3
* @var float
*/
public $audio_gap_min = 0;
/**
* Maximum delay to insert between captcha audio letters in milliseconds
*
* @since 3.0.3
* @var float
*/
public $audio_gap_max = 3000;
/**
* Captcha ID if using static captcha
* @var string Unique captcha id
*/
protected static $_captchaId = null;
/**
* The GD image resource of the captcha image
*
* @var resource
*/
public $im;
/**
* A temporary GD image resource of the captcha image for distortion
*
* @var resource
*/
protected $tmpimg;
/**
* The background image GD resource
* @var string
*/
protected $bgimg;
/**
* Scale factor for magnification of distorted captcha image
*
* @var int
*/
protected $iscale = 5;
/**
* Absolute path to securimage directory.
*
* This is calculated at runtime
*
* @var string
*/
public $securimage_path = null;
/**
* The captcha challenge value.
*
* Either the case-sensitive/insensitive word captcha, or the solution to
* the math captcha.
*
* @var string|bool Captcha challenge value
*/
protected $code;
/**
* The display value of the captcha to draw on the image
*
* Either the word captcha or the math equation to present to the user
*
* @var string Captcha display value to draw on the image
*/
protected $code_display;
/**
* Alternate text to draw as the captcha image text
*
* A value that can be passed to the constructor that can be used to
* generate a captcha image with a given value.
*
* This value does not get stored in the session or database and is only
* used when calling Securimage::show().
*
* If a display_value was passed to the constructor and the captcha image
* is generated, the display_value will be used as the string to draw on
* the captcha image.
*
* Used only if captcha codes are generated and managed by a 3rd party
* app/library
*
* @var string Captcha code value to display on the image
*/
public $display_value;
/**
* Captcha code supplied by user [set from Securimage::check()]
*
* @var string
*/
protected $captcha_code;
/**
* Time (in seconds) that the captcha was solved in (correctly or incorrectly).
*
* This is from the time of code creation, to when validation was attempted.
*
* @var int
*/
protected $_timeToSolve = 0;
/**
* Flag that can be specified telling securimage not to call exit after
* generating a captcha image or audio file
*
* @var bool If true, script will not terminate; if false script will terminate (default)
*/
protected $no_exit;
/**
* Flag indicating whether or not a PHP session should be started and used
*
* @var bool If true, no session will be started; if false, session will be started and used to store data (default)
*/
protected $no_session;
/**
* Flag indicating whether or not HTTP headers will be sent when outputting
* captcha image/audio
*
* @var bool If true (default) headers will be sent, if false, no headers are sent
*/
protected $send_headers;
/**
* PDO connection when a database is used
*
* @var PDO|bool
*/
protected $pdo_conn;
/**
* The GD color for the background color
*
* @var int
*/
protected $gdbgcolor;
/**
* The GD color for the text color
*
* @var int
*/
protected $gdtextcolor;
/**
* The GD color for the line color
*
* @var int
*/
protected $gdlinecolor;
/**
* The GD color for the signature text color
*
* @var int
*/
protected $gdsignaturecolor;
/**
* Create a new securimage object, pass options to set in the constructor.
*
* The object can then be used to display a captcha, play an audible captcha, or validate a submission.
*
* @param array $options Options to initialize the class. May be any class property.
*
* $options = array(
* 'text_color' => new Securimage_Color('#013020'),
* 'code_length' => 5,
* 'num_lines' => 5,
* 'noise_level' => 3,
* 'font_file' => Securimage::getPath() . '/custom.ttf'
* );
*
* $img = new Securimage($options);
*
*/
public function __construct($options = array())
{
$this->securimage_path = dirname(__FILE__);
if (!is_array($options)) {
trigger_error(
'$options passed to Securimage::__construct() must be an array. ' .
gettype($options) . ' given',
E_USER_WARNING
);
$options = array();
}
// check for and load settings from custom config file
if (file_exists(dirname(__FILE__) . '/config.inc.php')) {
$settings = include dirname(__FILE__) . '/config.inc.php';
if (is_array($settings)) {
$options = array_merge($settings, $options);
}
}
if (is_array($options) && sizeof($options) > 0) {
foreach($options as $prop => $val) {
if ($prop == 'captchaId') {