pfzetto/rebacs
1
0
Fork 0
mirror of https://github.com/pfzetto/rebacs synced 2024-11-21 10:42:49 +01:00
Code Issues Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
Paul Zinselmeyer 2023-12-08 16:26:21 +01:00
parent bbf933a68b
commit badeefad47
Signed by: pfzetto
GPG key ID: 4EEF46A5B276E648
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,21 +1,21 @@
This library implements a in-memory relationship-based access control dababase, that was inspired by [Google's Zanzibar](https://research.google/pubs/pub48190/).
# Naming
## `RObject`
A `RObject` is a tuple of the values (`namespace`, `id`).
## `Object`
A `Object` is a tuple of the values (`namespace`, `id`).
It represents a object like a user.
Example: (`users`, `alice`).
## `RSet`
A `RSet` is a tuple of the values (`namespace`, `id`, `permission`).
It represents a permission for a `RObject`.
## `Set`
A `Set` is a tuple of the values (`namespace`, `id`, `permission`).
It represents a permission for a `Object`.
Example: (`files`, `foo.pdf`, `read`).
# Usage
The `RelationGraph`-struct contains a graph of all relationships.
Relationships can be created between:
- `RObject` and `RSet` => user alice can read the file foo.pdf.
- `RSet` and `RSet` => everyone who can read the file foo.pdf can read the file bar.pdf.
- `Object` and `Set` => user alice can read the file foo.pdf.
- `Set` and `Set` => everyone who can read the file foo.pdf can read the file bar.pdf.
# Specials
- The `*`-id is used as a wildcard id to create a virtual relation from this id to every other id in the namespace.