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

auth-challenge-response

v0.5.1

Published

Easy-to-use challenge-response authentication, secure authentication in insecure environment.

Downloads

8

Readme

auth-challenge-response

NPM

Features

  • Secure authentication in insecure environment
  • Easy to setup
  • No database required for authentication

Usage

Server needs to implement two routes to perform authentication process:

  • challenge, e.g. /auth/challenge: this route will be used to send challenge and salt to the client
  • authentication, e.g. /auth/authenticate: this route will be used to receive user password hash from the client

Optional functions for routes to check validity of created session and logout are also available. In this case minimal application that implements challenge-response authentication will be:

    var express = require('express'),
        app = express(),
        cookieParser = require('cookie-parser'),
        bodyParser = require('body-parser'),
        auth = require('auth-challenge-response').auth(app, {secret: 'secret', checkPassword: checkPassword})
    
    // checkPassword computes password hash using 
    // the same method the client is expected to use
    function checkPassword(challenge, clientHash, cb) {
        // TODO:
        // 1. Select user password hash from the database (challenge.username)
        // 2. Compute the second hash using generated challenge (challenge.value)
        // 3. Compare with the received client data (clientHash)
        // 4. If hashes do not match, send error object with the callback function
        // auth.hash is PBDKF2 using SHA-1
        var challengeValue = challenge.value || '',
            serverHash = auth.hash(auth.hash('password', 'user-secret'), challengeValue)
        if (challenge.username === 'username' && clientHash === serverHash) {
            cb()
        } else {
            cb({status: 403, message: 'ACCESS DENIED'})
        }   
    }

    app.use(cookieParser())
    
    // Check authentication: checks that authentication data is still valid
    // and sets res.locals.authenticated variable
    app.get('*', auth.checkAuthentication)
    
    // auth.challenge sends challenge and secret to client:
    // { id: challengeId, username: username, secret: secret, value: challengeValue }
    app.get('/auth/challenge/', auth.challenge)
    
    // auth.authenticate authenticates user
    // Client sends challengeId and password hash in any format 
    // supproted by the auth-challenge-response
    // Examples:
    // Query: /auth/authenticate?id=123&hash=z80kh2n...
    // Body, to send with post request: POST /auth/authenticate with JSON body {"id":"123","hash":"z80kh2n..."}
    app.get('/auth/authenticate', auth.authenticate)
    // to support id and hash values in the req.params object:
    // app.get('/auth/authenticate/:id/:hash', auth.authenticate)

    // auth.logout destroys authentication data making 
    // client's token invalid
    // auth.logout checks cookies authToken variable, req.params.token and req.query.token in this order
    app.get('/auth/logout', auth.logout)
    
    // auth.check sends status of authentication (JSON, {valid: true/false})
    // auth.check checks cookies authToken variable, req.params.token and req.query.token in this order
    app.get('/auth/check', auth.check)

    app.get('/', function(req, res, next) {
        // Authentication result is available in res.locals.authenticated 
        var authenticated = res.locals.authenticated
        
        // ...
        
    })

    app.listen(3945, function() {
        var host = this.address().address
        var port = this.address().port
        console.log('Listening at http://%s:%s', host, port)
    })

Theory

Wiki Challenge-Response Authentication