npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

open-otp

v1.0.11

Published

This is an Open-OTP library that generates and verifies Time-based One-Time Passwords (TOTP) using the HMAC-based One-Time Password (HOTP) algorithm.

Downloads

19

Readme

Open-OTP Library

This is an Open-OTP library that generates and verifies Time-based One-Time Passwords (TOTP) using the HMAC-based One-Time Password (HOTP) algorithm.

Installation

npm install open-otp

Usage

import { TOTP, generateSecret } from 'open-otp';

// Generate a new secret key
const secret = generateSecret('TestSite'); // 'KJQWIYXUMZXXEIZGGY3G6JLRRN5SWKCN'

// Create a new TOTP instance
const totp = new TOTP(secret);

// Generate a TOTP
const otp = totp.generateTOTP();

// Verify a TOTP
const verification = totp.verifyTOTP(otp.toString());

console.log(verification);
// Output: { success: true, message: 'TOTP verified' }

API Reference

TOTP class

This class generates and verifies TOTPs.

Constructor

new TOTP(secret, window = 0, interval = 30, otpLength = 6, algorithm = 'sha1')

Creates a new instance of the TOTP class.

Parameters

  • secret (string): A base32 encoded secret.
  • window (number, optional): The number of intervals to check before and after the current time. Default is 0.
  • interval (number, optional): The interval in seconds. Default is 30.
  • otpLength (number, optional): The length of the OTP. Default is 6.
  • algorithm (string, optional): The algorithm to use for HMAC. Default is 'sha1'.

generateTOTP method

generateTOTP()

Generates a TOTP based on the current time.

Returns

  • number: The generated TOTP.

verifyTOTP method

verifyTOTP(inputOTP)

Verifies a TOTP based on the current time.

Parameters

  • inputOTP (string): The input OTP to verify.

Returns

  • { success: boolean, message: string }: An object with the following properties:
    • success (boolean): true if the TOTP is valid, false otherwise.
    • message (string): A message indicating the result of the verification.

InvalidSecretError class

This is an error class that is thrown when the input secret is invalid.

generateSecret function

generateSecret(input)

Generates a secret key for TOTP.

Parameters

  • input (string, optional): An input string to generate a unique secret for each site.

Returns

  • string: A base32 encoded secret.