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

passport-2fa-faxes

v1.1.0

Published

TOTP based Two-Factor Authentication for Passport and Node.js, edited and updated.

Downloads

46

Readme

This module lets you authenticate using a username, password and TOTP code in your Node.js applications. By plugging into Passport, 2FA TOTP authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express. You can use any TOTP code generators to generate one-time passwords, for example Google Authenticator.

Key Changes From Original:

  • Added GoogleAuthenticator.verify() function.
  • Added totpOptional to allow accounts to succeed authentication without 2FA being attached on the account, but if it is, it will require it.
  • Added removeUserKeys as an option to remove the defines keys from the users session object. for example, if you return a whole DB entry, you can here remove sensitive data like the password from the session object.
  • Cleaned up some functions
  • If done() function has "UNREG" passed as the third parameter it resolves with removeUserKeys option utilised.
  • Performance changs and variable renaming.

Install

$ npm install passport-2fa-faxes

Usage

Configure Strategy

The 2FA TOTP authentication strategy authenticates a user using a username, password and TOTP value generated by a hardware device or software application (known as a token). The strategy requires a callback to verify a username and password and a callback to setup TOTP generator.

var authenticator = require('passport-2fa-faxes').authenticator;
var TwoFAStartegy = require('passport-2fa-faxes').Strategy;

...

passport.use(new TwoFAStartegy(function (username, password, done) {
    // 1st step verification: username and password
    
    User.findOne({ username: username }, function (err, user) {
        if (err) { return done(err); }
        if (!user) { return done(null, false); }
        if (!user.verifyPassword(password)) { return done(null, false); }
        return done(null, user);
    });
}, function (user, done) {
    // 2nd step verification: TOTP code from Google Authenticator
    
    if (!user.secret) {
        done(new Error("Google Authenticator is not setup yet."));
    } else {
        // Google Authenticator uses 30 seconds key period
        // https://github.com/google/google-authenticator/wiki/Key-Uri-Format
        
        var secret = authenticator.decodeSecret(user.secret);
        done(null, secret, 30);
    }
}));

Authenticator

Previously GoogleAuthenticator, this object services utility methods for authentication. This is tested with Google Authenticator. However, others like Microsoft Authenticator and Authy use the same logic and should work fine.

  • authenticator.register(username) - Generates a secret key and render a QR code (SVG) to register an account in an authenticator app.
  • authenticator.decodeSecret(secret) - Converts BASE 32 encoded string to byte array.
  • authenticator.verify(code, secret) - Verify a 2FA code.
Strategy Options

This strategy takes an optional options hash before the function. Example: new TwoFAStartegy({/* options */, verifyUsernameAndPasswordCallback, verifyTotpCodeCallback})

Here are the option available in the strategy:

  • usernameField - Optional, defaults to 'username'
  • passwordField - Optional, defaults to 'password'
  • codeField - Optional, defaults to 'code'
  • window - Optional defaults to 6. A window to generate TOTP code.
  • skipTotpVerification - Optional defaults to false. TOTP code verification is skipped if it is set to be true.
  • passReqToCallback - Optional defaults to false. Pass request object to the callbacks if it is set to be true.
  • totpOptional - Optional defaults to false. Allow login to succeed, if no 2FA is present for account.
  • removeUserKeys - Optional defaults to []. Removed the defined keys from the req.user object in the session data.

Authenticate Requests

Use passport.authenticate(), specifying the '2fa-totp' strategy, to authenticate requests.

router.post('/', passport.authenticate('2fa-totp', {
    successRedirect: '/',
    failureRedirect: '/login'
}));

Credits

Originally created by Ilya Verbitskiy (ilich) in the package passport-2fa-totp. With edits made by FAXES and the Weblutions team.