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

denali-jwt

v1.0.0-beta.7

Published

Middleware that validates JsonWebTokens and sets `this.jwt`.

Downloads

81

Readme

Denali Jwt

Middleware that validates JsonWebTokens and sets this.jwt.

This module lets you authenticate HTTP requests using JWT tokens in your Denali applications. JWTs are typically used to protect API endpoints, and are often issued using OpenID Connect.

Install

$ denali install denali-jwt

Developing

  1. Clone the repo down
  2. yarn install
  3. denali server
  4. Hit localhost:3000

Tests

$ denali test

Usage

The JWT authentication middleware authenticates callers using a JWT. If the token is valid, this.jwt will be set with the JSON object decoded to be used by later middleware for authorization and access control.

For example,

// config/environment.js
export default function environmentConfig(environment: any) {
  let config = {
    'denali-jwt': {
      issuer: 'https://mydomain.com/',
      audience: 'some-audiance',
      secret: process.env.JWT_SECRET
      algorithms: ['RS256']
    }
  };

  return config;
// app/actions/application.js

import VerifyJwt from 'denali-jwt';
import { Action } from 'denali';

export default abstract ApplicationAction extends Action {
  static before = ['verifyJwt'];

  verifyJwt = VerifyJwt();
}

You can specify audience and/or issuer as well:

'denali-jwt' = {
  secret: 'shhhhhhared-secret',
  audience: 'http://myapi/protected',
  issuer: 'http://issuer'
};

If the JWT has an expiration (exp), it will be checked.

If you are using a base64 URL-encoded secret, pass a Buffer with base64 encoding as the secret instead of a string:

'denali-jwt' = {
  secret: new Buffer('shhhhhhared-secret', 'base64')
};

This module also support tokens signed with public/private key pairs. Instead of a secret, you can specify a Buffer with the public key

let publicKey = fs.readFileSync('/path/to/public.pub');
'denali-jwt' = {
  secret: publicKey
};

By default, the decoded token is attached to this.jwt but can be configured with the requestProperty option.

'denali-jwt' = {
   secret: publicKey,
   requestProperty: 'auth'
};

requestProperty utilizes lodash.set and will accept nested property paths.

A custom function for extracting the token from a request can be specified with the getToken option. This is useful if you need to pass the token through a query parameter or a cookie. You can throw an error in this function and it will be handled by denali-jwt.

'denali-jwt' = {
  secret: 'hello world !',
  getToken: function fromHeaderOrQuerystring (req) {
    if (req.headers.authorization && req.headers.authorization.split(' ')[0] === 'Bearer') {
        return req.headers.authorization.split(' ')[1];
    } else if (req.query && req.query.token) {
      return req.query.token;
    }
    return null;
  }
};

Related Modules

Contributors

Check them out here

License

This project is licensed under the MIT license. See the LICENSE file for more info.