Repository files navigation

Complete, compliant and well tested module for implementing an OAuth2 Server/Provider withexpress inNode.js.

This package wraps the@node-oauth/oauth2-server into anexpress compatible middleware.It's a maintained and up-to-date fork from the formeroauthjs/express-oauth-server.

$ npm install @node-oauth/express-oauth-server

The module provides two middlewares - one for granting tokens and another to authorize them.@node-oauth/express-oauth-server and, consequently@node-oauth/oauth2-server,expect the request body to be parsed already.The following example usesbody-parser but you may opt for an alternative library.

constbodyParser=require('body-parser');constexpress=require('express');constOAuthServer=require('@node-oauth/express-oauth-server');constapp=express();app.oauth=newOAuthServer({model:{},// See https://github.com/node-oauth/node-oauth2-server for specification});app.use(bodyParser.json());app.use(bodyParser.urlencoded({extended:false}));app.use(app.oauth.authorize());app.use(function(req,res){res.send('Secret area');});app.listen(3000);

Note: The following optionsextend the default options from@node-oauth/oauth2-server!You can read more about all possible options in the@node-oauth/oauth2-server documentation

const options = {   useErrorHandler: false,   continueMiddleware: false,}

• useErrorHandler(type: boolean default: false)

  If false, an error response will be rendered by this component.Set this value to true to allow your own express error handler to handle the error.

• continueMiddleware(type: boolean default: false)

  Theauthorize() andtoken() middlewares will both render theirresult to the response and end the pipeline.next() will only be called if this is set to true.

  Note: You cannot modify the response since the headers have already been sent.

  authenticate() does not modify the response and will always call next()

Beginning withversion 4.0 this package brings some potentially breaking changes:

• dropped old es5 code; moved to native async/await
• requires node >= 16
• ships with@node-oauth/oauth2-server 5.x
• no express version pinned but declared as'*' peer dependency, so it should not cause conflicts with your express version

For more examples, please visitour dedicated "examples" repo, which also contains express examples.

MIT, seelicense file.