README.md

Cedar Example Use Cases

This repository contains Cedar policies that model the authorization logic of six example applications.

• The document cloud drive example models a cloud-based document sharing system, like Google Drive or Dropbox.
• The GitHub example mimics GitHub's repository access permissions.
• The Hotel chains example models permissions according to the hierarchy of a hotel chain.
• The Tags & roles example implements tag-based access control -- access is granted according to matching tags between principals and resources, where principal-side tags are attached to roles a principal can play.
• The Tax preparer example grants access to sensitive documents based on a principal's organizational memberships, so long as overall consent has been provided by the doc owner.

Quick Start

You can validate example policies and perform authorization requests using the Cedar CLI. Simply build the CLI following the instructions in the README, and then add the resulting executable (cedar) to your path. This executable will end up in /path/to/cedar-policy/cedar/target/debug/.

# validate the document_cloud policies
cedar validate \
      --policies document_cloud/policies.cedar \
      --schema document_cloud/document_cloud.cedarschema.json

# perform an authorization request with the document_cloud policies
cedar authorize \
      --policies document_cloud/policies.cedar \
      --entities document_cloud/entities.json \
      --request-json document_cloud/allow_requests/alice_view_alice_public.json

Use the run.sh script to validate the policies and run every authorization test for both examples.

Subfolder Organization

File	Description
policies.cedar	Cedar policies
linked	Cedar policy-template links
entities.json	Sample entity store
policies.cedarschema	Cedar schema
ALLOW	Allowed requests
DENY	Denied requests
README.md	A tutorial walking through the application

For some examples, there exist both static and templated versions of the policies, stored in different subfolders.