nitro-2fa-auth
v1.0.2
Published
Nitro is 2FA modele with words
Downloads
18
Maintainers
Readme
Nitro 2FA Authentication
Nitro 2FA is a Two-Factor Authentication system that uses word transformations for enhanced security. This project provides a set of functions to manage word sources and perform authentication checks.
Table of Contents
Prerequisites
Before you start, make sure you have the following installed:
- Node.js and npm
Installation
Clone this repository:
git clone https://github.com/iamrosada/nitro-2fa.git
Navigate to the project directory:
cd nitro-2fa
Install the required packages:
npm install
Usage
Choose Word Source
The chooseWordSource
function allows you to select the word source based on your configuration.
const sourceConfig = {
sourceType: "file",
userWords: "youruserwords",
userPassword: "yourpassword",
};
chooseWordSource(sourceConfig)
.then((result) => {
console.log("Words Array:", result.wordsArray);
console.log("Encrypted Data:", result.encryptedData);
})
.catch((error) => {
console.error("Error:", error);
});
Perform Nitro 2FA Authentication Check
The createNitro2FAContext
function creates a context for authentication checks.
const context = createNitro2FAContext();
const words = ["word1", "word2", "word3"];
const userAnswer = "youranswer";
const verificationResult = await context.nitro2FA(words, userAnswer);
if (verificationResult.status === "Correct") {
console.log("Authentication successful!");
} else {
console.log("Authentication failed. New question:", verificationResult.newQuestion);
}
Create Nitro 2FA Context
The createNitro2FAContext
function creates a context for the Nitro 2FA system, allowing you to retrieve word transformations and verify user answers.
import { createNitro2FAContext } from 'nitro-2fa-auth';
const myContext = createNitro2FAContext();
const transformationInfo = myContext.displayTransformationInfo();
console.log(transformationInfo);
const userAnswer = 'user_answer_here';
const result = myContext.nitro2FA(wordsArray, userAnswer);
console.log(result);
Example with REST API, Nitro 2FA Context
import bodyParser from 'body-parser';
import { chooseWordSource, createNitro2FAContext } from 'nitro-2fa-auth';
import express, { Request, Response } from 'express';
const app = express();
const port = 3000;
app.use(bodyParser.json());
let userPassword = "user_password_here";
const myContext = createNitro2FAContext();
let wordsArrayFor2FA: string[] = [];
app.get('/2fa', async (req: Request, res: Response) => {
try {
const words = await chooseWordSource({ sourceType: 'file', userPassword: userPassword });
wordsArrayFor2FA = words.wordsArray;
res.json({ message: words.wordsArray, keySaveIntoDatabase: words.encryptedData });
} catch (error) {
console.error("Error:", error);
res.status(500).json({ error: "Internal server error" });
}
});
app.get('/passwordReset', (req: Request, res: Response) => {
const transformationInfo = myContext.displayTransformationInfo();
res.json({ transformationInfo });
});
app.post('/checkAnswer', async (req: Request, res: Response) => {
try {
const userAnswer = req.body.user_answer;
const result = await myContext.nitro2FA(wordsArrayFor2FA, userAnswer);
res.json(result);
} catch (error) {
console.error("Error:", error);
res.status(500).json({ error: "Internal server error" });
}
});
app.listen(port, () => {
console.log(`Server is listening on port ${port}`);
});
Code Structure
The project's code is organized as follows:
nitroEncryption.js
: Encryption and decryption functions.readWordsFromFile.js
: Function to read words from a file.transformWord.js
: Function for transforming words.getRandomTransformation.js
: Function to get a random transformation.provideUserWords.js
: Function to provide user-specific words.
Replace placeholders like 'your_password_here'
and 'user_answer_here'
with actual values.
Contributing
Contributions to the Nitro 2FA project are welcome! You can contribute by submitting issues, feature requests, or pull requests.
If you want to contribute to this project, follow these steps:
- Fork the project.
- Create a new branch for your feature or fix.
- Commit your changes.
- Push to your fork.
- Open a pull request.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Contact
If you have any questions or need assistance, you can reach out to Luis de Agua Rosada.