Skip to content

CruzHacks/cruzhacks-2021-recaptcha-function

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Recaptcha Function

cruzhacks-2021-function

This Firebase Function is responsible for verifying a user using Google's RECAPTCHA.

Development

Dependnecies

  • Local NPM packages --> npm install

Start

npm run serve

Test

This project uses Mocha. Run all tests via npm run test.

Environment Variables

SITEVERIFYURL RECAPTCHASECRETKEY

Request Schema

curl --request GET \
  --url http://localhost:5001/cruzhacks-4a899/us-central1/siteVerify \
  --header 'token: RECAPTCHA_GENERATED_TOKEN' \
  --header 'content-type: application/json' \

Response Schemas

Success

{
  "error": false,
  "status": 200,
  "message": "Succesfully Authenticated Request"
}

Missing Token

{
  "error": true,
  "status": 401,
  "message": "Token is missing"
}

Invalid Token

{
  "error": true,
  "status": 400,
  "message": "Invalid Token Provided"
}

Invalid Token and Secret

{
  "error": true,
  "status": 400,
  "message":  "Invalid Token and Secret Provided"
}

Invalid Secret

{
  "error": true,
  "status": 401,
  "message":  "Incorrect Secret Provided"
}

Duplicate Token Sent

{
  "error": true,
  "status": 400,
  "message":  "Request Timed Out or Sent Duplicate Key"
}

Technologies

  • Firebase Functions
  • NodeJS
  • Github Actions
  • Mocha
  • Prettier
  • Eslint