Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bhojpur/policy

The Bhojpur Policy is a web-scale backend, enterprise security policy engine applied within Bhojpur.NET Platform ecosystem for distributed application or service delivery.
https://github.com/bhojpur/policy

access-control acl auth authorization permission rbac

Last synced: about 2 months ago
JSON representation

The Bhojpur Policy is a web-scale backend, enterprise security policy engine applied within Bhojpur.NET Platform ecosystem for distributed application or service delivery.

Host: GitHub
URL: https://github.com/bhojpur/policy
Owner: bhojpur
Created: 2022-01-14T05:42:36.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2022-04-30T03:11:34.000Z (over 2 years ago)
Last Synced: 2023-05-19T02:49:59.448Z (over 1 year ago)
Topics: access-control, acl, auth, authorization, permission, rbac
Language: Go
Homepage: https://page.bhojpur-consulting.com/product/policy/
Size: 321 KB
Stars: 1
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Bhojpur Policy - Security Engine

The `Bhojpur Policy` is used as a Policy Engine. It is a powerful and efficient

access control framework. It provides support for enforcing authorization based

on various [access control models](https://en.wikipedia.org/wiki/Computer_security_model).

## Table of contents

- [Supported models](#supported-models)

- [How it works?](#how-it-works)

- [Features](#features)

- [Installation](#installation)

- [Documentation](#documentation)

- [Online editor](#online-editor)

- [Tutorials](#tutorials)

- [Get started](#get-started)

- [Policy management](#policy-management)

- [Policy persistence](#policy-persistence)

- [Policy consistence between multiple nodes](#policy-consistence-between-multiple-nodes)

- [Role manager](#role-manager)

- [Benchmarks](#benchmarks)

- [Examples](#examples)

- [Middlewares](#middlewares)

- [Our adopters](#our-adopters)

## Supported models

1. [**ACL (Access Control List)**](https://en.wikipedia.org/wiki/Access_control_list)

2. **ACL with [superuser](https://en.wikipedia.org/wiki/Superuser)**

3. **ACL without users**: especially useful for systems that don't have authentication

or user log-ins.

3. **ACL without resources**: some scenarios may target for a type of resources instead

of an individual resource by using permissions like ``write-article``, ``read-log``. It

doesn't control the access to a specific article or log.

4. **[RBAC (Role-Based Access Control)](https://en.wikipedia.org/wiki/Role-based_access_control)**

5. **RBAC with resource roles**: both users and resources can have roles (or groups) at the same time.

6. **RBAC with domains/tenants**: users can have different role sets for different domains/tenants.

7. **[ABAC (Attribute-Based Access Control)](https://en.wikipedia.org/wiki/Attribute-Based_Access_Control)**: syntax sugar like ``resource.Owner`` can be used to

get the attribute for a resource.

8. **[RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer)**: supports

paths like ``/res/*``, ``/res/:id`` and HTTP methods like ``GET``, ``POST``, ``PUT``, ``DELETE``.

9. **Deny-override**: both allow and deny authorizations are supported, deny overrides the allow.

10. **Priority**: the policy rules can be prioritized like firewall rules.

## How it works?

In `Bhojpur Policy`, an access control model is abstracted into a CONF file based on the

**PERM metamodel (Policy, Effect, Request, Matchers)**. So switching or upgrading the

authorization mechanism for a project is just as simple as modifying a configuration.

You can customize your own access control model by combining the available models. For

example, you can get RBAC roles and ABAC attributes together inside one model and share

one set of policy rules.

The most basic and simplest model in `Bhojpur Policy` is ACL. ACL's model CONF is:

```ini

# Request definition

[request_definition]

r = sub, obj, act

# Policy definition

[policy_definition]

p = sub, obj, act

# Policy effect

[policy_effect]

e = some(where (p.eft == allow))

# Matchers

[matchers]

m = r.sub == p.sub && r.obj == p.obj && r.act == p.act

```

An example policy for ACL model is like:

```ini

p, alice, data1, read

p, bob, data2, write

```

It means:

- alice can read data1

- bob can write data2

We also support multi-line mode by appending '\\'  in the end:

```ini

# Matchers

[matchers]

m = r.sub == p.sub && r.obj == p.obj \

  && r.act == p.act

```

Further more, if you are using ABAC,  you can try operator `in` like

in `Bhojpur Policy` (jPolicy and Node-Policy are not supported yet):

```ini

# Matchers

[matchers]

m = r.obj == p.obj && r.act == p.act || r.obj in ('data2', 'data3')

```

But you **SHOULD** make sure that the length of the array is **MORE** 

**1**, otherwise there will cause it to panic.

For more operators, you may take a look at [govaluate](https://github.com/Knetic/govaluate)

## Key Features

What `Bhojpur Policy` does:

1. enforce the policy in the classic ``{subject, object, action}`` form or

customized form as you defined, both allow and deny authorizations are supported.

2. handle the storage of the access control model and its policy.

3. manage the role-user mappings and role-role mappings (aka role hierarchy in RBAC).

4. support built-in superuser like ``root`` or ``administrator``. A superuser can 

anything without explict permissions.

5. multiple built-in operators to support the rule matching. For example, ``keyMatch``

can map a resource key ``/foo/bar`` to the pattern ``/foo*``.

What Bhojpur Policy does NOT do:

1. authentication (aka verify ``username`` and ``password`` when a user logs in)

2. manage the list of users or roles. I believe it's more convenient for the project

itself to manage these entities. Users usually have their passwords, and `Bhojpur Policy`

is not designed as a password container. However, `Bhojpur Policy` stores the user-role

mapping for the RBAC scenario.

## Installation

```bash

go get github.com/bhojpur/policy

```

## Documentation

https://docs.bhojpur.net/en/overview

## Online editor

You can also use the online editor (https://bhojpur.net/editor/) to write your

`Bhojpur Policy` model and policy in your web browser. It provides functionality

such as ``syntax highlighting`` and ``code completion``, just like an IDE for 

programming language.

## Tutorials

https://docs.bhojpur.net/en/tutorials

## Get started

1. New a `Bhojpur Policy` enforcer with a model file and a policy file:

    ```go

    e, _ := policy.NewEnforcer("path/to/model.conf", "path/to/policy.csv")

    ```

Note: you can also initialize an enforcer with policy in DB instead of file,

see [Policy-persistence](#policy-persistence) section for details.

2. Add an enforcement hook into your code right before the access happens:

    ```go

    sub := "alice" // the user that wants to access a resource.

    obj := "data1" // the resource that is going to be accessed.

    act := "read" // the operation that the user performs on the resource.

    if res, _ := e.Enforce(sub, obj, act); res {

        // permit alice to read data1

    } else {

        // deny the request, show an error

    }

    ```

3. Besides the static policy file, Bhojpur Policy also provides API for permission

management at run-time. For example, You can get all the roles assigned to a user

as below:

    ```go

    roles, _ := e.GetImplicitRolesForUser(sub)

    ```

See [Policy management APIs](#policy-management) for more usage.

## Policy Management

The Bhojpur Policy provides two sets of APIs to manage permissions:

- [Management API](https://docs.bhojpur.net/en/management-api): the primitive API

that provides full support for `Bhojpur Policy` policy management.

- [RBAC API](https://docs.bhojpur.net/en/rbac-api): a more friendly API for RBAC.

This API is a subset of Management API. The RBAC users could use this API to simplify

the code.

We also provide a [web-based UI](https://docs.bhojpur.net/en/admin-portal) for model

management and policy management:

## Policy persistence

https://docs.bhojpur.net/en/adapters

## Policy consistence between multiple nodes

https://docs.bhojpur.net/en/watchers

## Role Manager

https://docs.bhojpur.net/en/role-managers

## Benchmarks

https://docs.bhojpur.net/en/benchmark

## Examples

Model | Model file | Policy file

----|------|----

ACL | [basic_model.conf](https://github.com/bhojpur/policy/blob/master/examples/basic_model.conf) | [basic_policy.csv](https://github.com/bhojpur/policy/blob/master/examples/basic_policy.csv)

ACL with superuser | [basic_model_with_root.conf](https://github.com/bhojpur/policy/blob/master/examples/basic_with_root_model.conf) | [basic_policy.csv](https://github.com/bhojpur/policy/blob/master/examples/basic_policy.csv)

ACL without users | [basic_model_without_users.conf](https://github.com/bhojpur/policy/blob/master/examples/basic_without_users_model.conf) | [basic_policy_without_users.csv](https://github.com/bhojpur/policy/blob/master/examples/basic_without_users_policy.csv)

ACL without resources | [basic_model_without_resources.conf](https://github.com/bhojpur/policy/blob/master/examples/basic_without_resources_model.conf) | [basic_policy_without_resources.csv](https://github.com/bhojpur/policy/blob/master/examples/basic_without_resources_policy.csv)

RBAC | [rbac_model.conf](https://github.com/bhojpur/policy/blob/master/examples/rbac_model.conf)  | [rbac_policy.csv](https://github.com/bhojpur/policy/blob/master/examples/rbac_policy.csv)

RBAC with resource roles | [rbac_model_with_resource_roles.conf](https://github.com/bhojpur/policy/blob/master/examples/rbac_with_resource_roles_model.conf)  | [rbac_policy_with_resource_roles.csv](https://github.com/bhojpur/policy/blob/master/examples/rbac_with_resource_roles_policy.csv)

RBAC with domains/tenants | [rbac_model_with_domains.conf](https://github.com/bhojpur/policy/blob/master/examples/rbac_with_domains_model.conf)  | [rbac_policy_with_domains.csv](https://github.com/bhojpur/policy/blob/master/examples/rbac_with_domains_policy.csv)

ABAC | [abac_model.conf](https://github.com/bhojpur/policy/blob/master/examples/abac_model.conf)  | N/A

RESTful | [keymatch_model.conf](https://github.com/bhojpur/policy/blob/master/examples/keymatch_model.conf)  | [keymatch_policy.csv](https://github.com/bhojpur/policy/blob/master/examples/keymatch_policy.csv)

Deny-override | [rbac_model_with_deny.conf](https://github.com/bhojpur/policy/blob/master/examples/rbac_with_deny_model.conf)  | [rbac_policy_with_deny.csv](https://github.com/bhojpur/policy/blob/master/examples/rbac_with_deny_policy.csv)

Priority | [priority_model.conf](https://github.com/bhojpur/policy/blob/master/examples/priority_model.conf)  | [priority_policy.csv](https://github.com/bhojpur/policy/blob/master/examples/priority_policy.csv)

## Middlewares

Authz middlewares for web frameworks: https://docs.bhojpur.net/en/middlewares

## How to Contribute

Please read the [contributing guide](CONTRIBUTING.md).

## License

This project is licensed under the [MIT license](LICENSE).