2fa-auth-v1
v1.0.2
Published
A simple npm package for 2FA (Two-Factor Authentication) using TOTP (Time-Based One-Time Password) and QR codes.
Downloads
10
Readme
2FA Authentication
A simple npm package for 2FA (Two-Factor Authentication) using TOTP (Time-Based One-Time Password) and QR codes.
Installation
Install the package using npm:
npm install 2fa-auth
Usage
1. Generating the QR Code
Use the generate.js script to generate a QR code and save the secret.
generate.js
const fs = require('fs');
const TwoFactorAuth = require('2fa-auth');
const twoFA = new TwoFactorAuth();
const user = '[email protected]';
twoFA.generateQRCode(user, (err, qrCodeImage) => {
if (err) {
console.error('Failed to generate QR code:', err);
} else {
console.log('QR Code Image:', qrCodeImage);
// Save the secret to a file
const secret = twoFA.secret;
console.log('Secret Key ', secret);
}
});
2. Verifying the Token
Use the verify.js script to verify the token generated by a 2FA app using the secret key.
verify.js
const TwoFactorAuth = require('2fa-auth');
const secret = 'BQKBELJ3B4BHYJQF';
const twoFA = new TwoFactorAuth(secret);
const token = '777427';
const isValid = twoFA.verifyToken(token);
console.log('Is Token Valid?', isValid);
License
This project is licensed under the MIT License. See the LICENSE file for details.
Make sure to replace '[email protected]'
and 'BQKBELJ3B4BHYJQF'
with actual user email and secret key respectively, and adjust the usage examples as needed. Additionally, you should include a LICENSE
file in your project directory if you haven't already, containing the text of the MIT License or whichever license you choose.