otplib 10.1.0-0 → 10.2.3

package/README.md

@@ -76,9 +76,6 @@ $ npm install otplib --save
 
 # To install the Release Candidates:
 $ npm install otplib@next --save
-
-# Additional dependencies for TypeScript
-$ npm install @types/node
 ```
 
 | Release Type      | Version                            |
@@ -90,6 +87,11 @@ $ npm install @types/node
 
 `TypeScript` support was introduced in `v10.0.0`
 
+```bash
+# Additional dependencies needed for TypeScript
+$ npm install @types/node
+```
+
 ## Upgrading
 
 This library follows `semver`. As such, major version bumps usually mean API changes or behavior changes.
@@ -336,7 +338,10 @@ An example is shown below:
 import qrcode from 'qrcode';
 import otplib from 'otplib';
 
-const otpauth = otplib.authenticator.keyuri('user', 'service', secret);
+const user = 'A user name, possibly an email';
+const service = 'A service name';
+const otpauth = otplib.authenticator.keyuri(
+    encodeURIComponent(user), encodeURIComponent(service), secret);
 
 qrcode.toDataURL(otpauth, (err, imageUrl) => {
   if (err) {
@@ -347,6 +352,9 @@ qrcode.toDataURL(otpauth, (err, imageUrl) => {
 });
 ```
 
+> **Note**: For versions `v10.x.x` and below, `keyuri` does not URI encode
+> `user` and `service` and it's the developer's job to do it as show above.
+
 ### Getting Time Remaining / Time Used
 
 Helper methods for getting the remaining time and used time within a validity period
@@ -417,7 +425,7 @@ Check out: [CONTRIBUTING.md][pr-welcome-link]
 [donate-badge]: https://img.shields.io/badge/donate-%3C3-red.svg?longCache=true&style=flat-square
 [donate-link]: https://www.paypal.me/yeojz
 [coffee-badge]: https://img.shields.io/badge/%E2%98%95%EF%B8%8F-buy%20me%20a%20coffee-orange.svg?longCache=true&style=flat-square
-[coffee-link]: https://ko-fi.com/geraldyeo
+[coffee-link]: https://paypal.me/yeojz
 [type-ts-badge]: https://img.shields.io/badge/typedef-.d.ts-blue.svg?style=flat-square&longCache=true
 [type-ts-link]: https://github.com/yeojz/otplib/tree/master/packages/types-ts
 [type-ts-file]: https://github.com/yeojz/otplib/blob/master/packages/types-ts/index.d.ts

package/authenticator.js

@@ -2,27 +2,38 @@
  * otplib-authenticator
  *
  * @author Gerald Yeo <contact@fusedthought.com>
- * @version: 10.1.0-0
+ * @version: 10.2.3
  * @license: MIT
  **/
 'use strict';
 
-var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
-
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
-function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+
+function _possibleConstructorReturn(self, call) { if (call && (typeof call === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }
+
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+
+function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
 
-function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
+
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
 
 function _interopDefault(ex) {
   return ex && typeof ex === 'object' && 'default' in ex ? ex['default'] : ex;
 }
 
+var totp = _interopDefault(require("./totp"));
+
+var otplibUtils = require("./utils");
+
+var otplibCore = require("./core");
+
 var base32 = _interopDefault(require('thirty-two'));
-var otplibCore = require('./core');
-var totp = _interopDefault(require('./totp'));
-var otplibUtils = require('./utils');
 
 function decodeKey(encodedKey) {
   return base32.decode(encodedKey).toString('hex');
@@ -34,6 +45,7 @@ function _checkDelta(token, secret, options) {
 
 function _check(token, secret, options) {
   var delta = _checkDelta(token, secret, options);
+
   return Number.isInteger(delta);
 }
 
@@ -42,11 +54,11 @@ function encodeKey(secret) {
 }
 
 var data = '{service}:{user}?secret={secret}&issuer={service}';
+
 function _keyuri() {
   var user = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'user';
   var service = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'service';
   var secret = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '';
-
   var protocol = 'otpauth://totp/';
   var value = data.replace('{user}', user).replace('{secret}', secret).replace(/{service}/g, service);
   return protocol + value;
@@ -58,74 +70,77 @@ function token(secret, options) {
 
 var TOTP = totp.TOTP;
 
-var Authenticator = function (_TOTP) {
+var Authenticator =
+/*#__PURE__*/
+function (_TOTP) {
   _inherits(Authenticator, _TOTP);
 
   function Authenticator() {
+    var _this;
+
     _classCallCheck(this, Authenticator);
 
-    return _possibleConstructorReturn(this, (Authenticator.__proto__ || Object.getPrototypeOf(Authenticator)).call(this));
+    _this = _possibleConstructorReturn(this, _getPrototypeOf(Authenticator).call(this));
+    _this._defaultOptions = {
+      encoding: 'hex',
+      epoch: null,
+      step: 30,
+      window: 0
+    };
+    _this._options = _this._defaultOptions;
+    return _this;
   }
 
   _createClass(Authenticator, [{
-    key: 'getClass',
+    key: "getClass",
     value: function getClass() {
       return Authenticator;
     }
   }, {
-    key: 'encode',
+    key: "encode",
     value: function encode() {
-      return encodeKey.apply(undefined, arguments);
+      return encodeKey.apply(void 0, arguments);
     }
   }, {
-    key: 'decode',
+    key: "decode",
     value: function decode() {
-      return decodeKey.apply(undefined, arguments);
+      return decodeKey.apply(void 0, arguments);
     }
   }, {
-    key: 'keyuri',
+    key: "keyuri",
     value: function keyuri() {
-      return _keyuri.apply(undefined, arguments);
+      return _keyuri.apply(void 0, arguments);
     }
   }, {
-    key: 'generateSecret',
+    key: "generateSecret",
     value: function generateSecret() {
       var len = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 20;
 
       if (!len) {
         return '';
       }
+
       var secret = otplibUtils.secretKey(len, this.optionsAll);
       return encodeKey(secret);
     }
   }, {
-    key: 'generate',
+    key: "generate",
     value: function generate(secret) {
       var opt = this.optionsAll;
       return token(secret || opt.secret, opt);
     }
   }, {
-    key: 'check',
+    key: "check",
     value: function check(token$$1, secret) {
       var opt = this.optionsAll;
       return _check(token$$1, secret || opt.secret, opt);
     }
   }, {
-    key: 'checkDelta',
+    key: "checkDelta",
     value: function checkDelta(token$$1, secret) {
       var opt = this.optionsAll;
       return _checkDelta(token$$1, secret || opt.secret, opt);
     }
-  }, {
-    key: 'defaultOptions',
-    get: function get() {
-      return {
-        encoding: 'hex',
-        epoch: null,
-        step: 30,
-        window: 0
-      };
-    }
   }]);
 
   return Authenticator;
@@ -140,7 +155,5 @@ Authenticator.prototype.utils = {
   keyuri: _keyuri,
   token
 };
-
 var index = new Authenticator();
-
 module.exports = index;

package/core.js

@@ -2,14 +2,16 @@
  * otplib-core
  *
  * @author Gerald Yeo <contact@fusedthought.com>
- * @version: 10.1.0-0
+ * @version: 10.2.3
  * @license: MIT
  **/
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
+Object.defineProperty(exports, '__esModule', {
+  value: true
+});
 
-var otplibUtils = require('./utils');
+var otplibUtils = require("./utils");
 
 function hotpCounter(counter) {
   var hexCounter = otplibUtils.intToHex(counter);
@@ -20,12 +22,15 @@ function hotpDigest(secret, counter, options) {
   if (!options.crypto || typeof options.crypto.createHmac !== 'function') {
     throw new Error('Expecting options.crypto to have a createHmac function');
   }
+
   if (typeof options.createHmacSecret !== 'function') {
     throw new Error('Expecting options.createHmacSecret to be a function');
   }
+
   if (typeof options.algorithm !== 'string') {
     throw new Error('Expecting options.algorithm to be a string');
   }
+
   var hmacSecret = options.createHmacSecret(secret, {
     algorithm: options.algorithm,
     encoding: options.encoding
@@ -39,9 +44,11 @@ function hotpToken(secret, counter, options) {
   if (counter == null) {
     return '';
   }
+
   if (typeof options.digits !== 'number') {
     throw new Error('Expecting options.digits to be a number');
   }
+
   var digest = hotpDigest(secret, counter, options);
   var offset = digest[digest.length - 1] & 0xf;
   var binary = (digest[offset] & 0x7f) << 24 | (digest[offset + 1] & 0xff) << 16 | (digest[offset + 2] & 0xff) << 8 | digest[offset + 3] & 0xff;
@@ -52,9 +59,11 @@ function hotpToken(secret, counter, options) {
 
 function hotpCheck(token, secret, counter, options) {
   var systemToken = hotpToken(secret, counter, options);
+
   if (systemToken.length < 1) {
     return false;
   }
+
   return otplibUtils.isSameToken(token, systemToken);
 }
 
@@ -62,12 +71,12 @@ function hotpSecret(secret, options) {
   if (typeof options.encoding !== 'string') {
     throw new Error('Expecting options.encoding to be a string');
   }
+
   return Buffer.from(secret, options.encoding);
 }
 
 function hotpOptions() {
   var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
   return Object.assign({
     algorithm: 'sha1',
     createHmacSecret: hotpSecret,
@@ -85,18 +94,22 @@ function totpToken(secret, options) {
   if (typeof options.epoch !== 'number') {
     throw new Error('Expecting options.epoch to be a number');
   }
+
   if (typeof options.step !== 'number') {
     throw new Error('Expecting options.step to be a number');
   }
+
   var counter = totpCounter(options.epoch, options.step);
   return hotpToken(secret, counter, options);
 }
 
 function totpCheck(token, secret, options) {
   var systemToken = totpToken(secret, options || {});
+
   if (systemToken.length < 1) {
     return false;
   }
+
   return otplibUtils.isSameToken(token, systemToken);
 }
 
@@ -106,20 +119,26 @@ function createChecker(token, secret, opt) {
   return function (direction, start, bounds) {
     for (var i = start; i <= bounds; i++) {
       opt.epoch = epoch + direction * i * delta;
+
       if (totpCheck(token, secret, opt)) {
         return i === 0 ? 0 : direction * i;
       }
     }
+
     return null;
   };
 }
+
 function getWindowBounds(opt) {
   var bounds = Array.isArray(opt.window) ? opt.window : [parseInt(opt.window, 10), parseInt(opt.window, 10)];
+
   if (!Number.isInteger(bounds[0]) || !Number.isInteger(bounds[1])) {
     throw new Error('Expecting options.window to be an integer or an array of integers');
   }
+
   return bounds;
 }
+
 function totpCheckWithWindow(token, secret, options) {
   var opt = Object.assign({}, options);
   var bounds = getWindowBounds(opt);
@@ -132,18 +151,24 @@ function totpSecret(secret, options) {
   if (typeof options.algorithm !== 'string') {
     throw new Error('Expecting options.algorithm to be a string');
   }
+
   if (typeof options.encoding !== 'string') {
     throw new Error('Expecting options.encoding to be a string');
   }
+
   var encoded = Buffer.from(secret, options.encoding);
   var algorithm = options.algorithm.toLowerCase();
+
   switch (algorithm) {
     case 'sha1':
       return otplibUtils.padSecret(encoded, 20, options.encoding);
+
     case 'sha256':
       return otplibUtils.padSecret(encoded, 32, options.encoding);
+
     case 'sha512':
       return otplibUtils.padSecret(encoded, 64, options.encoding);
+
     default:
       throw new Error(`Unsupported algorithm ${algorithm}. Accepts: sha1, sha256, sha512`);
   }
@@ -155,9 +180,9 @@ var defaultOptions = {
   step: 30,
   window: 0
 };
+
 function totpOptions() {
   var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
   var opt = Object.assign(hotpOptions(), defaultOptions, options);
   opt.epoch = typeof opt.epoch === 'number' ? opt.epoch * 1000 : Date.now();
   return opt;

package/hotp.js

@@ -2,62 +2,76 @@
  * otplib-hotp
  *
  * @author Gerald Yeo <contact@fusedthought.com>
- * @version: 10.1.0-0
+ * @version: 10.2.3
  * @license: MIT
  **/
 'use strict';
 
-var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
-
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
-var otplibCore = require('./core');
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+
+var otplibCore = require("./core");
 
-var HOTP = function () {
+var HOTP =
+/*#__PURE__*/
+function () {
   function HOTP() {
     _classCallCheck(this, HOTP);
 
-    this._options = this.defaultOptions;
+    this._defaultOptions = {};
+    this._options = this._defaultOptions;
   }
 
   _createClass(HOTP, [{
-    key: 'getClass',
+    key: "getClass",
     value: function getClass() {
       return HOTP;
     }
   }, {
-    key: 'resetOptions',
+    key: "resetOptions",
     value: function resetOptions() {
       this._options = this.defaultOptions;
       return this;
     }
   }, {
-    key: 'generate',
+    key: "generate",
     value: function generate(secret, counter) {
       var opt = this.optionsAll;
       return otplibCore.hotpToken(secret || opt.secret, counter, opt);
     }
   }, {
-    key: 'check',
+    key: "check",
     value: function check(token, secret, counter) {
       var opt = this.optionsAll;
       return otplibCore.hotpCheck(token, secret || opt.secret, counter, opt);
     }
   }, {
-    key: 'verify',
+    key: "verify",
     value: function verify(opts) {
       if (typeof opts !== 'object' || opts == null) {
         return false;
       }
+
       return this.check(opts.token, opts.secret, opts.counter);
     }
   }, {
-    key: 'defaultOptions',
+    key: "defaultOptions",
+    set: function set() {
+      var opt = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+
+      if (opt) {
+        this._defaultOptions = Object.assign({}, this.defaultOptions, opt);
+        this.options = opt;
+      }
+    },
     get: function get() {
-      return {};
+      return this._defaultOptions;
     }
   }, {
-    key: 'options',
+    key: "options",
     set: function set() {
       var opt = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
 
@@ -69,7 +83,7 @@ var HOTP = function () {
       return Object.assign({}, this._options);
     }
   }, {
-    key: 'optionsAll',
+    key: "optionsAll",
     get: function get() {
       return otplibCore.hotpOptions(this._options);
     }
@@ -79,7 +93,5 @@ var HOTP = function () {
 }();
 
 HOTP.prototype.HOTP = HOTP;
-
 var index = new HOTP();
-
 module.exports = index;

package/index.d.ts

@@ -81,8 +81,9 @@ declare class HOTP {
   HOTP: typeof HOTP;
   getClass(): typeof HOTP;
 
-  options: TotpOptionsInterface;
-  optionsAll: TotpOptionsInterface;
+  defaultOptions: HotpOptionsInterface;
+  options: HotpOptionsInterface;
+  optionsAll: HotpOptionsInterface;
   resetOptions(): this;
   generate(secret: string, counter: number): string;
   check(token: string, secret: string, counter: number): boolean;
@@ -93,6 +94,7 @@ declare class TOTP extends HOTP {
   TOTP: typeof TOTP;
   getClass(): typeof TOTP;
 
+  defaultOptions: TotpOptionsInterface;
   options: TotpOptionsInterface;
   optionsAll: TotpOptionsInterface;
   generate(secret: string): string;

package/index.js

@@ -2,26 +2,42 @@
  * otplib
  *
  * @author Gerald Yeo <contact@fusedthought.com>
- * @version: 10.1.0-0
+ * @version: 10.2.3
  * @license: MIT
  **/
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
+Object.defineProperty(exports, '__esModule', {
+  value: true
+});
 
 function _interopDefault(ex) {
   return ex && typeof ex === 'object' && 'default' in ex ? ex['default'] : ex;
 }
 
-var hotp = _interopDefault(require('./hotp'));
-var totp = _interopDefault(require('./totp'));
-var authenticator = _interopDefault(require('./authenticator'));
-var crypto = _interopDefault(require('crypto'));
+var hotp = _interopDefault(require("./hotp"));
+
+var totp = _interopDefault(require("./totp"));
 
-authenticator.options = { crypto };
-hotp.options = { crypto };
-totp.options = { crypto };
+var authenticator = _interopDefault(require("./authenticator"));
+
+var crypto = _interopDefault(require('crypto'));
 
+authenticator.defaultOptions = {
+  crypto
+};
+hotp.defaultOptions = {
+  crypto
+};
+totp.defaultOptions = {
+  crypto
+};
+var index = {
+  authenticator,
+  hotp,
+  totp
+};
 exports.hotp = hotp;
 exports.totp = totp;
-exports.authenticator = authenticator;
+exports.authenticator = authenticator;
+exports.default = index;