# @solargis/lambda-captcha

> Generates captchas that can be verified decentrally, e.g. in Lambda function

Latest version **4.0.0** (published 2020-08-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install @solargis/lambda-captcha
pnpm add @solargis/lambda-captcha
yarn add @solargis/lambda-captcha
bun add @solargis/lambda-captcha
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2020-08-07 |
| First published | 2020-07-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 703 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | solargis |

## Links

- npm: https://www.npmjs.com/package/@solargis/lambda-captcha
- npm.io page: https://npm.io/package/@solargis/lambda-captcha

## Dependencies (2)

- [tslib](https://npm.io/package/tslib.md) ^1.9.3
- [opentype.js](https://npm.io/package/opentype.js.md) ^1.1.0

## Recent versions

- 4.0.0 (latest) — 2020-08-07
- 3.0.1 — 2020-07-10
- 3.0.0 — 2020-07-10
- 1.1.0 — 2020-07-10

## README

# lambda-captcha

Forked from: [fourcube/lambda-captcha](https://github.com/fourcube/lambda-captcha)

Generates captchas that can be verified decentrally.

## Description

This is heavily inspired by [svg-captcha](https://github.com/lemonce/svg-captcha/), but written in TypeScript. It also allows you to pass the generated captcha expressions together with the user-supplied captcha solution,
so you can verify the results independently. The captcha expressions are encrypted, so they are not
machine readable.

## Usage

### Generating a captcha

```js
const lambdaCaptcha = require('@solargis/lambda-captcha')
const SECRET = process.env.CAPTCHA_SECRET

function generateCaptcha() {
  const captchaConfig = lambdaCaptcha.LambdaCaptchaConfigManager.default(SECRET)
  const captcha = lambdaCaptcha.create(captchaConfig)

  return {
    // The captcha SVG that you can display inside e.g. a form
    captchaSvg: captcha.captchaSvg,
    
    // This is the un-encrypted expression of the captcha.
    captchaExpression: captcha.expr,
    
    // This is the encrypted expression of the captcha.
    // Pass it along with your server side verification requests.
    encryptedCaptchaExpression: captcha.encryptedExpr
  }
}
```

### Generating a captcha in code mode

```js
const lambdaCaptcha = require('@solargis/lambda-captcha')
const SECRET = process.env.CAPTCHA_SECRET

function generateCaptcha() {
  const captchaConfig = lambdaCaptcha.LambdaCaptchaConfigManager.default(SECRET)

  const captcha = lambdaCaptcha.create({
    ...captchaConfig,
    mode: 'code', // default mode is 'math'
    codeLength: 5, // optional, default codeLength is 5
  })

  return {
    // The captcha SVG that you can display inside e.g. a form
    captchaSvg: captcha.captchaSvg,
    
    // This is the un-encrypted expression of the captcha.
    captchaExpression: captcha.expr,
    
    // This is the encrypted expression of the captcha.
    // Pass it along with your server side verification requests.
    encryptedCaptchaExpression: captcha.encryptedExpr
  }
}
```

### Verifying a captcha

```js
const lambdaCaptcha = require('@solargis/lambda-captcha')
const SECRET = process.env.CAPTCHA_SECRET

function verify(encryptedCaptchaExpression, captchaSolution) {
  const captchaResult = captcha.verify(captchaExpression, captchaSolution, SECRET)
  return captchaResult // either true on success or false if the solution was wrong
}
```

## Testing

`npm run test`

or 

`npm run tdd`

---
_Source: https://npm.io/package/@solargis/lambda-captcha · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._