NAME

VERSION

NOTICE

SYNOPSIS

    use Captcha::reCAPTCHA;

    my $c = Captcha::reCAPTCHA->new;

    # Output form New Version
    print $c->get_html_v2( 'your public key here' );

    # Version 1 (not recommended)
    print $c->get_html( 'your public key here' );

    # Verify submission
    my $result $c->check_answer_v2($private_key, $response, $ENV{REMOTE_ADDR});

    # Verify submission (Old Version)
    my $result = $c->check_answer(
        'your private key here', $ENV{'REMOTE_ADDR'},
        $challenge, $response
    );

    if ( $result->{is_valid} ) {
        print "Yes!";
    }
    else {
        # Error
        $error = $result->{error};
    }

For complete examples see the /examples subdirectory

DESCRIPTION

From <http://recaptcha.net/learnmore.html>:

    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.

version 1 of Perl implementation is modelled on the PHP interface that can be found here:

<http://recaptcha.net/plugins/php/>

To use reCAPTCHA you need to register your site here:

<https://www.google.com/recaptcha/admin/create>

Version 2 is a new and eaasy to solve captcha that is "easy for humans to solve, but hard for 'bots' and other malicious software"

INTERFACE

"new"

Create a new "Captcha::reCAPTCHA".

"get_options_setter( $options )"

You can optionally customize the look of the reCAPTCHA widget with some JavaScript settings. "get_options_setter" returns a block of Javascript wrapped in <script> .. </script> tags that will set the options to be used by the widget.

$options is a reference to a hash that may contain the following keys:

"get_options_setter_div( $pubkey, $options )"

You can optionally customize the look of the reCAPTCHA widget with some settings. "get_options_setter_div" returns a div element wrapped in <div> .. </div> tags that will set the options to be used by the widget.

$options is a reference to a hash that may contain the following keys:

"get_html_v2( $pubkey, \%options )"

Generates HTML to display the captcha using the new api pubkey is public key for \%options types the same as get_options_setter

  print $captcha->get_html_v2($pubkey, $options);
    

This uses ssl by default and does not display custom error messages

"get_html( $pubkey, $error, $use_ssl, \%options )"

Generates HTML to display the captcha using api version 1.

    print $captcha->get_html( $PUB, $err );
    

"check_answer_v2"

After the user has filled out the HTML form, including their answer for the CAPTCHA, use "check_answer" 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 HTTP request to the reCAPTCHA server and verify the user's answer.

        # If your site does not use SSL then
        $ENV{PERL_LWP_SSL_VERIFY_HOSTNAME} = 0;

    my $result = $c->check_answer_v2(
        'your private key here', $response,
        $ENV{'REMOTE_ADDR'}
    );

    my $result = $c->check_answer_v2(
        'your private key here', $response,
        $ENV{'REMOTE_ADDR'}
    );

    if ( $result->{is_valid} ) {
        print "Yes!";
    }
    else {
        # Error
        $error = $result->{error};
    }

    $ENV{http_proxy} = 'http://myproxy:3128';

"check_answer"

After the user has filled out the HTML form, including their answer for the CAPTCHA, use "check_answer" 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 HTTP request to the reCAPTCHA server and verify the user's answer.

    my $result = $c->check_answer(
        'your private key here', $ENV{'REMOTE_ADDR'},
        $challenge, $response
    );

    if ( $result->{is_valid} ) {
        print "Yes!";
    }
    else {
        # Error
        $error = $result->{error};
    }

    $ENV{http_proxy} = 'http://myproxy:3128';

CONFIGURATION AND ENVIRONMENT

To use reCAPTCHA sign up for a key pair here:

<https://www.google.com/recaptcha/admin/create>

DEPENDENCIES

INCOMPATIBILITIES

BUGS AND LIMITATIONS

https://rt.cpan.org/Public/Dist/Display.html?Name=Captcha-reCAPTCHA

Please report any bugs or feature requests to "bug-captcha-recaptcha@rt.cpan.org", or through the web interface at <http://rt.cpan.org>.

AUTHOR

Version 0.95-0.97 was maintained by Fred Moyer "<fred@redhotpenguin.com>"

Original Author Andy Armstrong "<andy@hexten.net>"

LICENCE AND COPYRIGHT

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

IN 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 (INCLUDING 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), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.