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

@essential-projects/auth

v2.1.0

Published

Passport-based module to authorize user-requests

Downloads

7

Readme

Auth

Passport-based module to authorize user-requests, for example with google.

Features

  • Provides a simple to use middleware, that handles all the sessioning and authorizing
  • Automatically refreshes the access-token if it expired, before calling the next middleware
  • Provides the necessary routes to completely handle the login-process
  • Provides event-based-auth-hooks so you can dely/reject authorization

Configuration

  1. Copy the demo-config from doc/auth.json to config/ENVIRONMENT/auth/auth.json in your project
  2. Replace all the upper-case strings with your corresponding config
  3. Replace other configurations if necessary (in the demo-config, http://localhost:8000 is the backend, and http://localhost:9000 is the frontend)
  4. Delete all the strategies that you don't need from the config

Setup

  1. In your http-extension-module in your application run npm install @5minds/auth --save
  2. In your http-extensions ioc_module.js
  3. Require the module with const auth = require('@5minds/auth/ioc_module');
  4. Register the module at the IoC-Container with: auth.registerInContainer(container);
  5. add 'auth' as dependency to your http-extension
  6. In your http-extensions initializeMiddlewareBeforeRouters call this.auth.initializeSessioning(this.app);

Usage

  • Let the IoC-Container inject the auth-module into the classes, that register the routes that need authorization

  • add the auth-modules middleware to the routes that need authorization, like so:

this.router.get('/tasks/:smartlistId', this.auth.middleware, YOUR_NEXT_MIDDLEWARE_GOES_HERE);
  • If the authorization failed for some reason, the middleware will redirect to the failRedirect-route provided in the config, and no other middleware will be called

  • If the authorization succeeded, the request now has a session-object and a user-object. The user-object has the following structure:

    for google-auth

    req.user = {
      credentials: {
        access_token: 'SOME_OAUTH_ACCESS_TOKEN',
        refresh_token: 'SOME_OAUTH_REFRESH_TOKEN',
        refresh_after: 'THE_ACCESS_TOKEN_EXPIRATION_TIME',
      },
      profile: {
        name: {
          first: 'Heiko',
          last: 'Mathes',
          display: 'Heiko Mathes',
        },
        language: 'de',
        image: 'https://someUrl',
        email: '[email protected]',
      },
      userToken: 'SOME_TOKEN_THAT_IDENTIFIES_THE_USER',
      strategy: 'google',
    }

    for local password-auth:

    req.user = {
      profile: THE_USER_PROFILE_OBJECT_FROM_YOUR_APP,
      strategy: 'password',
    }

local password-strategy

For the local password-strategy to work, you need to listen to the auth-modules userLogin-event at some point in your application.
This event will get fired, everytime a user wants to login. A Demo-implementation could look like this:

this.auth.on('userLogin', (userParams) => {

  this.user.getUserByMailAddress(userParams.username)
    .then((userInfo) => {

      if (!userInfo.password === this.hash(userParams.password)) {
        logger.debug(`${userParams.username} tried to login with a wrong password`);
        return Promise.reject(new Error('password mismatch'));
      }

      return userParams.resolve(userInfo);
    })
    .catch((error) => {
      userParams.reject(error);
    });
});

The userParams-Object looks like this:

{
  username: 'SOMEUSERNAME',
  password: 'SOMEPASSWORD',
  resolve: FUNCTION,
  reject: FUNCTION,
}

You need to call resolve, when the user could be verified, or reject if something went wrong.
Whatever you give it as parameter in the userParams.reject-method will be in req.user.profile in later requests

Events

For all auth-medthods, the following events can be listened on:

requestAuthorized

This event gets called, every time a request is about to get authorized. Every listener gets a userParams-Object that looks like this:

{
  request: SOMEREQUEST,
  user: USER\_OBJECT,
  resolve: FUNCTION,
  reject: FUNCTION,
}
  • Only when all listeners have called the resolve-function will the request
    be allowed to the next middleware (the one after the auth.middleware)
  • When any one of the listeners rejects, the whole request will be rejected
    with a 403 - Forbidden
  • Every listener must call resolve or reject (but not both) exactly once!