This is a basic example of a OAuth2 server, using 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 instead.
First, you should have MongoDB 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
.
You can use different grant types to get an access token. By now, password
, client_credentials
and refresh_token
are available.
Firstly, you should create some entries in your MongoDB database.
You can call the
loadExampleData
function atmodel.js
in order to create these entries automatically, anddump
function to inspect the database content.
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
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.
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).
To obtain a token you should POST to http://localhost:3000/oauth/token
.
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 sendBasic YXBwbGljYXRpb246c2VjcmV0
)
- (for example, to use
-
Content-Type:
application/x-www-form-urlencoded
-
- Body
grant_type=password&username=pedroetb&password=password
- (contains 3 parameters:
grant_type
,username
andpassword
)
- (contains 3 parameters:
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"
}
}
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 sendBasic Y29uZmlkZW50aWFsQXBwbGljYXRpb246dG9wU2VjcmV0
)
- (for example, to use
-
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"
}
}
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 sendBasic YXBwbGljYXRpb246c2VjcmV0
)
- (for example, to use
-
Content-Type:
application/x-www-form-urlencoded
-
- Body
grant_type=refresh_token&refresh_token=67c8300ad53efa493c2278acf12d92bdb71832f9
- (contains 2 parameters:
grant_type
andrefresh_token
)
- (contains 2 parameters:
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"
}
}
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,
- Authorization:
For example, using curl
:
curl http://localhost:3000 \
-H "Authorization: Bearer 951d6f603c2ce322c5def00ce58952ed2d096a72"