MFA-AUTHY

A TypeScript library for implementing Multi-Factor Authentication (MFA). This library provides essential features like generating MFA authentication keys, tokens, verifying tokens, and creating Time-based One-Time Password (TOTP) URIs for use with popular authenticator apps.

!NPM Downloads

Key Benefits

- Enhanced Security: Strengthens authentication by reducing the risk of unauthorized access even if passwords are compromised.
- Ease of Integration: Includes prebuilt, reliable functions for generating keys, tokens, and TOTP URIs, reducing development effort.
- Wide Compatibility: Works seamlessly with popular apps like Google Authenticator, Authy, and Microsoft Authenticator.
- Customizable Options: Adjust settings like token validity duration, allowed clock drift, and encryption methods.
- Compliance Support: Helps meet security standards like PCI-DSS, HIPAA, and GDPR.

Supported Authenticator Apps

This library is compatible with popular authentication apps, including:

- Google Authenticator
- Authy
- Microsoft Authenticator among others.

Installation

Install the package using npm:
``bash
npm install mfa-authy
`

Usage

$3

`typescript
import {
generateMFAAuthKey,
verifyMFAAuthToken,
generateTotpUri,
} from 'mfa-authy';
`

$3

`typescript
const generatedKey = generateMFAAuthKey();
`

$3

`typescript
const isTokenValid = verifyMFAAuthToken(generatedKey, generatedToken);
`

$3

This function generates a base64-encoded URI that can be scanned by authenticator apps like Google Authenticator or Authy. It now supports asynchronous functionality for better integration:
`typescript
const totpUri = await generateTotpUri(generatedKey, 'user@example.com', 'MyAuthenticatorApp', 'SHA256', 8, 60);
`
Example base64 response:
`base64
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOQAAADkCAYAAACIV4iNAAAAAklEQVR4AewaftIAAAxKSURBVO3BQW4ER5IAQfcC//9lXx3jlEChm1RqNszsH6y1rvCw1rrGw1rrGg9rrWs8rLWu8bDWusbDWusaD2utazysta7xsNa6xsNa6xoPa61rPKy1rvGw1rrGw1rrGg9rrWv88CGVv1QxqfymihOVqeINlaniDZWp4kTlpGJS+U0Vk8pUcaIyVUwqf6niEw9rrWs8rLWu8bDWusYPX1bxTSpvVLyhMlV8k8obKm9UTConFZ+omFR+k8o3VXyTyjc9rLWu8bDWusbDWusaP/wylTcq3qh4Q+VEZaqYVE5UpopJZao4UZkqTipOVKaKSWWq+ETFicpJxaTyTSpvVPymh7XWNR7WWtd4WGtd44f/OJU3Kk5UJpW/pDJVnKhMFW+onKhMFVPFJyomlTcq/pc8rLWu8bDWusbDWusaP/zHVUwqn6iYVKaKT1RMKlPFpPKGyknFN6mcVEwqn6j4X/aw1rrGw1rrGg9rrWv88Msq/k0Vk8onVKaKSeWkYqqYVE4q3lA5UZkqJpWpYqqYVD5RMalMFd9UcZOHtdY1HtZa13hYa13jhy9T+UsqU8WkMlVMKlPFpDJVTCpTxaRyojJVTConKlPFX1KZKiaVqWJS+YTKVHGicrOHtdY1HtZa13hYa13jhw9V/JeoTBUnFScVk8pfqnhD5URlqvhExaTyCZU3Kv5LHtZa13hYa13jYa11jR8+pDJVTConFZPKGxUnFZPKN6lMFZ9QOVH5RMWkMlVMKicVk8pUcVLxm1SmihOVqWJSOan4xMNa6xoPa61rPKy1rvHDv0zlpGJSmVSmiknlRGWqmFSmiqniRGWq+ETFpHJS8Zcq3lA5qZhUpoqTihOVqWJSmSp+08Na6xoPa61rPKy1rvHDhypOKk5UTlSmikllUpkqTlROKt5QmSomlaniDZWp4ptUpooTlTcqfpPKGxU3eVhrXeNhrXWNh7XWNX74ZSqfqHijYlI5qZhUTireUPmEyonKVHGiMlW8ofKbVE4q3qg4UTmp+EsPa61rPKy1rvGw1rrGDx9SeaPiRGVSmSpOVKaKSWVSmSreUJkqflPFicpJxTdVTConKm9UnKhMFZPKScWk8obKVPGJh7XWNR7WWtd4WGtd44dfVjGpTBUnFZPKScWkMlVMKpPKScVUMam8UTGpnKhMFW+oTBWTyknFpDJVTCpTxaQyVXxTxaRys4e11jUe1lrXeFhrXeOHX6ZyonKi8obKVPFGxYnKVHFSMalMKlPFN1WcqLyhcqIyVUwqb6hMFW+oTBUnFZPKScU3Pay1rvGw1rrGw1rrGj/8sopJ5aTiRGWq+ETFicpU8YbKJ1ROKqaKSWWqOKk4UZkqPlHxiYo3VG72sNa6xsNa6xoPa61r2D/4IpWp4kTlJhWTylQxqUwVk8pJxRsqJxVvqJxUnKhMFScqJxVvqJxUTCqfqJhUpopPPKy1rvGw1rrGw1rrGvYPPqDyRsWkclIxqUwVb6icVHxC5Y2KE5VPVEwqU8UbKlPFN6l8U8UbKp+o+MTDWusaD2utazysta7xw5dVTCqTylQxqUwqU8WkclLxhspJxaRyUnGiclLxhsqkMlWcqEwVJypTxaTyiYpJ5aTiROWNihOVb3pYa13jYa11jYe11jXsH3xA5aRiUpkqPqEyVdxM5aTiDZWTiknlpGJSOak4UZkqTlT+UsWkMlX8pYe11jUe1lrXeFhrXeOHL6uYVE5U/pLKScU3qZxUTCpTxaQyVUwqk8pU8ZtUvqniEypTxTepTBWfeFhrXeNhrXWNh7XWNX74ZRWTylQxqUwVb6hMFVPFpPIJlZOKSWVS+YTKVDGpvKFyUjGpTBUnKp9QmSreUJkqpooTld/0sNa6xsNa6xoPa61r/PDLVKaKSeVE5Y2KSWWqOFGZKk4qJpU3KiaVSeUNlU9UTConFd9U8YbKJ1ROKqaKSeWbHtZa13hYa13jYa11jR8+VPFNFW+oTCpvVEwqk8pUMamcqEwVk8pUMalMFW+onKhMFVPFpHJSMalMFZPKicobFW+onKj8pYe11jUe1lrXeFhrXeOHP6byhspU8UbFicpUcaJyE5Wp4kRlqphUTipOVE5UTlROKiaVE5Wp4qRiUvlLD2utazysta7xsNa6xg8fUpkqvqnim1TeUJkqTlSmiknlmyreqJhUTiomlTcqTlTeUHmj4jdVfNPDWusaD2utazysta5h/+CLVKaKSeUvVUwqU8WkMlVMKlPFicpUMan8mypOVKaKSWWq+ITKf0nFNz2sta7xsNa6xsNa6xo/fFnFGxVvqHyTyonKJypOKk5UpopJ5aRiUplUfpPKVHFSMamcVEwqb1RMKlPFX3pYa13jYa11jYe11jV++JDKVDGpnKhMFZPKScWJylTxhspUMalMFScqJxVTxaQyVUwqb1ScqEwqb1RMKlPFpPKXVKaKE5Wp4pse1lrXeFhrXeNhrXWNH35ZxYnKScWkMqm8oTJVTCpTxaQyVUwqU8VJxYnKVHFSMal8omJSmSreqPhExaRyUjGpfKJiUpkqPvGw1rrGw1rrGg9rrWv88KGKE5WpYqqYVE4qJpWpYlKZKiaVNypOKiaVN1SmihOVk4pJ5URlqnhD5aRiUnlD5aTipGJSmVT+TQ9rrWs8rLWu8bDWusYPX6ZyojJVTBUnKlPFN1VMKlPFpDJVnFRMKlPFpPKbVD6hMlVMKm9UnKhMFZPKJypOVH7Tw1rrGg9rrWs8rLWu8cO/TOWbVKaKk4pPVJxUfFPFpDJVnFS8ofKJipOKE5Wp4qRiUpkqTlSmiqliUvmmh7XWNR7WWtd4WGtd44dfVjGpTBVvqJxUnKh8QuWkYlKZKk5UvknlpOKk4kRlUpkqPlHxm1TeUJkqvulhrXWNh7XWNR7WWtf44csqJpWpYlKZKiaVqWJSmSomlZOKSeWNikllqnij4o2K36RyUjGpTConFZPKScWJylQxqZxUvKEyVXziYa11jYe11jUe1lrX+OFDKm+oTBWTylTxhso3VXxC5aRiUpkqTlSmik+oTBUnKlPFpHKiMlVMKpPKGyonFZPKv+lhrXWNh7XWNR7WWtf44csq3lA5UTmpmFROKiaVqeJEZao4qThRmSreqJhUpopJZVKZKiaVqeKNijdUvqniROUmD2utazysta7xsNa6xg9fpvJGxRsqk8pU8UbFpHJScVIxqUwVn1CZKt6oeKPipGJSmSomlU9UTCpvqJxUTCpTxW96WGtd42GtdY2HtdY17B98kcpU8YbKScWJylTxCZWTikllqnhDZaqYVH5TxaTyiYpPqEwVk8pJxSdU3qj4xMNa6xoPa61rPKy1rmH/4ItU3qj4JpVvqphUpopJ5TdVTCqfqJhUPlFxojJVTConFf/LHtZa13hYa13jYa11DfsHH1B5o+INlZOKSWWqOFF5o+INlZOKE5VvqvgmlZOKN1ROKiaVb6qYVKaKSWWq+MTDWusaD2utazysta7xw4cqflPFiconKj6h8kbFJyreUDlROamYVKaKSWVS+UTFGxVvqLyh8pse1lrXeFhrXeNhrXWNHz6k8pcqTip+k8pJxYnKVDGpvKEyVZyonFRMKm9UTConFZPKpDJVvKEyVZyoTBWTym96WGtd42GtdY2HtdY1fviyim9SeUNlqphUTireqPiEylQxqZxUvFExqUwq31RxojJVfFPFN1X8poe11jUe1lrXeFhrXeOHX6byRsUbFZPKGxUnKlPFpDJVTConFZPKiconVE4qJpWp4g2Vk4pJ5RMq36RyUvFND2utazysta7xsNa6xg//cSpTxaQyVbxRcVLxCZWp4g2VqWJSmSo+oTJVTConFZPKVDGpfKJiUjmpOFH5TQ9rrWs8rLWu8bDWusYP/8+onFRMKlPFpHJS8ZsqJpWp4kRlqnhD5RMVk8pU8QmV/5KHtdY1HtZa13hYa13jh19W8ZsqJpWpYlJ5o2JSmSpOVKaKSeWk4kTlDZWp4o2KT6h8k8pUMVV8QmWq+E0Pa61rPKy1rvGw1rrGD1+m8pdUTlROKk5UTlTeULmZyhsqU8VJxaRyojJVTBWTyknFJ1ROKj7xsNa6xsNa6xoPa61r2D9Ya13hYa11jYe11jUe1lrXeFhrXeNhrXWNh7XWNR7WWtd4WGtd42GtdY2HtdY1HtZa13hYa13jYa11jYe11jUe1lrX+D9NKIN6tFQSVAAAAABJRU5ErkJggg==
`

$3

To render the QR code in a web page:
`html

`

Features

- Key Generation: Securely generate unique authentication keys.
- Token Verification: Validate tokens generated by authenticator apps.
- TOTP URI Creation: Generate QR codes for easy integration with apps.
- Customizable Parameters: Specify token length, hashing algorithms, and expiration duration.

$3

Check the textExample.txt file

$3

To run the test suite, ensure that you have a testing framework installed (e.g., Jest), and then execute:

`
npm run test
``

$3

This project is licensed under the MIT License - see the LICENSE file for details.