https://github.com/oauthjs/express-oauth-server

Complete, compliant and well tested module for implementing an OAuth2 Server/Provider with express in node.js
https://github.com/oauthjs/express-oauth-server

Last synced: 5 days ago
JSON representation

Complete, compliant and well tested module for implementing an OAuth2 Server/Provider with express in node.js

• Host: GitHub
• URL: https://github.com/oauthjs/express-oauth-server
• Owner: oauthjs
• License: mit
• Created: 2015-11-17T00:31:37.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-01-03T22:52:35.000Z (12 months ago)
• Last Synced: 2024-05-18T15:52:24.488Z (7 months ago)
• Language: JavaScript
• Size: 54.7 KB
• Stars: 475
• Watchers: 11
• Forks: 383
• Open Issues: 55
• Metadata Files:
  • Readme: Readme.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Express OAuth Server [![Build Status](https://travis-ci.org/oauthjs/express-oauth-server.png?branch=master)](https://travis-ci.org/oauthjs/express-oauth-server)

Complete, compliant and well tested module for implementing an OAuth2 Server/Provider with [express](https://github.com/expressjs/express) in [node.js](http://nodejs.org/).

This is the express wrapper for [oauth2-server](https://github.com/oauthjs/node-oauth2-server).

## Installation

    $ npm install express-oauth-server

## Quick Start

The module provides two middlewares - one for granting tokens and another to authorize them. `express-oauth-server` and, consequently `oauth2-server`, expect the request body to be parsed already.

The following example uses `body-parser` but you may opt for an alternative library.

```js

var bodyParser = require('body-parser');

var express = require('express');

var OAuthServer = require('express-oauth-server');

var app = express();

app.oauth = new OAuthServer({

  model: {}, // See https://github.com/oauthjs/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);

```

## Options

```

var 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_)

  The `authorize()` and `token()` middlewares will both render their 

  result 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()