egg-otp

The one time password plugin on eggjs.

Usage no npm install needed!

<script type="module">
  import eggOtp from 'https://cdn.skypack.dev/egg-otp';
</script>

README

egg-otp

NPM version build status npm download FOSSA Status

One time password plugin for eggjs.

Install

$ npm i egg-otp --save

Usage

// {app_root}/config/plugin.js
exports.otp = {
  enable: true,
  package: 'egg-otp',
};
// {app_root}/controller/home.js
const key = ctx.otp.generateOtpKey();
const token = ctx.otp.hotp.gen(key, {counter: 0});
ctx.otp.hotp.verify(token, key, {counter: 0, window: 10});

you can see lib/hotp.js AND lib/totp.js for more option.

Configuration

see config/config.default.js for more detail.

License

MIT

FOSSA Status