1. module hapi-authorization
   1. function hapi-authorization.register (server, options, next)
   2. object hapi-authorization.acl
   3. object hapi-authorization.schema
2. module hapi-authorization.acl
   1. function hapi-authorization.acl.checkRoles (user, role, hierarchy)
   2. function hapi-authorization.acl.fetchEntity (query, param, request, cb)
   3. function hapi-authorization.acl.validateEntityAcl (user, role, entity, validator, options)
3. module hapi-authorization.schema
   1. function hapi-authorization.schema.assert (type, options, message)

module hapi-authorization

function hapi-authorization.register (server, options, next)

• description and source-code

  register = function (server, options, next) {
  
  	try {
  		// Validate the options passed into the plugin
  		Schema.assert('plugin', options, 'Invalid settings');
  
  		var settings = Hoek.applyToDefaults(internals.defaults, options || {});
  
  		server.bind({
  			config: settings
  		});
  
  		// Validate the server options on the routes
  		if (server.after) { // Support for hapi < 11
  			server.after(internals.validateRoutes);
  		} else {
  			server.ext('onPreStart', internals.validateRoutes);
  		}
  		server.ext('onPreHandler', internals.onPreHandler);
  
  		next();
  	} catch (e) {
  
  		next(e);
  	}
  }

• example usage

  ...
  		register: require('hapi-authorization')
  		options: {
  		  roles: false	// By setting to false, you are not using an authorization hierarchy and you do not need to specify all the potential
   roles here
  		}
  	}
  ];
  
  server.register(plugins, function(err) {
  ...
  ```
  
  ## Using hapi-authorization with custom roles
  1. Include the plugin in your hapijs app.
  Example:
  ```js
  ...

module hapi-authorization.acl

function hapi-authorization.acl.checkRoles (user, role, hierarchy)

• description and source-code

  checkRoles = function (user, role, hierarchy) {
  
  	if ((!user) || (!internals.isGranted(user.role, role, hierarchy))) {
  		return Boom.forbidden('Unauthorized');
  	}
  
  	return null;
  }

• example usage

  n/a

function hapi-authorization.acl.fetchEntity (query, param, request, cb)

• description and source-code

  fetchEntity = function (query, param, request, cb) {
  
  	var def = Q.defer();
  	query(param, request, function(err, entity) {
  
  		if (err && err.isBoom) {
  			return def.reject(err);
  		} else if (err) {
  			return def.reject(Boom.badRequest('Bad Request', err));
  		}
  		else if (!entity) {
  			return def.reject(Boom.notFound());
  		}
  		else {
  			def.resolve(entity);
  		}
  	});
  
  	return def.promise;
  }

• example usage

  n/a

function hapi-authorization.acl.validateEntityAcl (user, role, entity, validator, options)

• description and source-code

  validateEntityAcl = function (user, role, entity, validator, options) {
  
  	var def = Q.defer();
  
  	if (!entity) {
  		def.reject(new Error('validateUserACL must run after fetchACLEntity'));
  	} else if (!user) {
  		def.reject(new Error('User is required, please make sure this method requires authentication'));
  	} else {
  
  		if (validator) {
  
  			entity[validator](user, role, function(err, isValid) {
  
  				if (err) {
  					def.reject(new Error(err));
  				} else if (!isValid) {	// Not granted
  					def.reject(Boom.forbidden('Unauthorized'));
  				} else {	// Valid
  					def.resolve(isValid);
  				}
  			});
  		} else {
  			// Use the default validator
  			var isValid = internals.defaultEntityAclValidator(user, role, entity, options);
  
  			if (isValid) {
  				def.resolve(isValid);
  			} else {
  				def.reject(Boom.forbidden('Unauthorized'));
  			}
  		}
  	}
  
  	return def.promise;
  }

• example usage

  n/a

module hapi-authorization.schema

function hapi-authorization.schema.assert (type, options, message)

• description and source-code

  assert = function (type, options, message) {
  
  	var validationObj = Joi.validate(options, internals[type]);
  	var error = validationObj.error;
  	var errorMessage = null;
  
  	// If there is an error, build a nice error message
  	if(error) {
  		errorMessage = error.name + ':';
  		error.details.forEach(function(err) {
  			errorMessage += ' ' + err.message;
  		});
  	}
  
  	// If there is an error build the error message
  	Hoek.assert(!error, 'Invalid', type, 'options', message ? '(' + message + ')' : '', errorMessage);
  
  	return validationObj.value;
  }

• example usage

  ...
  		errorMessage = error.name + ':';
  		error.details.forEach(function(err) {
  			errorMessage += ' ' + err.message;
  		});
  	}
  
  	// If there is an error build the error message
  	Hoek.assert(!error, 'Invalid', type, 'options', message ? '(&#
  x27; + message + ')' : '', errorMessage);
  
  	return validationObj.value;
  };
  
  
  /**
  * Validation rules for a route's params
  ...