Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/CasbinRuby/casbin-ruby

An authorization library that supports access control models like ACL, RBAC, ABAC in Ruby
https://github.com/CasbinRuby/casbin-ruby
Last synced: 27 days ago
JSON representation
An authorization library that supports access control models like ACL, RBAC, ABAC in Ruby
Host: GitHub
URL: https://github.com/CasbinRuby/casbin-ruby
Owner: CasbinRuby
License: apache-2.0
Created: 2021-05-15T04:35:35.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-05-18T06:22:56.000Z (7 months ago)
Last Synced: 2024-08-04T04:07:01.040Z (4 months ago)
Language: Ruby
Size: 198 KB
Stars: 56
Watchers: 1
Forks: 4
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

awesome-auth - Casbin - Authorization library that supports access control models like ACL, RBAC, ABAC in Ruby. (Authorization / <a name="authZ-ruby"></a>Ruby)
README

        Casbin for Ruby

====

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/casbin/lobby)

**News**: still worry about how to write the correct Casbin policy? ``Casbin online editor`` is coming to help! Try it

at: http://casbin.org/editor/

Casbin is a powerful and efficient open-source access control library for Ruby projects. It provides support for

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

Ruby version is ported & [supported by Evrone](https://evrone.com/?utm_campaign=casbinruby). More information you can find in articles [in English](https://evrone.com/casbin-ruby?utm_campaign=casbinruby).

## All the languages supported by Casbin:

[![golang](https://casbin.org/img/langs/golang.png)](https://github.com/casbin/casbin) | [![java](https://casbin.org/img/langs/java.png)](https://github.com/casbin/jcasbin) | [![nodejs](https://casbin.org/img/langs/nodejs.png)](https://github.com/casbin/node-casbin)

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

[Casbin](https://github.com/casbin/casbin) | [jCasbin](https://github.com/casbin/jcasbin) | [node-Casbin](https://github.com/casbin/node-casbin)

production-ready | production-ready | production-ready

[![php](https://casbin.org/img/langs/php.png)](https://github.com/php-casbin/php-casbin) | [![python](https://casbin.org/img/langs/python.png)](https://github.com/casbin/pycasbin) | [![dotnet](https://casbin.org/img/langs/dotnet.png)](https://github.com/casbin-net/Casbin.NET)

[PHP-Casbin](https://github.com/php-casbin/php-casbin)|[PyCasbin](https://github.com/casbin/pycasbin) | [Casbin.NET](https://github.com/casbin-net/Casbin.NET)

production-ready | production-ready | production-ready

| [![c++](https://casbin.org/img/langs/cpp.png)](https://github.com/casbin/casbin-cpp) | [![rust](https://casbin.org/img/langs/rust.png)](https://github.com/casbin/casbin-rs) | [![Ruby](ruby.jpg)](https://github.com/evrone/casbin-ruby)|

[Casbin-CPP](https://github.com/casbin/casbin-cpp) | [Casbin-RS](https://github.com/casbin/casbin-rs) | [Ruby Casbin](https://github.com/evrone/casbin-ruby)

beta-test | production-ready | development

## 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)

- [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 Casbin, 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 Casbin 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:

```

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 following in Casbin **golang** edition (jCasbin and Node-Casbin 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** than **1**, otherwise there will cause it to panic.

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

## Features

What Casbin does:

1. enforce the policy in the classic ``{subject, object, action}`` form or a 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 do 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 Casbin 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 Casbin is not designed as a password container. However, Casbin stores the user-role mapping for the RBAC scenario.

## Installation

```

gem 'casbin-ruby'

```

## Documentation

https://casbin.org/docs/en/overview

## Online editor

You can also use the online editor (http://casbin.org/editor/) to write your Casbin model and policy in your web browser. It provides functionality such as ``syntax highlighting`` and ``code completion``, just like an IDE for a programming language.

## Tutorials

https://casbin.org/docs/en/tutorials

## Get started

1. New a Casbin enforcer with a model file and a policy file:

```ruby

require 'casbin-ruby'

Casbin::Config.setup do |config|

  config.model = "path/to/model.conf" # default: nil

  config.adapter = "path/to/policy.csv" # default: nil

  config.watcher = Casbin::SomeWatcher # default: nil

  config.logger = Logger.new($stdout) # default: Logger.new($stdout, level: :error)

end

enforcer = Casbin::Enforcer.new

```

OR

```ruby

require 'casbin-ruby'

enforcer = Casbin::Enforcer.new("path/to/model.conf", "path/to/policy.csv")

```

Note: you can also initialize an enforcer with policy in DB instead of file, see [Persistence](#persistence) section for details.

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

```ruby

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 enforcer.enforce(sub, obj, act)

  # permit alice to read data1

  # do something

else

  # deny the request, show an error

end

```

3. Besides the static policy file, Casbin also provides API for permission management at run-time. For example, You can get all the roles assigned to a user as below:

```ruby

roles = enforcer.get_roles_for_user('alice')

```

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

4. Please refer to the ``spec/support/files/examples`` files for more usage.

## Policy management

Casbin provides two sets of APIs to manage permissions:

- [Management API](https://github.com/casbin/casbin/blob/master/management_api.go): the primitive API that provides full support for Casbin policy management. See [here](https://github.com/casbin/casbin/blob/master/management_api_test.go) for examples.

- [RBAC API](https://github.com/casbin/casbin/blob/master/rbac_api.go): 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. See [here](https://github.com/casbin/casbin/blob/master/rbac_api_test.go) for examples.

We also provide a web-based UI for model management and policy management:

![model editor](https://hsluoyz.github.io/casbin/ui_model_editor.png)

![policy editor](https://hsluoyz.github.io/casbin/ui_policy_editor.png)

## Policy persistence

https://casbin.org/docs/en/adapters

## Role manager

https://casbin.org/docs/en/role-managers

## Benchmarks

https://casbin.org/docs/en/benchmark

## Examples

Model | Model file | Policy file

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

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

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

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

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

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

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

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

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

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

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

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

## Middlewares

In process

## Adopters

In process

## Contributors

## Sponsors



  

    

  



## License

## Contact

If you have any issues or feature requests, please contact us. PR is welcomed.

- https://github.com/evrone/casbin-ruby/issues