.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Captcha::reCAPTCHA 3pm"
.TH Captcha::reCAPTCHA 3pm "2022-11-19" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Captcha::reCAPTCHA \- A Perl implementation of the reCAPTCHA API
.SH "VERSION"
.IX Header "VERSION"
This document describes Captcha::reCAPTCHA version 0.98
.SH "NOTICE"
.IX Header "NOTICE"
Please note this module now allows the use of v2
there are no changes to version 1.
Version 2 has separate methds you can call
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Note this release contains methods that use
.PP
.Vb 1
\&    use Captcha::reCAPTCHA;
\&
\&    my $c = Captcha::reCAPTCHA\->new;
\&
\&    # Output form New Version
\&    print $c\->get_html_v2( \*(Aqyour public key here\*(Aq );
\&
\&    # Version 1 (not recommended)
\&    print $c\->get_html( \*(Aqyour public key here\*(Aq );
\&
\&    # Verify submission
\&    my $result $c\->check_answer_v2($private_key, $response, $ENV{REMOTE_ADDR});
\&
\&    # Verify submission (Old Version)
\&    my $result = $c\->check_answer(
\&        \*(Aqyour private key here\*(Aq, $ENV{\*(AqREMOTE_ADDR\*(Aq},
\&        $challenge, $response
\&    );
\&
\&    if ( $result\->{is_valid} ) {
\&        print "Yes!";
\&    }
\&    else {
\&        # Error
\&        $error = $result\->{error};
\&    }
.Ve
.PP
For complete examples see the /examples subdirectory
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
reCAPTCHA version 1 is a hybrid mechanical turk and captcha that allows visitors
who complete the captcha to assist in the digitization of books.
.PP
From <http://recaptcha.net/learnmore.html>:
.PP
.Vb 6
\&    reCAPTCHA improves the process of digitizing books by sending words that
\&    cannot be read by computers to the Web in the form of CAPTCHAs for
\&    humans to decipher. More specifically, each word that cannot be read
\&    correctly by OCR is placed on an image and used as a CAPTCHA. This is
\&    possible because most OCR programs alert you when a word cannot be read
\&    correctly.
.Ve
.PP
version 1 of Perl implementation is modelled on the \s-1PHP\s0 interface that can be
found here:
.PP
<http://recaptcha.net/plugins/php/>
.PP
To use reCAPTCHA you need to register your site here:
.PP
<https://www.google.com/recaptcha/admin/create>
.PP
Version 2 is a new and eaasy to solve captcha that is
\&\*(L"easy for humans to solve, but hard for 'bots' and other malicious software\*(R"
.SH "INTERFACE"
.IX Header "INTERFACE"
.ie n .IP """new""" 4
.el .IP "\f(CWnew\fR" 4
.IX Item "new"
Create a new \f(CW\*(C`Captcha::reCAPTCHA\*(C'\fR.
.ie n .IP """get_options_setter( $options )""" 4
.el .IP "\f(CWget_options_setter( $options )\fR" 4
.IX Item "get_options_setter( $options )"
You can optionally customize the look of the reCAPTCHA widget with some
JavaScript settings. \f(CW\*(C`get_options_setter\*(C'\fR returns a block of Javascript
wrapped in <script> .. </script> tags that will set the options to be used
by the widget.
.Sp
\&\f(CW$options\fR is a reference to a hash that may contain the following keys:
.RS 4
.ie n .IP """theme""" 4
.el .IP "\f(CWtheme\fR" 4
.IX Item "theme"
Defines which theme to use for reCAPTCHA. Possible values are 'red',
\&'white' or 'blackglass'. The default is 'red'.
.ie n .IP """tabindex""" 4
.el .IP "\f(CWtabindex\fR" 4
.IX Item "tabindex"
Sets a tabindex for the reCAPTCHA text box. If other elements in the
form use a tabindex, this should be set so that navigation is easier for
the user. Default: 0.
.RE
.RS 4
.RE
.ie n .IP """get_options_setter_div( $pubkey, $options )""" 4
.el .IP "\f(CWget_options_setter_div( $pubkey, $options )\fR" 4
.IX Item "get_options_setter_div( $pubkey, $options )"
You can optionally customize the look of the reCAPTCHA widget with some
settings. \f(CW\*(C`get_options_setter_div\*(C'\fR returns a div element
wrapped in <div> .. </div> tags that will set the options to be used
by the widget.
.Sp
\&\f(CW$options\fR is a reference to a hash that may contain the following keys:
.RS 4
.ie n .IP """data\-theme""" 4
.el .IP "\f(CWdata\-theme\fR" 4
.IX Item "data-theme"
Defines which theme to use for reCAPTCHA. Possible values are 'dark',
\&'light'. The default is 'light'.
.ie n .IP """data\-type""" 4
.el .IP "\f(CWdata\-type\fR" 4
.IX Item "data-type"
Defines the type of captcha to server. Possible values are 'audio' or 'image'.
Default is 'image'
.ie n .IP """data\-size""" 4
.el .IP "\f(CWdata\-size\fR" 4
.IX Item "data-size"
Defines the size of the widget. Possible values are 'compact' or 'normal'.
Default is 'normal'
.ie n .IP """data\-tabindex""" 4
.el .IP "\f(CWdata\-tabindex\fR" 4
.IX Item "data-tabindex"
Defines the tabindex of the widget and challenge. If other elements in your
page use tabindex, it should be set to make user navigation easier.
Default is 0
.ie n .IP """data\-callback""" 4
.el .IP "\f(CWdata\-callback\fR" 4
.IX Item "data-callback"
Defines the name of your callback function to be executed when the user submits
a successful \s-1CAPTCHA\s0 response. The user's response, g\-recaptcha-response,
will be the input for your callback function.
.ie n .IP """data\-expired\-callback""" 4
.el .IP "\f(CWdata\-expired\-callback\fR" 4
.IX Item "data-expired-callback"
Defines the name of your callback function to be executed when the recaptcha
response expires and the user needs to solve a new \s-1CAPTCHA\s0
.RE
.RS 4
.RE
.ie n .IP """get_html_v2( $pubkey, \e%options )""" 4
.el .IP "\f(CWget_html_v2( $pubkey, \e%options )\fR" 4
.IX Item "get_html_v2( $pubkey, %options )"
Generates \s-1HTML\s0 to display the captcha using the new api
pubkey is public key for \e%options types the same as get_options_setter
.Sp
.Vb 1
\&  print $captcha\->get_html_v2($pubkey, $options);
.Ve
.Sp
This uses ssl by default and does not display custom error messages
.ie n .IP """get_html( $pubkey, $error, $use_ssl, \e%options )""" 4
.el .IP "\f(CWget_html( $pubkey, $error, $use_ssl, \e%options )\fR" 4
.IX Item "get_html( $pubkey, $error, $use_ssl, %options )"
Generates \s-1HTML\s0 to display the captcha using api version 1.
.Sp
.Vb 1
\&    print $captcha\->get_html( $PUB, $err );
.Ve
.RS 4
.ie n .IP "$pubkey" 4
.el .IP "\f(CW$pubkey\fR" 4
.IX Item "$pubkey"
Your reCAPTCHA public key, from the \s-1API\s0 Signup Page
.ie n .IP "$error" 4
.el .IP "\f(CW$error\fR" 4
.IX Item "$error"
Optional. If set this should be either a string containing a reCAPTCHA
status code or a result hash as returned by \f(CW\*(C`check_answer\*(C'\fR.
.ie n .IP "$use_ssl" 4
.el .IP "\f(CW$use_ssl\fR" 4
.IX Item "$use_ssl"
Optional. Should the SSL-based \s-1API\s0 be used? If you are displaying a page
to the user over \s-1SSL,\s0 be sure to set this to true so an error dialog
doesn't come up in the user's browser.
.ie n .IP "$options" 4
.el .IP "\f(CW$options\fR" 4
.IX Item "$options"
Optional. A reference to a hash of options for the captcha. See
\&\f(CW\*(C`get_options_setter\*(C'\fR for more details.
.RE
.RS 4
.Sp
Returns a string containing the \s-1HTML\s0 that should be used to display
the captcha.
.RE
.ie n .IP """check_answer_v2""" 4
.el .IP "\f(CWcheck_answer_v2\fR" 4
.IX Item "check_answer_v2"
After the user has filled out the \s-1HTML\s0 form, including their answer for
the \s-1CAPTCHA,\s0 use \f(CW\*(C`check_answer\*(C'\fR to check their answer when they
submit the form. The user's answer will be in field,
g\-recaptcha-response. The reCAPTCHA
library will make an \s-1HTTP\s0 request to the reCAPTCHA server and verify the
user's answer.
.RS 4
.ie n .IP "$privkey" 4
.el .IP "\f(CW$privkey\fR" 4
.IX Item "$privkey"
Your reCAPTCHA private key, from the \s-1API\s0 Signup Page.
.ie n .IP "$remoteip" 4
.el .IP "\f(CW$remoteip\fR" 4
.IX Item "$remoteip"
The user's \s-1IP\s0 address, in the format 192.168.0.1 (optional)
.ie n .IP "$response" 4
.el .IP "\f(CW$response\fR" 4
.IX Item "$response"
The value of the form field recaptcha_response_field.
.RE
.RS 4
.Sp
Returns a reference to a hash containing two fields: \f(CW\*(C`is_valid\*(C'\fR
and \f(CW\*(C`error\*(C'\fR.
.Sp
.Vb 4
\&    my $result = $c\->check_answer_v2(
\&        \*(Aqyour private key here\*(Aq, $response,
\&        $ENV{\*(AqREMOTE_ADDR\*(Aq}
\&    );
\&
\&    my $result = $c\->check_answer_v2(
\&        \*(Aqyour private key here\*(Aq, $response,
\&        $ENV{\*(AqREMOTE_ADDR\*(Aq}
\&    );
\&
\&    if ( $result\->{is_valid} ) {
\&        print "Yes!";
\&    }
\&    else {
\&        # Error
\&        $error = $result\->{error};
\&    }
.Ve
.Sp
See the /examples subdirectory for examples of how to call \f(CW\*(C`check_answer_v2\*(C'\fR.
.Sp
Note: this method will make an \s-1HTTP\s0 request to Google to verify the user input.
If this request must be routed via a proxy in your environment, use the
standard environment variable to specify the proxy address, e.g.:
.Sp
.Vb 1
\&    $ENV{http_proxy} = \*(Aqhttp://myproxy:3128\*(Aq;
.Ve
.RE
.ie n .IP """check_answer""" 4
.el .IP "\f(CWcheck_answer\fR" 4
.IX Item "check_answer"
After the user has filled out the \s-1HTML\s0 form, including their answer for
the \s-1CAPTCHA,\s0 use \f(CW\*(C`check_answer\*(C'\fR to check their answer when they
submit the form. The user's answer will be in two form fields,
recaptcha_challenge_field and recaptcha_response_field. The reCAPTCHA
library will make an \s-1HTTP\s0 request to the reCAPTCHA server and verify the
user's answer.
.RS 4
.ie n .IP "$privkey" 4
.el .IP "\f(CW$privkey\fR" 4
.IX Item "$privkey"
Your reCAPTCHA private key, from the \s-1API\s0 Signup Page.
.ie n .IP "$remoteip" 4
.el .IP "\f(CW$remoteip\fR" 4
.IX Item "$remoteip"
The user's \s-1IP\s0 address, in the format 192.168.0.1.
.ie n .IP "$challenge" 4
.el .IP "\f(CW$challenge\fR" 4
.IX Item "$challenge"
The value of the form field recaptcha_challenge_field
.ie n .IP "$response" 4
.el .IP "\f(CW$response\fR" 4
.IX Item "$response"
The value of the form field recaptcha_response_field.
.RE
.RS 4
.Sp
Returns a reference to a hash containing two fields: \f(CW\*(C`is_valid\*(C'\fR
and \f(CW\*(C`error\*(C'\fR.
.Sp
.Vb 4
\&    my $result = $c\->check_answer(
\&        \*(Aqyour private key here\*(Aq, $ENV{\*(AqREMOTE_ADDR\*(Aq},
\&        $challenge, $response
\&    );
\&
\&    if ( $result\->{is_valid} ) {
\&        print "Yes!";
\&    }
\&    else {
\&        # Error
\&        $error = $result\->{error};
\&    }
.Ve
.Sp
See the /examples subdirectory for examples of how to call \f(CW\*(C`check_answer_v1\*(C'\fR.
.Sp
Note: this method will make an \s-1HTTP\s0 request to Google to verify the user input.
If this request must be routed via a proxy in your environment, use the
standard environment variable to specify the proxy address, e.g.:
.Sp
.Vb 1
\&    $ENV{http_proxy} = \*(Aqhttp://myproxy:3128\*(Aq;
.Ve
.RE
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
Captcha::reCAPTCHA requires no configuration files or environment
variables.
.PP
To use reCAPTCHA sign up for a key pair here:
.PP
<https://www.google.com/recaptcha/admin/create>
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
LWP::UserAgent,
HTML::Tiny
.SH "INCOMPATIBILITIES"
.IX Header "INCOMPATIBILITIES"
None reported .
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
Please see below link
.PP
https://rt.cpan.org/Public/Dist/Display.html?Name=Captcha\-reCAPTCHA
.PP
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-captcha\-recaptcha@rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Mainainted by
Sunny Patel \f(CW\*(C`<sunnypatel4141@gmail.com>\*(C'\fR
Please report all bugs to Sunny Patel
.PP
Version 0.95\-0.97 was maintained by
Fred Moyer \f(CW\*(C`<fred@redhotpenguin.com>\*(C'\fR
.PP
Original Author
Andy Armstrong  \f(CW\*(C`<andy@hexten.net>\*(C'\fR
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2007, Andy Armstrong \f(CW\*(C`<andy@hexten.net>\*(C'\fR. All rights reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See perlartistic.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
\&\s-1BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE \*(L"AS IS\*(R" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.\s0
.PP
\&\s-1IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE\s0 (\s-1INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE\s0), \s-1EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.\s0