README.md

hapi-auth-recaptcha

Recaptcha authentication requires the validation of a Recaptcha token generated and sent by the browser via the recaptcha-token header. The 'recaptcha' scheme takes the following options:

• validateFunc - (required) the function which is run once the Recaptcha has been verified function(request, callback) where:
  • request - is the hapi request object of the request which is being authenticated.
  • callback - a callback function with the signature function(err, isValid) where:
    • err - an internal error. If defined will replace default Boom.unauthorized error
    • isValid - true if both the username was found and the password matched, otherwise false.
• recaptchaSecret - (required) The secret key used to verify the Recaptcha token. You can get one here
• headerName - (optional) A custom header name for the recaptcha token token. Default: recaptcha-token

Usage

Send your request with the Recaptcha Token as a parameters or payload. Unless you have set tokenName, you have to use the recaptchaToken key.

const validate = function (request, callback) {

    //No custom validation
    callback(null, true);
};

server.register(require('hapi-auth-recaptcha'), (err) => {

    server.auth.strategy('recaptcha', 'recaptcha', { validateFunc: validate,  recaptchaSecret: 'TheSecret'}, tokenName: 'reToken');
    server.route({ method: 'GET', path: '/{reToken}', config: { auth: 'recaptcha' } });
});