koa-captcha

Koa 验证码

目录

• 安装
• 使用
• License

Install

安装

$ npm i [-S] koa-captcha-v2

Useage

配置中间件

const Koa = require('koa');
const bodyparser = require('koa-bodyparser');
const captcha = require('koa-captcha-v2');
const session = require('koa-session');

const app = new Koa();
app
  // ...
  .use(session(app))
  .use(bodyparser())
  .use(captcha({
    background: undefined,    // Background color, default: undefined(transparent)
    background_image: null,   // Background image, default: null
    case_sensitivity: false,  // Case sensitivity, default: false
    char_pool: '0123456789',  // Char pool, like: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789, default: 0123456789
    char_length: 6,           // Char length, default: 6
    color: '#000',            // Color, String or Array, default: black
    font_family: 'SpicyRice', // Font family, default SpicyRice
    font_size: '30px',        // Font size, default: 30px
    font_style: 'normal',     // Font style, default: normal
    font_weight: 'normal',    // Font weight, default: normal
    fonts: {},                // Custom font files path
    height: 60,               // Height, default: 60
    prefix: 'captcha_',       // Session key prefix, default: `captcha_${key}`
    rotate: 30,               // Rotation amplitude, default: 30, then the angle range is -30 to 30
    timeout_in: 60 * 1000,    // Timeout, default: 1 minute
    type: 'character',        // Captcha type, default: random character
    width: 160,               // Width, default: 160
  }))
  // ...
  ;

显示验证码

app
  // ...
  .use(async(ctx, next) => {
    if(ctx.path == '/captcha') {
      ctx.type = ctx.captcha.type;
      ctx.body = ctx.captcha.refresh('test', 5 * 60 * 1000);
      return;
    } else if(ctx.path == '/captcha/verify' && ctx.method == 'POST') {
      ctx.body = ctx.captcha.verify('test', ctx.request.body.code);
      return;
    }

    ctx.type = 'html';
    ctx.body = `
      <form action="/captcha/verify" method="post">
        <input type="text" name="code" />
        <img src="/captcha" />
        <button type="submit">Verify</button>
      </form>
    `;
  })
  // ...
  ;

License

MIT - xiewulong