\nComplete, compliant and well tested module for implementing an OAuth2 Server/Provider with express in Node.js.\n
\n\n
\n\n[](https://github.com/node-oauth/express-oauth-server/actions/workflows/tests.yml)\n[](https://github.com/node-oauth/express-oauth-server/actions/workflows/github-code-scanning/codeql)\n[](https://www.repostatus.org/#active)\n[](https://www.npmjs.com/package/@node-oauth/oauth2-server)\n[](https://www.npmjs.com/package/@node-oauth/oauth2-server)\n\n\n
\n\n## About\n\nThis package wraps the [@node-oauth/oauth2-server](https://github.com/node-oauth/node-oauth2-server) into an\nexpress compatible middleware.\nIt's a maintained and up-to-date fork from the former\n[oauthjs/express-oauth-server](https://github.com/oauthjs/express-oauth-server).\n\n\n## Installation\n\n```shell\n$ npm install @node-oauth/express-oauth-server\n```\n\n## Quick Start\n\nThe module provides two middlewares - one for granting tokens and another to authorize them. \n`@node-oauth/express-oauth-server` and, consequently `@node-oauth/oauth2-server`,\nexpect the request body to be parsed already.\nThe following example uses `body-parser` but you may opt for an alternative library.\n\n```js\nconst bodyParser = require('body-parser');\nconst express = require('express');\nconst OAuthServer = require('@node-oauth/express-oauth-server');\n\nconst app = express();\n\napp.oauth = new OAuthServer({\n model: {}, // See https://github.com/node-oauth/node-oauth2-server for specification\n});\n\napp.use(bodyParser.json());\napp.use(bodyParser.urlencoded({ extended: false }));\napp.use(app.oauth.authorize());\n\napp.use(function(req, res) {\n res.send('Secret area');\n});\n\napp.listen(3000);\n```\n\n## Options\n\n> Note: The following options **extend** the default options from `@node-oauth/oauth2-server`!\n> You can read more about all possible options in the\n> [@node-oauth/oauth2-server documentation](https://node-oauthoauth2-server.readthedocs.io/en/master/api/oauth2-server.html)\n \n```\nconst options = { \n useErrorHandler: false, \n continueMiddleware: false,\n}\n```\n\n- `useErrorHandler`\n(_type: boolean_ default: false)\n\n If false, an error response will be rendered by this component.\n Set this value to true to allow your own express error handler to handle the error.\n\n- `continueMiddleware`\n(_type: boolean default: false_)\n\n The `authorize()` and `token()` middlewares will both render their \n result to the response and end the pipeline.\n next() will only be called if this is set to true.\n\n **Note:** You cannot modify the response since the headers have already been sent.\n\n `authenticate()` does not modify the response and will always call next()\n\n## Migration notes\n\nBeginning with **version 4.0** this package brings some potentially breaking changes:\n\n- dropped old es5 code; moved to native async/await\n- requires node >= 16\n- ships with [@node-oauth/oauth2-server](https://github.com/node-oauth/node-oauth2-server) 5.x\n- no express version pinned but declared as `'*'` peer dependency, so it should not cause conflicts with your express version\n\n## More Examples\n\nFor more examples, please visit [our dedicated \"examples\" repo](https://github.com/node-oauth/node-oauth2-server-examples)\n, which also contains express examples.\n\n## License\n\nMIT, see [license file](./LICENSE).\n","readmeFilename":"README.md"}