diff options
Diffstat (limited to 'node_modules/node-2fa')
| -rw-r--r-- | node_modules/node-2fa/LICENSE | 201 | ||||
| -rw-r--r-- | node_modules/node-2fa/README.md | 68 | ||||
| -rw-r--r-- | node_modules/node-2fa/dist/index.d.ts | 11 | ||||
| -rw-r--r-- | node_modules/node-2fa/dist/index.js | 51 | ||||
| -rw-r--r-- | node_modules/node-2fa/dist/interfaces.d.ts | 4 | ||||
| -rw-r--r-- | node_modules/node-2fa/dist/interfaces.js | 2 | ||||
| -rw-r--r-- | node_modules/node-2fa/package.json | 58 |
7 files changed, 395 insertions, 0 deletions
diff --git a/node_modules/node-2fa/LICENSE b/node_modules/node-2fa/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/node_modules/node-2fa/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/node_modules/node-2fa/README.md b/node_modules/node-2fa/README.md new file mode 100644 index 0000000..035a043 --- /dev/null +++ b/node_modules/node-2fa/README.md @@ -0,0 +1,68 @@ +# node-2fa + +Easy 2-Factor Integration For Node.js + +There are a number of applications which support 2-Factor Authentication, namely + +- Authy [iPhone](https://itunes.apple.com/us/app/authy/id494168017?mt=8) | [Android](https://play.google.com/store/apps/details?id=com.authy.authy&hl=en) | [Chrome](https://chrome.google.com/webstore/detail/authy/gaedmjdfmmahhbjefcbgaolhhanlaolb?hl=en) | [Linux](https://www.authy.com/personal/) | [OS X](https://www.authy.com/personal/) | [BlackBerry](https://appworld.blackberry.com/webstore/content/38831914/?countrycode=US&lang=en) +- Google Authenticator [iPhone](https://itunes.apple.com/us/app/google-authenticator/id388497605?mt=8) | [Android](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=en) +- Microsoft Authenticator [Windows Phone](https://www.microsoft.com/en-us/store/apps/authenticator/9wzdncrfj3rj) | [Android](https://play.google.com/store/apps/details?id=com.microsoft.msa.authenticator) + +This module uses [`notp`](https://github.com/guyht/notp) which implements `TOTP` [(RFC 6238)](https://www.ietf.org/rfc/rfc6238.txt) +(the _Authenticator_ standard), which is based on `HOTP` [(RFC 4226)](https://www.ietf.org/rfc/rfc4226.txt) +to provide codes that are exactly compatible with all other _Authenticator_ apps and services that use them. + +Usage +===== + +```bash +npm install node-2fa --save +``` + +```javascript +const twofactor = require("node-2fa"); + +const newSecret = twofactor.generateSecret({ name: "My Awesome App", account: "johndoe" }); +/* +{ secret: 'XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W', + uri: 'otpauth://totp/My%20Awesome%20App:johndoe?secret=XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W&issuer=My%20Awesome%20App', + qr: 'https://chart.googleapis.com/chart?chs=166x166&chld=L|0&cht=qr&chl=otpauth://totp/My%20Awesome%20App:johndoe%3Fsecret=XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W%26issuer=My%20Awesome%20App' +} +*/ + +const newToken = twofactor.generateToken("XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W"); +// => { token: '630618' } + +twofactor.verifyToken("XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W", "630618"); +// => { delta: 0 } + +twofactor.verifyToken("XDQXYCP5AC6FA32FQXDGJSPBIDYNKK5W", "00"); +// => null +``` + +## API + +### generateSecret(options) + +returns an object containing a 32-character secret (keep user specific, store in DB), a uri (if you want to make your own QR / barcode) and a direct link to a QR code served via HTTPS by the Google Chart API + +options is an object containing `name` which is the name of your app that will show up when the user scans the QR code and `account` which can be the username and will also show up in the user's app. Both parameters are optional + +### generateToken(secret) + +returns an object containing a 6-character token + +### verifyToken(secret, token, window) + +checks if a time-based token matches a token from secret key within a +/- _window_ (default: 4) minute window + +returns either `null` if the token does not match, or an object containing delta key, which is an integer of how for behind / forward the code time sync is in terms of how many new codes have been generated since entry + +ex. +`{delta: -1}` means that the client entered the key too late (a newer key was meant to be used). +`{delta: 1}` means the client entered the key too early (an older key was meant to be used). +`{delta: 0}` means the client was within the time frame of the current key. + +## _n_-Minute Window + +The window is set to 4 by default. Each token is valid for a total of _n_ minutes to account for time drift. diff --git a/node_modules/node-2fa/dist/index.d.ts b/node_modules/node-2fa/dist/index.d.ts new file mode 100644 index 0000000..c0db623 --- /dev/null +++ b/node_modules/node-2fa/dist/index.d.ts @@ -0,0 +1,11 @@ +import notp from "notp"; +import { Options } from "./interfaces"; +export declare function generateSecret(options?: Options): { + secret: string; + uri: string; + qr: string; +}; +export declare function generateToken(secret: string): { + token: string; +} | null; +export declare function verifyToken(secret: string, token?: string, window?: number): notp.VerifyResult | null; diff --git a/node_modules/node-2fa/dist/index.js b/node_modules/node-2fa/dist/index.js new file mode 100644 index 0000000..2086ab2 --- /dev/null +++ b/node_modules/node-2fa/dist/index.js @@ -0,0 +1,51 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.verifyToken = exports.generateToken = exports.generateSecret = void 0; +const tslib_1 = require("tslib"); +const notp_1 = tslib_1.__importDefault(require("notp")); +const crypto_1 = tslib_1.__importDefault(require("crypto")); +const thirty_two_1 = tslib_1.__importDefault(require("thirty-two")); +function generateSecret(options) { + var _a; + const config = { + name: encodeURIComponent((_a = options === null || options === void 0 ? void 0 : options.name) !== null && _a !== void 0 ? _a : "App"), + account: encodeURIComponent((options === null || options === void 0 ? void 0 : options.account) ? `:${options.account}` : ""), + }; + const bin = crypto_1.default.randomBytes(20); + const base32 = thirty_two_1.default.encode(bin).toString("utf8").replace(/=/g, ""); + const secret = base32 + .toLowerCase() + .replace(/(\w{4})/g, "$1 ") + .trim() + .split(" ") + .join("") + .toUpperCase(); + const query = `?secret=${secret}&issuer=${config.name}`; + const encodedQuery = query.replace('?', '%3F').replace('&', '%26'); + const uri = `otpauth://totp/${config.name}${config.account}`; + return { + secret, + uri: `${uri}${query}`, + qr: `https://chart.googleapis.com/chart?chs=166x166&chld=L|0&cht=qr&chl=${uri}${encodedQuery}` + }; +} +exports.generateSecret = generateSecret; +function generateToken(secret) { + if (!secret || !secret.length) + return null; + const unformatted = secret.replace(/\W+/g, "").toUpperCase(); + const bin = thirty_two_1.default.decode(unformatted); + return { token: notp_1.default.totp.gen(bin) }; +} +exports.generateToken = generateToken; +function verifyToken(secret, token, window = 4) { + if (!token || !token.length) + return null; + const unformatted = secret.replace(/\W+/g, "").toUpperCase(); + const bin = thirty_two_1.default.decode(unformatted); + return notp_1.default.totp.verify(token.replace(/\W+/g, ""), bin, { + window, + time: 30, + }); +} +exports.verifyToken = verifyToken; diff --git a/node_modules/node-2fa/dist/interfaces.d.ts b/node_modules/node-2fa/dist/interfaces.d.ts new file mode 100644 index 0000000..6fe394d --- /dev/null +++ b/node_modules/node-2fa/dist/interfaces.d.ts @@ -0,0 +1,4 @@ +export interface Options { + name: string; + account: string; +} diff --git a/node_modules/node-2fa/dist/interfaces.js b/node_modules/node-2fa/dist/interfaces.js new file mode 100644 index 0000000..c8ad2e5 --- /dev/null +++ b/node_modules/node-2fa/dist/interfaces.js @@ -0,0 +1,2 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); diff --git a/node_modules/node-2fa/package.json b/node_modules/node-2fa/package.json new file mode 100644 index 0000000..351a128 --- /dev/null +++ b/node_modules/node-2fa/package.json @@ -0,0 +1,58 @@ +{ + "name": "node-2fa", + "version": "2.0.3", + "description": "Easy 2-Factor Integration For Node.js", + "main": "dist/index.js", + "types": "dist/index.d.ts", + "private": false, + "scripts": { + "test": "eslint . --fix&&jest", + "prepublishOnly": "npm run test&&npm run build", + "build": "tsc" + }, + "files": [ + "dist", + "package.json", + "readme.md" + ], + "repository": { + "type": "git", + "url": "git+https://github.com/jeremyscalpello/node-2fa" + }, + "keywords": [ + "auth", + "2fa", + "mfa", + "token", + "key", + "base32", + "code", + "generator" + ], + "contributors": [ + "Jeremy Scalpello <jeremy@scalpello.info>", + "Alistair Smith <hey@alistair.cloud>" + ], + "license": "Apache-2.0", + "homepage": "https://github.com/jeremyscalpello/node-2fa#readme", + "dependencies": { + "@types/notp": "^2.0.0", + "notp": "^2.0.3", + "thirty-two": "1.0.2", + "tslib": "^2.1.0" + }, + "devDependencies": { + "@types/jest": "^26.0.20", + "@types/node": "^14.14.20", + "@typescript-eslint/eslint-plugin": "^4.12.0", + "@typescript-eslint/parser": "^4.12.0", + "eslint": "^7.17.0", + "jest": "^26.6.3", + "prettier": "^2.2.1", + "ts-jest": "^26.4.4", + "typescript": "^4.1.3" + }, + "prettier": { + "printWidth": 120 + } +} |