Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pedroetb/node-oauth2-server-mongo-example

Working oauth2 server with mongodb storage and minimal configuration
https://github.com/pedroetb/node-oauth2-server-mongo-example

mongodb mongodb-storage nodejs oauth oauth2 oauth2-server

Last synced: 8 days ago
JSON representation

Working oauth2 server with mongodb storage and minimal configuration

Host: GitHub
URL: https://github.com/pedroetb/node-oauth2-server-mongo-example
Owner: pedroetb
License: mit
Created: 2016-12-09T00:46:09.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2022-12-10T16:34:38.000Z (about 2 years ago)
Last Synced: 2024-11-19T22:13:23.660Z (about 1 month ago)
Topics: mongodb, mongodb-storage, nodejs, oauth, oauth2, oauth2-server
Language: JavaScript
Size: 74.2 KB
Stars: 103
Watchers: 6
Forks: 53
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# node-oauth2-server with MongoDB example

This is a basic example of a OAuth2 server, using [node-oauth2-server](https://github.com/oauthjs/node-oauth2-server) (version 3.0.1) with MongoDB storage and the minimum (only the required to work) model configuration.

If you want a simpler example without MongoDB storage, you should go to [node-oauth2-server-example](https://github.com/pedroetb/node-oauth2-server-example) instead.

## Setup

First, you should have [MongoDB](https://www.mongodb.com/) installed and running on your machine.

You also need to install **nodejs** and **npm** and then, simply run `npm install` and `npm start`. The server should now be running at `http://localhost:3000`.

## Usage

You can use different grant types to get an access token. By now, `password`, `client_credentials` and `refresh_token` are available.

### Checking example data

Firstly, you should create some entries in your **MongoDB** database.

> You can call the `loadExampleData` function at `model.js` in order to create these entries automatically, and `dump` function to inspect the database content.

#### With *password* grant

You need to add a client. For example:

* **clientId**: `application`
* **clientSecret**: `secret`

And you have to add a user too. For example:

* **username**: `pedroetb`
* **password**: `password`

#### With *client_credentials* grant

You need to add a confidential client. For example:

* **clientId**: `confidentialApplication`
* **clientSecret**: `topSecret`

You don't need any user to use this grant type, but for security is only available to confidential clients.

#### With *refresh_token* grant

There is one client added to server and ready to work:

* **clientId**: `application`
* **clientSecret**: `secret`

You don't need any user to use this grant type, it was already provided when original token was obtained (by *password* grant type, for example).

### Obtaining a token

To obtain a token you should POST to `http://localhost:3000/oauth/token`.

#### With *password* grant

You need to include the client credentials in request headers and the user credentials and grant type in request body:

* **Headers**
* **Authorization**: `"Basic " + clientId:clientSecret base64'd`
* (for example, to use `application:secret`, you should send `Basic YXBwbGljYXRpb246c2VjcmV0`)

* **Content-Type**: `application/x-www-form-urlencoded`
* **Body**
* `grant_type=password&username=pedroetb&password=password`
* (contains 3 parameters: `grant_type`, `username` and `password`)

For example, using `curl`:
```
curl http://localhost:3000/oauth/token \
-d "grant_type=password" \
-d "username=pedroetb" \
-d "password=password" \
-H "Authorization: Basic YXBwbGljYXRpb246c2VjcmV0" \
-H "Content-Type: application/x-www-form-urlencoded"
```

If all goes as planned, you should receive a response like this:

```
{
"accessToken": "951d6f603c2ce322c5def00ce58952ed2d096a72",
"accessTokenExpiresAt": "2018-11-18T16:18:25.852Z",
"refreshToken": "67c8300ad53efa493c2278acf12d92bdb71832f9",
"refreshTokenExpiresAt": "2018-12-02T15:18:25.852Z",
"client": {
"id": "application"
},
"user": {
"id": "pedroetb"
}
}
```

#### With *client_credentials* grant

You need to include the client credentials in request headers and the grant type in request body:

* **Headers**
* **Authorization**: `"Basic " + clientId:clientSecret base64'd`
* (for example, to use `confidentialApplication:topSecret`, you should send `Basic Y29uZmlkZW50aWFsQXBwbGljYXRpb246dG9wU2VjcmV0`)

* **Content-Type**: `application/x-www-form-urlencoded`
* **Body**
* `grant_type=client_credentials`

For example, using `curl`:
```
curl http://localhost:3000/oauth/token \
-d "grant_type=client_credentials" \
-H "Authorization: Basic Y29uZmlkZW50aWFsQXBwbGljYXRpb246dG9wU2VjcmV0" \
-H "Content-Type: application/x-www-form-urlencoded"
```

If all goes as planned, you should receive a response like this:

```
{
"accessToken": "951d6f603c2ce322c5def00ce58952ed2d096a72",
"accessTokenExpiresAt": "2018-11-18T16:18:25.852Z",
"client": {
"id": "confidentialApplication"
},
"user": {
"id": "confidentialApplication"
}
}
```

#### With *refresh_token* grant

When obtaining an access token using *password* grant, you get also a refresh token.
With this token you can get a new access token, using only that value (username and password are not needed), while it has not been expired.

> Remember that, if you refresh a token while it was still valid, the old access and refresh tokens get revoked, and only the new access and refresh tokens are valid to be used.
You need to include the client credentials in request headers and the refresh token and grant type in request body:

* **Headers**
* **Authorization**: `"Basic " + clientId:clientSecret base64'd`
* (for example, to use `application:secret`, you should send `Basic YXBwbGljYXRpb246c2VjcmV0`)

* **Content-Type**: `application/x-www-form-urlencoded`
* **Body**
* `grant_type=refresh_token&refresh_token=67c8300ad53efa493c2278acf12d92bdb71832f9`
* (contains 2 parameters: `grant_type` and `refresh_token`)

For example, using `curl`:
```
curl http://localhost:3000/oauth/token \
-d "grant_type=refresh_token" \
-d "refresh_token=67c8300ad53efa493c2278acf12d92bdb71832f9" \
-H "Authorization: Basic YXBwbGljYXRpb246c2VjcmV0" \
-H "Content-Type: application/x-www-form-urlencoded"
```

If all goes as planned, you should receive a response like this:

```
{
"accessToken": "17be4ee45b177651db3fd9d286042de75d48eb3b",
"accessTokenExpiresAt": "2018-11-18T16:18:35.248Z",
"refreshToken": "37eaff895c8fc9fc839c0098cf3fb01858097908",
"refreshTokenExpiresAt": "2018-12-02T15:18:35.248Z",
"client": {
"id": "application"
},
"user": {
"id": "pedroetb"
}
}
```

### Using the token

Now, you can use your brand-new token to access restricted areas. For example, you can GET to `http://localhost:3000/` including your token at headers:

* **Headers**
* **Authorization**: `"Bearer " + accessToken`
* (for example, `Bearer 951d6f603c2ce322c5def00ce58952ed2d096a72`)

For example, using `curl`:
```
curl http://localhost:3000 \
-H "Authorization: Bearer 951d6f603c2ce322c5def00ce58952ed2d096a72"
```