npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ourdailybread/aws-lambda-recaptcha

v1.0.3

Published

Server validation of recaptcha in an aws lambda function

Downloads

6

Readme

AWS Lambda Recaptcha

Description

This package makes it very simple to add server side validation of google recaptcha to an AWS Lambda function that is run from APIGateway.

Usage

To use this all you need to do is import/require recaptchaValidate and wrap your lambda function with it

import {recaptchaValidate} from 'aws-lambda-recaptcha'
const options = {siteKey:'<recaptcha key>'}
export const yourHandler = recaptchaValidate((event, context)=>{
//Your awesome logic
}, options)

To make your code cleaner you may want to use a named function to pass it in instead:

import {recaptchaValidate} from 'aws-lambda-recaptcha'
const options = {siteKey:'<recaptcha key>'}
const yourFunction = (event, context)=>{
	//Your awesome logic
}
export const yourHandle = recaptchaValidate(yourFunction, options)

The validation function looks for g-recaptcha-response in the body and runs the validation against that value.

Options parameter

There are several options that can be set using in the options parameter here is the type definition

type OptionsParameter = {
	siteKey?: string;
	parameterStoreKey?: string;
	responseFormatter?: ResponseFormatter;
	errorMessage?: string | object;
	invalidMessage?: string;
	cors?: HeadersObject | boolean;
	logger?: Console;
	debug?: boolean;
}

siteKey

The google recaptcha site key you need to use. Either siteKey or parameterStoreKey are required, siteKey takes precedent.

parameterStoreKey

If you would like to store your google recaptcha key securely in AWS parameter store you can pass the key in with this parameter, and the library will retrieve it for you. Ensure your lambda function has permission to access that parameter store key. If both siteKey and parameterStoreKey are present siteKey takes precedence and parameterStoreKey will be ignored.

errorMessage

By default, if there is an error while attempting to validate the body returned will be

{
message: "There was an error validating recaptcha"
}

You can change this if you pass in either and object or a string. If you pass in a string it will still return json like above with just a different message value. If you pass in an object that full object will replace the body.

invalidMessage

By default, if there were no errors, and the recaptcha validation fails the body will be:

{
message: "Invalid recaptcha response"
}

You can customize this response just like errorMessage

cors

In the event of an error or invalid recaptcha response the function does not add any cors headers. You can either set cors to true and

{ "Access-Control-Allow-Origin": "*" }

will be added to the headers return property. If you want a different value or other headers you can pass in an object and headers will be set to what was passed in.

responseFormatter

If you need more control over how error/invalid responses are formatted, you can pass in a function that will run. The type definition of the function is:

(data:string | object, statusCode: number) => APIGatewayProxyResult

This function should return what you want to return from the lambda function in the case of error or invalid response

logger

Not currently used will be used in the future to allow you to pass in a Console like object to handle logging and debugging.

debug

Not currently used. Will be used in the future to allow you to turn on logging debug statements.