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

@thesinding/authentication-refresh-token

v0.0.7

Published

Refresh Token authentication strategy for @feathers/authentication

Downloads

16

Readme

Refresh Tokens Strategy for Feathers Authentication

This strategy adds refresh tokens to feathersjs authentication.

Requirements

Currently it only supports when it's used in conjunction with the "Local Strategy" aswell.

What it does

When a user authenticates with local authentication, the receive a "Refresh Token" which the user can use to create new JWT access tokens.

Installation

To install and use the strategy, first run npm install. npm install @thesinding/authentication-refresh-token

Now add the strategy to your authentication.(ts|js) like so:

... // other imports
const { RefreshTokenStrategy } =  require('@thesinding/authentication-refresh-token');

module.exports  =  app  => {
	... // Other authentications strategies
	authentication.register('refresh-token', new  RefreshTokenStrategy()); // add the strategy
	... // Rest of the file
};

Then add the authentication hook like so:

const { RefreshTokenStrategy, addRefreshToken } =  require('@thesinding/authentication-refresh-token');

module.exports  =  app  => {
	... // Other authentications strategies
	authentication.register('refresh-token', new  RefreshTokenStrategy()); // add the strategy

	app.service('authentication').hooks({ // you might have to add this
		... // before hooks
		after: {
			create: [addRefreshToken()] // add the hook
		},
		// error hooks
	});
	... // Rest of the file
};

Create a service, this is where your app will store the refresh tokens. Use what every database adapter you want, depending on your setup. feathers generate service

Now it all need to be added in the configuration:

{
  "host": "localhost",
  "port": 3030,
  "public": "../public/",
  "paginate": {
    "default": 10,
    "max": 50
  },
  "authentication": {
	 // other settings
    "authStrategies": [
      "jwt",
      "local",
      "refresh-token" // Add the refresh token as a strategy
    ],
    "jwtOptions": {  // Your JWT options  },
    // other strategies,
    "refresh-token": {
	  "entity": "refresh-token", // this needs to be the same as in your model (if you have one)
	  "service": "refresh-tokens", // The service which you have created
	  "clientIdField": "clientId" // the name of the client id field
    }
   }
}

Done.

Try to authenticate as normal eg.

curl -H "Content-Type: application/json" -X POST -d '{ "strategy": "local", "email":"[email protected]","password":"X2y6" }' http://localhost:3030/authenticate

The response should look something like this:

{
    "authentication": {
        "strategy": "local"
    },
    "accessToken": "TOKEN DATA", // The access token
    "user": { // User data },
    "refreshToken": "9683fe86-aef1-4b3d-a0eb-da57624c62cf" // Store this token
}

The refreshToken can now be used to refresh the accessToken like so:

curl -H "Content-Type: application/json" -X POST -d '{ "strategy": "refresh-token", "clientId": "The ID of the user", "refreshToken": "The clients refresh token" }' http://localhost:3030/authenticate

It's respond should look similar to this, if the refreshToken and the clientId matches:

{
  "authentication": {
    "strategy": "refresh-token"
  },
  "accessToken": "TOKEN DATA" // The refreshed access token
}

This is still new, so use with caution.

Changelog:

0.0.1 - initial release