veritone-functional-permissions

veritone-functional-permissions

Table of Contents

• Summary
• Getting Started
  • Depedencies
• Usage
  • Has Permision
  • Has Any Permission
  • Has All Permissions
  • Get Mask From Permissions
  • Get Permissions From Mask
  • Combine Permissions
• Go package

Summary

Functional permissions library to perform permission checking. Permissions are checked against the user permissions (an array of integers), that can be retrieved from core-admin-server. This library may be used on either servers or in the browser, anywhere where it can be require()ed.

Getting Started

Depedencies

• Something that can require() (e.g. Node 6, RequireJS, webpack)

Usage

Has Permission

This checks if the user's permissions satisfies the the requested permission check.

const perm = require('functional-permissions-lib');
const adminPerms = perm.permissions.admin;
const userInfo = {
  permissions: [-8125, 31]
};

if (perm.util.hasAccessTo(adminPerms.org.create, userInfo.permissions)) {
  //allow user to perform action
} else {
  //deny the user
}

Has Any Permission

This checks if the user's permissions satisfies any of the requested permission checks.

const perm = require('functional-permissions-lib');
const adminPerms = perm.permissions.admin;
const userInfo = {
  permissions: [-8125, 31]
};

if (
  perm.util.hasAccessToAny(
    [adminPerms.org.create, adminPerms.group.create, adminPerms.role.create],
    userInfo.permissions
  )
) {
  //allow user to perform action
} else {
  //deny the user
}

Has All Permissions

This checks if the user's permissions satisfies all of the requested permission checks.

const perm = require('functional-permissions-lib');
const adminPerms = perm.permissions.admin;
const userInfo = {
  permissions: [-8125, 31]
};

if (
  perm.util.hasAccessToAll(
    [adminPerms.org.create, adminPerms.group.create, adminPerms.role.create],
    userInfo.permissions
  )
) {
  //allow user to perform action
} else {
  //deny the user
}

Get Mask From Permissions

This converts permission ids to a mask. Optionally, the caller can pass in a mask that will be used to add the permissions to.

const mask = getMaskFromPermissionIds([perm.permissions.admin]);

// OR;

const mask = getMaskFromPermissionIds([perm.permissions.admin], [-1526]);

Get Permissions From Mask

This converts a mask to permissions IDs.

const permissionIds = getPermissionIdsFromMask([-1526]);

Combine Permissions

This combines permissions.

const perm = require('functional-permissions-lib');
const adminPerms = perm.permissions.admin;
const cmsPerms = perm.permissions.csm;

const permissions = coombinePermissions(
  [adminPerms.org.create, adminPerms.group.create, adminPerms.role.create],
  [cmsPerms.media.create, cmsPerms.wrklows.create]
);

Go package

This repo an also be imported as a go package to help resolve user permissions in go projects.

import (
	permissions "github.com/veritone/functional-permissions-lib"
)

// sample usage
func SomethingUseful(...) {
	...
	masks := []int{2147483648, 2}

	// getting permission IDs from masks
	perms := GetPermissionIDsFromMasks(masks)
	...


	perms2 := []int{1, 13, 26, 62}

	// getting permission masks from IDs
	masks2 := GetMasksFromPermissionIDs(perms2)

	...

	// getting permission ID for a permission path
	permID, err := GetPermissionID("cms.media.read")
	defer permission.Free()
	...

}

License

Copyright 2019, Veritone Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.