fastify-cloudflare-turnstile/README.md

A Fastify plugin for CloudFlare Turnstile Captcha

# fastify-cloudflare-turnstile
![CI](https://github.com/112RG/fastify-cloudflare-turnstile/workflows/CI/badge.svg)
[![NPM version](https://img.shields.io/npm/v/fastify-cloudflare-turnstile.svg?style=flat)](https://www.npmjs.com/package/fastify-cloudflare-turnstile)
[![Node version](https://img.shields.io/node/v-lts/fastify-cloudflare-turnstile.svg?style=flat)](https://endoflife.date/nodejs)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)



A [Cloudflare Turnstile](https://developers.cloudflare.com/turnstile/) plugin for fastify.

This plugin does the [Server-side Validation](https://developers.cloudflare.com/turnstile/get-started/server-side-validation/) for Cloudflare Turnstile and it is upto you to implement [Client-side Validation](https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/)

## Install

```
npm i fastify-cloudflare-turnstile
```

## Usage

```javascript
const fastify = require('fastify');
const cfTurnstile = require('fastify-cloudflare-turnstile')

const app = fastify();
app.register(cfTurnstile,{
    sitekey:"your_sitekey",
    privatekey:"your_privatekey",
})
```

Using in a route

```javascript
  fastify.post('/login', {
    preValidation: fastify.cfTurnstile,
    schema: {
      summary: 'User login',
      body: {
        type: 'object',
        properties: {
          email: {
            anyOf: [
              { type: 'string' },
              { type: 'object' }
            ]
          },
          password: {
            anyOf: [
              { type: 'string' },
              { type: 'object' }
            ]
          }
        },
        required: ['email', 'password']
      }
    }
  },
  async function (req, reply) {
    // Login logic
  })
```