https://github.com/jcasbin/casbin-java-cli
Java CLI for jCasbin
https://github.com/jcasbin/casbin-java-cli
Last synced: 3 days ago
JSON representation
Java CLI for jCasbin
- Host: GitHub
- URL: https://github.com/jcasbin/casbin-java-cli
- Owner: jcasbin
- License: apache-2.0
- Created: 2024-07-29T03:06:55.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-11-19T06:21:19.000Z (8 months ago)
- Last Synced: 2024-11-19T07:25:39.255Z (8 months ago)
- Language: Java
- Size: 40 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# casbin-java-cli
[](https://github.com/jcasbin/casbin-java-cli/actions/workflows/maven-ci.yml)
[](https://app.codecov.io/github/jcasbin/casbin-java-cli)
[](https://github.com/jcasbin/casbin-java-cli/releases/latest)
[](https://discord.gg/S5UjpzGZjN)
casbin-java-cli is a command-line tool based on jcasbin, enabling you to use all of jcasbin's APIs in the shell.
## Installation
1. Clone project from repository
``` shell
git clone https://github.com/jcasbin/casbin-java-cli.git
```
2. Build project, the jar package will be generated in the `target` directory
``` shell
cd casbin-java-cli
mvn clean install
```
## Options
| options | description | must | remark |
|-----------------------|----------------------------------------------|------|-----------------------------------------------------------|
| `-m, --model` | The path of the model file or model text | y | Please wrap it with `""` and separate each line with `\|` |
| `-p, --policy` | The path of the policy file or policy text | y | Please wrap it with `""` and separate each line with `\|` |
| `-e, --enforce` | Check permissions | n | Please wrap it with `""` |
| `-ex, --enforceEx` | Check permissions and get which policy it is | n | Please wrap it with `""` |
| `-AF, --addFuntion` | Add custom funtion | n | Please wrap it with `""` and separate each line with `\|` |
| `-ap, --addPolicy` | Add a policy rule to the policy file | n | Please wrap it with `""` |
| `-rp, --removePolicy` | Remove a policy rule from the policy file | n | Please wrap it with `""` |
## Get started
- Check whether Alice has read permission on data1
```shell
./casbin enforce -m "examples/rbac_model.conf" -p "examples/rbac_policy.csv" "alice" "data1" "read"
```
> {"allow":true,"explain":null}
```shell
./casbin enforce -m "[request_definition]\nr = sub, obj, act\n[policy_definition]\np = sub, obj, act\n[role_definition]\ng = _, _\n[policy_effect]\ne = some(where (p.eft == allow))\n[matchers]\nm = g(r.sub, p.sub) && r.obj == p.obj && r.act == p.act" -p "p, alice, data1, read\np, bob, data2, write\np, data2_admin, data2, read\np, data2_admin, data2, write\ng, alice, data2_admin" "alice" "data1" "read"
```
> {"allow":true,"explain":null}
- Check whether Alice has write permission for data2. If so, display the effective policy.
```shell
./casbin enforceEx -m "examples/rbac_model.conf" -p "examples/rbac_policy.csv" "alice" "data2" "write"
```
> {"allow":true,"explain":["data2_admin","data2","write"]}
- Add a policy to the policy file
```shell
./casbin addPolicy -m "examples/rbac_model.conf" -p "examples/rbac_policy.csv" "alice" "data2" "write"
```
> {"allow":true,"explain":null}
- Delete a policy from the policy file
```shell
./casbin removePolicy -m "examples/rbac_model.conf" -p "examples/rbac_policy.csv" "alice" "data2" "write"
```
> {"allow":true,"explain":null}