route-auth

#Route Auth

Easy to use route authorization provider for Angular

• Usage
• Interface

Usage

npm install route-auth

Then use browserify or another packaging tool and require( "route-auth" )

When creating your main angular module, include vokal.RouteAuth in the list of included modules, e.g.

angular.module( "myApp", [ "vokal.RouteAuth" ] );

Add a resolve to a route like so:

$routeProvider.when( "/edit-account", {
  templateUrl: partialPath( "edit-account.html" ),
  resolve: {
    auth: [ "RouteAuth", function ( RouteAuth )
	{
 	  return RouteAuth.auth( [ "user" ] );
	} ]
  }
} );

The array of strings passed to RouteAuth.auth are the permissions that are allowable for the route

Somewhere else in your code, such as after authentication, you need to tell RouteAuth what roles the current user has, if any. This looks like RouteAuth.storeRoles( [ "role1", "role2", "etc" ] ). By default roles are stored with local storage. To clear the store call RouteAuth.storeRoles( [] ).

Security: Because roles are stored in plain text in local or session storage where they can be directly edited, this route authorization does not replace in any way authorization on the server side.

Interface

The following methods can be called on the RouteAuth service once injected into your Angular code.

• loadRoles()
• storeRoles( newRoles )
• addRole( newRole )
• hasRoles( checkRoles )
• hasNoRoles()
• auth( allowedRoles, options )
• swapStorage( newMedium )

Methods

loadRoles()

Load the user's roles from localStorage, or set them as an empty list if there are no roles in localStorage.

---

storeRoles( newRoles )

Overwrite the user's current roles with newRoles

Arguments

1. newRoles | Array | the new user roles to be set

Example

RouteAuth.storeRoles( [ 'user', 'premiumUser', 'purpleDiamondUltraEliteClass' ] );

---

addRole( newRole )

Add newRole to the existing set of roles

Arguments

1. newRole | String | the new user role to add

Example

RouteAuth.addRole( 'admin' );

---

hasRoles( checkRoles )

Check to see if the user has any of the roles in checkRoles

Arguments

1. checkRoles | Array | the list of roles to check for

Returns

Bool | true if the user has any of the roles in checkRoles, otherwise false

Example

function showSettingsDialog()
{
	if( RouteAuth.hasRoles( [ "admin", "superuser" ] ) )
	{
		showAdminSettings();
	}
	else
	{
		showNormalSettings();
	}
}

---

hasNoRoles()

Check to see if the user has no roles.

Returns

Bool | true if user has no set roles, otherwise false

Example

function adjustAdLevel()
{
	if( RouteAuth.hasNoRoles() )
	{
		showAllTheAds();
	}
	else
	{
		justSomeAds();
	}
}

---

auth( allowedRoles, options )

Returns a promise, which is resolved if the user has one of the allowedRoles. Otherwise, the promise is rejected.

Arguments

1. allowedRoles | Array | list of acceptable roles
2. options | Object | optional parameters for this function

• redirectPath | String | path to redirect to should the user not have one of the allowed roles

Returns

Angular Promise | will resolve if user has one of the roles in allowedRoles. Otherwise, will be rejected.

Example

$routeProvider.when( "/edit-account", { templateUrl: partialPath( "edit-account.html" ),
	resolve: {
		auth: [ "RouteAuth", function ( RouteAuth )
		{
			return RouteAuth.auth( [ "user" ], { "redirectPath": "/login" } );
		} ]
	}
} );

---

swapStorage( newMedium )

Migrate roles to a new storage medium. For example, if a user chooses not to have their session persisted after login you might use swapStorage( window.sessionStorage ) before or even after the login completes. To use a custom storage location such as cookies, the interface of newMedium should expose setItem(), getItem(), and removeItem() methods that work the same was as in the Web Storage API.

---

Compatability: IE9+

License: MIT