README.md - casbin-cpp - Git at Google

 Casbin-CPP
 ====

 [![CI](https://github.com/casbin/casbin-cpp/actions/workflows/ci.yml/badge.svg)](https://github.com/casbin/casbin-cpp/actions/workflows/ci.yml)
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/casbin/casbin-cpp)](https://github.com/casbin/casbin-cpp/releases/latest)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 [![Discord](https://img.shields.io/discord/1022748306096537660?logo=discord&label=discord&color=5865F2)](https://discord.gg/S5UjpzGZjN)

 **News**: Are you still worried about how to write the correct Casbin policy? ``Casbin online editor`` is coming to help! Try it at: http://casbin.org/editor/

 ## Build Availability on Platforms:
 OS | Availability
 ----------------- | -------------------
 Windows (VS C++)  | :heavy_check_mark: Available
 Linux   | :heavy_check_mark: Available
 macOS   | :heavy_check_mark: Available

 <br/>

 ![casbin Logo](./assets/images/casbin-logo.png)

 <br/>

 ## 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) | [![php](https://casbin.org/img/langs/php.png)](https://github.com/php-casbin/php-casbin)
 ----|----|----|----
 [Casbin](https://github.com/casbin/casbin) | [jCasbin](https://github.com/casbin/jcasbin) | [node-Casbin](https://github.com/casbin/node-casbin) | [PHP-Casbin](https://github.com/php-casbin/php-casbin)
 production-ready | production-ready | production-ready | production-ready

 [![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) | [![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)
 ----|----|----|----
 [PyCasbin](https://github.com/casbin/pycasbin) | [Casbin.NET](https://github.com/casbin-net/Casbin.NET) | [Casbin-CPP](https://github.com/casbin/casbin-cpp) | [Casbin-RS](https://github.com/casbin/casbin-rs)
 production-ready | production-ready | beta-test | production-ready

 **Note**: PyCasbin-on-CPP is available to use. Refer to the [documentation](./bindings/README.md) for installation and usage.

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

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

 ## Documentation

 https://casbin.org/docs/overview

 ## Online editor

 You can also use the online editor (https://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/tutorials

 ## Integrating Casbin to your project through CMake

 ### Without installing casbin locally

 Here is a [working project](https://github.com/EmperorYP7/casbin-CMake-setup) to demonstarte how to set up
 your CMake configurations to integrate casbin without any prior installations.

 You may integrate casbin into your CMake project through `find_package`. **It is assumed that you're using CMake >= v3.19.**

 You must have casbin installed on your system OR have it fetched from GitHub through [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html).

 Here's what your Findcasbin.cmake file should be:
 ```cmake
 include(FetchContent)

 FetchContent_Declare(
         casbin
         GIT_REPOSITORY https://github.com/casbin/casbin-cpp.git
         GIT_TAG v1.38.1
 )

 set(CASBIN_BUILD_TEST OFF)            # If you don't need to build tests for casbin
 set(CASBIN_BUILD_BENCHMARK OFF)       # If you don't need to build benchmarks for casbin
 set(CASBIN_BUILD_BINDINGS OFF)        # If you don't need language bindings provided by casbin
 set(CASBIN_BUILD_PYTHON_BINDINGS OFF) # If you don't need python bindings provided by casbin

 # Making casbin and its targets accessible to our project
 FetchContent_MakeAvailable(casbin)

 FetchContent_GetProperties(casbin)

 # If casbin wasn't populated, then manually populate it
 if(NOT casbin_POPULATED)
     FetchContent_Populate(casbin)
     add_subdirectory(${casbin_SOURCE_DIR} ${casbin_BINARY_DIR})
 endif()
 ```

 Now that casbin's targets are available to your project,
 your may link your own targets against casbin's likewise:

 ```cmake
 add_executable(myexec main.cpp)

 target_link_libraries(myexec PRIVATE casbin)

 set(myexec_INCLUDE_DIR ${casbin_SOURCE_DIR}/include)
 target_include_directories(myexec PRIVATE ${myexec_INCLUDE_DIR})
 ```

 Do remember to include `casbin_SOURCE_DIR/include` directory wherever casbin's functions are utilised.

 ### With local installation

 You may integrate casbin into your CMake project through `find_package`.
 **It is assumed that you're using CMake >= v3.19**

 1. Clone/checkout to [`casbin/casbin-cpp:master`](https://github.com/EmperorYP7/casbin-cpp/tree/ctest-setup)
     ```bash
     git clone https://github.com/casbin/casbin-cpp.git
     ```

 2. Open terminal/cmd in the root directory of the project:

     ```bash
     mkdir build
     cd build
     cmake ..
     ```

     **Note:** Look up for the logs of this step. And add the path indicated by the log into your PATH/project include directory.
     The log message you're looking for should be something like this:
     ```bash
     [casbin]: Installing casbin ...
     [casbin]: Installing casbin ... -  The targets can now be imported with find_package(casbin)
     [casbin]: Build the "install" target and add "/usr/local/include" to you PATH for casbin to work
     ```

 3. After the project is configured successfully, build it:
     ```bash
     cmake --build . --config Release
     ```

 4. Install casbin:

     ```bash
     cmake --build . --config Release --target install
     ```
     Now, casbin has been installed and ready to go.

 5. In your project's CMake file, add
     ```cmake
     find_package(casbin REQUIRED)
     ```
     This will import all the targets exported by casbin to your project

 6. Link against casbin (Refer to Step 2's **Note** to get the value of `MY_INCLUDE_DIR` for your system):
     ```cmake
     set(MY_INCLUDE_DIR "/usr/local/include")
     target_include_directories(MyTargetName PRIVATE ${MY_INCLUDE_DIR})
     target_link_libraries(MyTargetName PRIVATE casbin::casbin)
     ```

 ## Installation and Set-Up

 ### Build instructions for all platforms

 (Assuming you have CMake v3.19 or later installed)

 1. Clone/checkout to [`casbin/casbin-cpp:master`](https://github.com/EmperorYP7/casbin-cpp/tree/ctest-setup)
     ```bash
     git clone https://github.com/casbin/casbin-cpp.git
     ```

 2. Open terminal/cmd in the root directory of the project:

     **Note:** On Windows, this command will also create Visual Studio project files in the `/build` directory.

     ```bash
     mkdir build
     cd build
     cmake ..
     ```

 3. After the project is configured successfully, build it:

     ```bash
     cmake --build .
     ```

 4. To install casbin library to your machine run:

     ```bash
     cmake --build . --target install
     ```

     - For **Windows**, this will install `casbin.lib` to `<custom-path>/casbin-cpp/build/casbin`
     and the headers to `C:/Program Files/casbin/include`.
     - For Unix based OS i.e. **Linux and macOS**, this will install `casbin.a` to `<custom-path>/casbin-cpp/build/casbin`
     and the headers to `usr/local/include`.

     You can add the respective include and lib paths
     to the PATH environment variable to use casbin.

 5. (OPTIONAL) To run the tests, issue the following command from `/build`:

     ```bash
     ctest
     ```

 ## Get started

 1. Add the include directory of the project to the PATH Environment variable.
     ```cpp
     #include <casbin/casbin.h>
     ```

 2. Make a new a `casbin::Enforcer` with a model file and a policy file:

     ```cpp
     casbin::Enforcer e("./path/to/model.conf", "./path/to/policy.csv");
     ```

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

     ```cpp
     std::string sub = "alice"; // the user that wants to access a resource.
     std::string obj = "data1"; // the resource that is going to be accessed.
     std::string act = "read"; // the operation that the user performs on the resource.

     if(e.Enforce({ sub, obj, act })) {
         // permit alice to read data1
     } else {
         // deny the request, show an error
     }
     ```

 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:

     ```cpp
     std::vector<std::string> roles( e.GetImplicitRolesForUser(sub) );
     ```

 Here's the summary:
 ```cpp
 #include <casbin/casbin.h>
 #include <string>

 void IsAuthorized() {
     casbin::Enforcer e("./path/to/model.conf", "./path/to/policy.csv");

     std::string sub = "alice"; // the user that wants to access a resource.
     std::string obj = "data1"; // the resource that is going to be accessed.
     std::string act = "read"; // the operation that the user performs on the resource.

     if(e.Enforce({ sub, obj, act })) {
         // permit alice to read data1
     } else {
         // deny the request, show an error
     }
 }
 ```

 ## Policy management

 Casbin provides two sets of APIs to manage permissions:

 - [Management API](https://casbin.org/docs/management-api): the primitive API that provides full support for Casbin policy management.
 - [RBAC API](https://casbin.org/docs/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://casbin.org/docs/admin-portal) 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/adapters

 ## Policy consistence between multiple nodes

 https://casbin.org/docs/watchers

 ## Role manager

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

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

 Authz middlewares for web frameworks: https://casbin.org/docs/middlewares

 ## Our adopters

 https://casbin.org/docs/adopters

 ## How to Contribute

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

 ## Contributors

 This project exists thanks to all the people who contribute.
 <a href="https://github.com/casbin/casbin-cpp/graphs/contributors"><img src="https://opencollective.com/casbin-cpp/contributors.svg?width=890&button=false" /></a>

 ## Star History

 [![Star History Chart](https://api.star-history.com/svg?repos=casbin/casbin-cpp&type=Date)](https://star-history.com/#casbin/casbin-cpp&Date)

 ## License

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

 ## Contact

 If you have any issues or feature requests, please contact us. PR is welcomed.
 - https://github.com/casbin/casbin-cpp/issues
 - https://discord.gg/S5UjpzGZjN
	Casbin-CPP
	====

	[![CI](https://github.com/casbin/casbin-cpp/actions/workflows/ci.yml/badge.svg)](https://github.com/casbin/casbin-cpp/actions/workflows/ci.yml)
	[![GitHub release (latest by date)](https://img.shields.io/github/v/release/casbin/casbin-cpp)](https://github.com/casbin/casbin-cpp/releases/latest)
	[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
	[![Discord](https://img.shields.io/discord/1022748306096537660?logo=discord&label=discord&color=5865F2)](https://discord.gg/S5UjpzGZjN)

	News: Are you still worried about how to write the correct Casbin policy? ``Casbin online editor`` is coming to help! Try it at: http://casbin.org/editor/

	## Build Availability on Platforms:
	OS \| Availability
	----------------- \| -------------------
	Windows (VS C++) \| :heavy_check_mark: Available
	Linux \| :heavy_check_mark: Available
	macOS \| :heavy_check_mark: Available

	<br/>

	![casbin Logo](./assets/images/casbin-logo.png)

	<br/>

	## 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) \| [![php](https://casbin.org/img/langs/php.png)](https://github.com/php-casbin/php-casbin)
	----\|----\|----\|----
	[Casbin](https://github.com/casbin/casbin) \| [jCasbin](https://github.com/casbin/jcasbin) \| [node-Casbin](https://github.com/casbin/node-casbin) \| [PHP-Casbin](https://github.com/php-casbin/php-casbin)
	production-ready \| production-ready \| production-ready \| production-ready

	[![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) \| [![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)
	----\|----\|----\|----
	[PyCasbin](https://github.com/casbin/pycasbin) \| [Casbin.NET](https://github.com/casbin-net/Casbin.NET) \| [Casbin-CPP](https://github.com/casbin/casbin-cpp) \| [Casbin-RS](https://github.com/casbin/casbin-rs)
	production-ready \| production-ready \| beta-test \| production-ready

	Note: PyCasbin-on-CPP is available to use. Refer to the [documentation](./bindings/README.md) for installation and usage.

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

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

	## Documentation

	https://casbin.org/docs/overview

	## Online editor

	You can also use the online editor (https://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/tutorials

	## Integrating Casbin to your project through CMake

	### Without installing casbin locally

	Here is a [working project](https://github.com/EmperorYP7/casbin-CMake-setup) to demonstarte how to set up
	your CMake configurations to integrate casbin without any prior installations.

	You may integrate casbin into your CMake project through `find_package`. It is assumed that you're using CMake >= v3.19.

	You must have casbin installed on your system OR have it fetched from GitHub through [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html).

	Here's what your Findcasbin.cmake file should be:
	```cmake
	include(FetchContent)

	FetchContent_Declare(
	casbin
	GIT_REPOSITORY https://github.com/casbin/casbin-cpp.git
	GIT_TAG v1.38.1
	)

	set(CASBIN_BUILD_TEST OFF) # If you don't need to build tests for casbin
	set(CASBIN_BUILD_BENCHMARK OFF) # If you don't need to build benchmarks for casbin
	set(CASBIN_BUILD_BINDINGS OFF) # If you don't need language bindings provided by casbin
	set(CASBIN_BUILD_PYTHON_BINDINGS OFF) # If you don't need python bindings provided by casbin

	# Making casbin and its targets accessible to our project
	FetchContent_MakeAvailable(casbin)

	FetchContent_GetProperties(casbin)

	# If casbin wasn't populated, then manually populate it
	if(NOT casbin_POPULATED)
	FetchContent_Populate(casbin)
	add_subdirectory(${casbin_SOURCE_DIR} ${casbin_BINARY_DIR})
	endif()
	```

	Now that casbin's targets are available to your project,
	your may link your own targets against casbin's likewise:

	```cmake
	add_executable(myexec main.cpp)

	target_link_libraries(myexec PRIVATE casbin)

	set(myexec_INCLUDE_DIR ${casbin_SOURCE_DIR}/include)
	target_include_directories(myexec PRIVATE ${myexec_INCLUDE_DIR})
	```

	Do remember to include `casbin_SOURCE_DIR/include` directory wherever casbin's functions are utilised.

	### With local installation

	You may integrate casbin into your CMake project through `find_package`.
	It is assumed that you're using CMake >= v3.19

	1. Clone/checkout to [`casbin/casbin-cpp:master`](https://github.com/EmperorYP7/casbin-cpp/tree/ctest-setup)
	```bash
	git clone https://github.com/casbin/casbin-cpp.git
	```

	2. Open terminal/cmd in the root directory of the project:

	```bash
	mkdir build
	cd build
	cmake ..
	```

	Note: Look up for the logs of this step. And add the path indicated by the log into your PATH/project include directory.
	The log message you're looking for should be something like this:
	```bash
	[casbin]: Installing casbin ...
	[casbin]: Installing casbin ... - The targets can now be imported with find_package(casbin)
	[casbin]: Build the "install" target and add "/usr/local/include" to you PATH for casbin to work
	```

	3. After the project is configured successfully, build it:
	```bash
	cmake --build . --config Release
	```

	4. Install casbin:

	```bash
	cmake --build . --config Release --target install
	```
	Now, casbin has been installed and ready to go.

	5. In your project's CMake file, add
	```cmake
	find_package(casbin REQUIRED)
	```
	This will import all the targets exported by casbin to your project

	6. Link against casbin (Refer to Step 2's Note to get the value of `MY_INCLUDE_DIR` for your system):
	```cmake
	set(MY_INCLUDE_DIR "/usr/local/include")
	target_include_directories(MyTargetName PRIVATE ${MY_INCLUDE_DIR})
	target_link_libraries(MyTargetName PRIVATE casbin::casbin)
	```

	## Installation and Set-Up

	### Build instructions for all platforms

	(Assuming you have CMake v3.19 or later installed)

	1. Clone/checkout to [`casbin/casbin-cpp:master`](https://github.com/EmperorYP7/casbin-cpp/tree/ctest-setup)
	```bash
	git clone https://github.com/casbin/casbin-cpp.git
	```

	2. Open terminal/cmd in the root directory of the project:

	Note: On Windows, this command will also create Visual Studio project files in the `/build` directory.

	```bash
	mkdir build
	cd build
	cmake ..
	```

	3. After the project is configured successfully, build it:

	```bash
	cmake --build .
	```

	4. To install casbin library to your machine run:

	```bash
	cmake --build . --target install
	```

	- For Windows, this will install `casbin.lib` to `<custom-path>/casbin-cpp/build/casbin`
	and the headers to `C:/Program Files/casbin/include`.
	- For Unix based OS i.e. Linux and macOS, this will install `casbin.a` to `<custom-path>/casbin-cpp/build/casbin`
	and the headers to `usr/local/include`.

	You can add the respective include and lib paths
	to the PATH environment variable to use casbin.

	5. (OPTIONAL) To run the tests, issue the following command from `/build`:

	```bash
	ctest
	```

	## Get started

	1. Add the include directory of the project to the PATH Environment variable.
	```cpp
	#include <casbin/casbin.h>
	```

	2. Make a new a `casbin::Enforcer` with a model file and a policy file:

	```cpp
	casbin::Enforcer e("./path/to/model.conf", "./path/to/policy.csv");
	```

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

	```cpp
	std::string sub = "alice"; // the user that wants to access a resource.
	std::string obj = "data1"; // the resource that is going to be accessed.
	std::string act = "read"; // the operation that the user performs on the resource.

	if(e.Enforce({ sub, obj, act })) {
	// permit alice to read data1
	} else {
	// deny the request, show an error
	}
	```

	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:

	```cpp
	std::vector<std::string> roles( e.GetImplicitRolesForUser(sub) );
	```

	Here's the summary:
	```cpp
	#include <casbin/casbin.h>
	#include <string>

	void IsAuthorized() {
	casbin::Enforcer e("./path/to/model.conf", "./path/to/policy.csv");

	std::string sub = "alice"; // the user that wants to access a resource.
	std::string obj = "data1"; // the resource that is going to be accessed.
	std::string act = "read"; // the operation that the user performs on the resource.

	if(e.Enforce({ sub, obj, act })) {
	// permit alice to read data1
	} else {
	// deny the request, show an error
	}
	}
	```

	## Policy management

	Casbin provides two sets of APIs to manage permissions:

	- [Management API](https://casbin.org/docs/management-api): the primitive API that provides full support for Casbin policy management.
	- [RBAC API](https://casbin.org/docs/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://casbin.org/docs/admin-portal) 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/adapters

	## Policy consistence between multiple nodes

	https://casbin.org/docs/watchers

	## Role manager

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

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

	Authz middlewares for web frameworks: https://casbin.org/docs/middlewares

	## Our adopters

	https://casbin.org/docs/adopters

	## How to Contribute

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

	## Contributors

	This project exists thanks to all the people who contribute.
	<a href="https://github.com/casbin/casbin-cpp/graphs/contributors"><img src="https://opencollective.com/casbin-cpp/contributors.svg?width=890&button=false" /></a>

	## Star History

	[![Star History Chart](https://api.star-history.com/svg?repos=casbin/casbin-cpp&type=Date)](https://star-history.com/#casbin/casbin-cpp&Date)

	## License

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

	## Contact

	If you have any issues or feature requests, please contact us. PR is welcomed.
	- https://github.com/casbin/casbin-cpp/issues
	- https://discord.gg/S5UjpzGZjN