1. module node-2fa
   1. function node-2fa.generateSecret (options)
   2. function node-2fa.generateToken (secret)
   3. function node-2fa.verifyToken (secret, token, window)

module node-2fa

function node-2fa.generateSecret (options)

• description and source-code

  function generateSecret(options) {
      if (!options) options = {};
      var bin = crypto.randomBytes(20);
      var base32 = b32.encode(bin).toString('utf8').replace(/=/g, '');
      var secret = base32.toLowerCase().replace(/(\w{4})/g, "$1 ").trim().split(' ').join('').toUpperCase();
      var uri = 'otpauth://totp/' + encodeURIComponent(options.name || 'App') + encodeURIComponent(options.account ? ':' + options
  .account : '') + '%3Fsecret=' + secret;
      return {
          secret: secret,
          uri: uri,
          qr: 'https://chart.googleapis.com/chart?chs=166x166&chld=L|0&cht=qr&chl=' + uri
      };
  }

• example usage

  ...
  npm install node-2fa --save
  ```
  
  ```javascript
  
  var twoFactor = require('node-2fa');
  
  var newSecret = twoFactor.generateSecret({name: 'My Awesome App', account: &#
  x27;johndoe'});
  /*
  { secret: 'XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W',
    uri: 'otpauth://totp/My Awesome App:johndoe%3Fsecret=XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W',
    qr: 'https://chart.googleapis.com/chart?chs=166x166&chld=L|0&cht=qr&chl=otpauth://totp/My Awesome App:johndoe
  %3Fsecret=XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W'
  }
  */
  ...

function node-2fa.generateToken (secret)

• description and source-code

  function generateToken(secret) {
      if (!secret || !secret.length) return null;
      var unformatted = secret.replace(/\W+/g, '').toUpperCase();
      var bin = b32.decode(unformatted);
      return {
          token: notp.totp.gen(bin)
      };
  }

• example usage

  ...
  /*
  { secret: 'XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W',
    uri: 'otpauth://totp/My Awesome App:johndoe%3Fsecret=XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W',
    qr: 'https://chart.googleapis.com/chart?chs=166x166&chld=L|0&cht=qr&chl=otpauth://totp/My Awesome App:johndoe
  %3Fsecret=XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W'
  }
  */
  
  var newToken = twoFactor.generateToken('XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W');
  // { token: '630618' }
  
  twoFactor.verifyToken('XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W', '765075');
  // { delta: 0 }
  
  twoFactor.verifyToken('XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W', '00');
  // null
  ...

function node-2fa.verifyToken (secret, token, window)

• description and source-code

  function verifyToken(secret, token, window) {
      if (!secret || !secret.length || !token || !token.length) return null;
      if (!window) window = 4;
      var unformatted = secret.replace(/\W+/g, '').toUpperCase();
      var bin = b32.decode(unformatted);
      token = token.replace(/\W+/g, '');
      return notp.totp.verify(token, bin, {
          window: window,
          time: 30
      });
  }

• example usage

  ...
    qr: 'https://chart.googleapis.com/chart?chs=166x166&chld=L|0&cht=qr&chl=otpauth://totp/My Awesome App:johndoe
  %3Fsecret=XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W'
  }
  */
  
  var newToken = twoFactor.generateToken('XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W');
  // { token: '630618' }
  
  twoFactor.verifyToken('XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W', '765075'
  ;);
  // { delta: 0 }
  
  twoFactor.verifyToken('XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W', '00');
  // null
  ```
  
  API
  ...