Repository files navigation

Complete, compliant and well tested module for implementing an OAuth2 server inNode.js.

NOTE: This project has been forked fromoauthjs/node-oauth2-server and is a continuation due to the project appearing to be abandoned. Please seeour issue board to talk about next steps and the future of this project.

npm install @node-oauth/oauth2-server

The@node-oauth/oauth2-server module is framework-agnostic but there are several officially supported wrappers available for popular HTTP server frameworks such asExpress andKoa (not maintained by us).If you're using one of those frameworks it is strongly recommended to use the respective wrapper module instead of rolling your own.

• Supportsauthorization_code,client_credentials,refresh_token andpassword grant, as well asextension grants, with scopes.
• Can be used withpromises,ES6 generators andasync/await (usingBabel).
• FullyRFC 6749 andRFC 6750 compliant.
• Implicitly supports any form of storage, e.g.PostgreSQL,MySQL,MongoDB,Redis, etc.
• Support for PKCE
• Completetest suite.

Documentation is hosted on Read the Docs. We have multiple versions of the docs available:

• stable (master branch)
• development (development branch)

Please leave an issue if something is confusing or missing in the docs.

Most users should refer to ourExpress (active) orKoa (not maintained by us) examples.

More examples can be found here:https://github.com/14gasher/oauth-example

Beginning with version5.x we removed dual support for callbacks and promises.With this version there is only support for Promises / async/await.

With this version we also bumped theengine to Node 16 as 14 is now deprecated.

Version 4.x should not be hard-breaking, however, there were many improvements and fixes that maybe incompatible with specific behaviour in <= 3.x

For more info, please read thechangelog or open an issue, if you think somethingis unexpectedly not working.

This project supports the node versions along theNodeJS LTS releases, focusing on

• Maintenance LTS
• Active LTS
• Current

Please read ourcontribution guide before taking actions.In any case, please open an issue before opening a pull request to find out whether your intended contribution will actually have a chance to be merged.