permify

README

Permify - Relationship Based Authorization Service

               

What is Permify?

Permify is a open-source relationship based authorization service for creating and maintaining fine-grained authorizations while ensuring least privilege across your organization.

With Permify, you can easily structure your authorization model, store authorization data in your preferred database, and interact with the Permify API to handle all authorization queries from your applications or services.

Permify inspired by Google’s consistent, global authorization system, Google Zanzibar Paper.

Looking for Permify Managed Service? See our pricing plans.

   

Key Features

🛡️ Production ready authorization API that serve as gRPC and REST

🔮 Domain Specific Authorization Language - Permify Schema - to easily model your authorization

🔐 Database Configuration to store your permissions in house with high availability

✅ Perform access control checks and get answers down to 10ms with parallel graph engine

💪 Battle tested, robust authorization architecture and data model based on Google Zanzibar

⚙️ Create custom permissions for your tenants, and manage them in single place with Multi Tenancy

⚡ Analyze performance and behavior of your authorization with tracing tools jaeger, signoz or zipkin

Cases that can benefit from Permify

• If you already have an identity/auth solution and want to plug in fine-grained authorization on top of that.
• If you want to create a unified access control mechanism to use across your individual applications.
• If you want to make future-proof authorization system and don't want to spend engineering effort for it.
• If you’re managing authorization for growing micro-service infrastructure.
• If your authorization logic is cluttering your code base.
• If your data model is getting too complicated to handle your authorization within the service.
• If your authorization is growing too complex to handle within code or API gateway.

+ Missing a specific use case? no problem, let's discuss it together! just open an issue. 

How it works

Permify stores access control relations on a database you choose and performs authorization checks based on the stored relations. We called that database Write Database (WriteDB) and it behaves as a centralized data source for your authorization system. You can model your authorization with Permify's DSL - Permify Schema and perform access checks with a single API call anywhere on your stack.

QuickStart

You can quickly start Permify on your local with running the docker command below:

docker run -p 3476:3476 -p 3478:3478  ghcr.io/permify/permify serve

This will start Permify with the default configuration options:

• Port 3476 is used to serve the REST API.
• Port 3478 is used to serve the GRPC Service.
• Authorization data stored in memory.

See all of the options that you can use to set up and deploy Permify in your servers.

Test your connection

You can test your connection with creating an GET request,

localhost:3476/healthz

Getting Started

• Set Up & Run Permify Service in your environment.
• Follow a guide to model your authorization using Permify Schema.
• See our playground, build your authorization logic and test it with sample data.
• Take a look at the overview of Permify API.
• See our article to examine Google Zanzibar In A Nutshell.

Community & Support

We would love to hear from you ❤

You can get immediate help on our Discord channel. This can be any kind of question-related to Permify, authorization, or authentication and identity management. We'd love to discuss anything related to access control space.

For feature requests, bugs, or any improvements you can always open an issue.

Want to Contribute? Here are the ways to contribute to Permify

• Contribute to codebase: We're collaboratively working with our community to make Permify the best it can be! You can develop new features, fix existing issues or make third-party integrations/packages.
• Improve documentation: Alongside our codebase, documentation one of the most significant part in our open-source journey. We're trying to give the best DX possible to explain ourselfs and Permify. And you can help on that with importing resources or adding new ones.
• Contribute to playground: Permify playground allows you to visualize and test your authorization logic. You can contribute to our playground by improving its user interface, fixing glitches, or adding new features.

You can find more details about contributions on CONTRIBUTING.md.

Communication Channels

If you like Permify, please consider giving us a ⭐

Stargazers