noauthjs

v0.2.2

Published

3 years ago

Simple NodeJS oAuth library

Downloads

0High
0Medium
0Low

stevik

nodejs oauth oauth2 authentication login accounts promise

noauthjs

Simple NodeJS oAuth library

Features

Client credentials authentication
User credentials authentication
Scope based authentiaction

Requirements

Express (npm version (npm version 4.14.0+)
body-parser (npm version 1.15.2+)

Instalation

Install using npm npm install noauthjs --save

Usage

Create a config file

See the example config file

In app usage

See the example application file

const authServer = require('noauthjs');

authServer is a singleton so don't try to create a new instance of it.
If you need to require it in multiple files, just do so. Since it is a singleton you will always get the same object (instance).

####Example

const authServer = require('noauthjs');
const serverConfig = require('./auth.config');

authServer.initServer(serverConfig).then((result)=>{
    let project = authServer.getProject('someProject'); // project_id

    app.all('/access-token', authServer.accessTokenHandler);
    app.get('/token-info', authServer.tokenInfo);

    app.get('/protected-resource', authServer.authenticateScopes('loggedin'), (req, res)=>{
        res.json({protected: 'resource'});
    });

    app.listen(3000, function () {
        console.log('Example app listening on port 3000!');
    });

}).catch((error)=>{
    // handle authServer init error
});

Public methods and variables

authServer methods and variables

m initServer(config)

Initilizes the oauth server.
Creates or updates (if already exists in mongodb) projects, clients, scopes definded in config file.
Creates a connection to mongodb using mongoose.
Returns a promise (bluebird)

m getProject(project_id)

Creates an instance of AuthProject class, which provides methods and variables described below. The object is filled with data from database, which is an asynchronous process. To be sure the object has accurate data and is ready to use, use the ready() function which is described below in project methods.
Returns an object (instace of AuthProject)

v accessTokenHandler

accessTokenHandler is a getter which returns a callback function for express router, which takes req, res as parameters.

e.g. `app.all('/access-token', authServer.accessTokenHandler);`

Request

{
	url: "http://your.domain/access-token" // or any other address you specify in the router
	method: "POST", // DELETE to revoke a token
	headers: {
    "Content-Type": "application/json"
		"Authorization": "Basic btoa('client_id:client_secret')" // btoa is javascript function encodes a string to base64, btoa is just an example, use wahatever you want, just provide valid base64
	},
	body: {
		"grant_type": "client_credentials", // client_credentials | user_credentials | facebook_token | google_token | refresh_token
		"login": "someLogin", // only if grant_type == user_credentials
		"password": "somePassword", // only if grant_type == user_credentials
		"refresh_token": "someRefreshToken", // only if grant_type == refresh_token
		"access_token": "someFacebookAccessToken", // only if grant_type == facebook_token 
		"id_token": "someGoogleIdToken", // only if grant_type == google_token 
	}

}

Success response

{
  "access_token": "5d7112256d68ddbbaa9a11f57bf2a6c229ba3d838b5e210a4448f2cbbe7df756",
  "refresh_token": "bba9271f7977f8a99e3f4ee4ea215388e7a792289fc96d5e80c6c717b24045ed",
  "expires_in": 3599,
  "token_type": "bearer"
}

Error response

If a client provides wrong client_id or cleint_secret error response is generated as shown below, with statuc code 401

{
  "message": "Unauhtorized",
  "description": "Invalid client credentials"
}

If you get any other error one of us messed something up

Request for revoking/deleting access token (log out)

{
	url: "http://your.domain/access-token" // or any other address you specify in the router
	method: "DELETE",
	headers: {
    "Content-Type": "application/json"
		"Authorization": "Bearer someAccessTokenYouWantToRevoke"
	}
}

v tokenInfo

tokenInfo is a getter which returns a callback function for express router, which takes req, res as parameters.

e.g. `app.get('/token-info', authServer.tokenInfo);`

Request

{
	url: "http://your.domain/token-info" // or any other address you specify in the router
	method: "GET",
	headers: {
    "Content-Type": "application/json"
		"Authorization": "Bearer someAccessToken"
	}
}

Success response

{
  "uuid": null,
  "access_token": "11bbe68648de8598a3b00e9ee709458fe0919e176609ea813b5e0c4a1837e87d",
  "refresh_token": "e9db3cbe000630c04c9cbbbfcca8a44399ccbc6e0c7d8a671d5a325930bc06bf",
  "expires_in": 3575,
  "token_type": "bearer",
  "scopes": [
    "public"
  ],
  "grant": "client_credentials"
}

"uuid": null, // null if access is granted by client_credentials, Number if access granted by user_credentials

Error response

If a client provides wrong client_id or cleint_secret error response is generated as shown below, with statuc code 401

{
  "message": "Unauhtorized",
  "description": "Invalid access_token"
}

If you get any other error one of us messed something up

m authenticateScopes(scopes)

is a function which takes array of project_id as paramerer and returns a callback function for middleware of express router, which takes req, res, next as parameters.

e.g.

app.get('/protected-resource', authServer.authenticateScopes('loggedin'), (req, res)=>{
    res.json({protected: 'resource'});
});

When a resource which is protected with authenticateScopes(scopes) middleware is requested, bearer access token is checked from request headers.

Request

{
	url: "http://your.domain/protected-resource" // or any other address you specify in the router
	method: "GET", // or any other method
	headers: {
		"Authorization": "Authorization accessToken"
	}
}

Success response

{
  "protected": "resource"
}

Error response

If access token provided is invalid (wrong token, expired token, ...) or user doesn't have required scopes for a resource response with status code 401 is returned

example of error response

{
  "message": "Forbidden",
  "description": "Required scope missing"
}

Project methods

m createUser(userConfig)

Creates (registers) a user with login information and scopes provided in userConfig

userConfig example

{
  login: 'stevik', 
  password: 'heslo',
  scopes: ['loggedin', 'anotherScope'] // provide scopes only if you want to override project's default_registration_scopes
}

Returns a promise which resolves with an instance of AuthUser class or gets rejected with an AuthError
If user already exists error has statusCode 409

m getUserByAccessToken(accessToken)

Parameter accessToken => String => 'Bearer some_access_token' || 'some_access_token' Returns a promise which resolves with an instance of AuthUser class or null if there is no such user