Skip to content

An open source application authorization and access control service built for developers and product teams.

License

Notifications You must be signed in to change notification settings

egasimov/warrant

Repository files navigation

Warrant

Website | Docs | API Reference | Slack | Twitter

Warrant - Open Source Access Control as a Service

Warrant is an application access control service built for developers and product teams. It's designed to abstract away the complexity of managing user access control from teams building software products so they (1) can offer best-in-class access control to customers from day one and (2) focus their efforts on building their core product.

Features

  • A centralized authorization service (inspired by Google Zanzibar) for defining, storing, and managing your product's authorization model and access rules (we call these warrants).
  • Supports a wide variety of common access control models from coarser Role Based Access Control (RBAC) to fine grained Relationship Based Access Control (ReBAC) and Attribute Based Access Control (ABAC) (e.g. [user:1] is an [editor] of [document:x])
  • Real-time, low latency check API to perform access checks in your application at runtime (e.g. is user:A editor of tenant:X?)
  • Real-time query API to query and audit access rules for a given subject or object (e.g. which users in tenant:1 have access to object:A?)
  • Built-in support for roles & permissions (RBAC)
    • API endpoints to create and manage custom roles and permissions for your users
  • Built-in support for multi-tenant access control
    • Define roles, permissions, and other access rules per tenant
    • Support scenarios where users have varying levels of access to resources depending on which tenant (or role) they're currently logged in as.
  • Built-in support for pricing tiers
    • Control access to your application's features in real time based on the pricing tiers offered by your product (e.g. free-tier, growth, business, enterprise, etc)
  • Front-end components and embeddable pages to allow/deny access to specific pages/UI elements and enable self-service management of roles & permissions
    • Pre-built components that help you build UIs that give your customers the ability to manage roles & permissions for themselves and their teammates
  • Easily integrates with in-house and third-party authn/identity providers like Auth0
  • Maintains a global event log that tracks all updates to authorization models and rules to make auditing, alerting, and debugging simple
  • SDK support for many of the most commonly used programming languages:
    • Go
    • Java
    • JS/TS
    • Python
    • PHP
    • Ruby

Use Cases

Warrant is built specifically for application authorization and access control, particularly for product, security, and compliance use-cases. Examples of problems Warrant solves are:

  • Add role based access control (RBAC) to your SaaS application with the ability for your customers to self-manage their roles and permissions via the Warrant self service dashboard or your own custom dashboard built using Warrant's component library.
  • Allow your customers to define and manage their own roles & permissions for their tenant (organization)
  • Add 'fine grained RBAC' (role based access to specific resources)
  • Implement fine grained, object/resource-level authorization specific to your application's data model ([user:1] is an [editor] of [document:x])
  • Add centralized and auditable access control around your internal applications.
  • Implement 'approval flows' (i.e. request access to a resource from an admin -> admin approves access).
  • Add Google Docs-like sharing and permissioning for your application's resources and objects.
  • Gate access to SaaS features based on your product's pricing tiers and feature packages.
  • Satisfy auditing and compliance requirements of frameworks and standards such as SOC2, HIPAA, GDPR and CCPA.

Getting Started

Warrant Cloud

The quickest and easiest way to get started with Warrant is by using the managed cloud service. You can sign-up for a free account here.

Warrant Cloud is compatible with the same APIs as this open source version and provides additional functionality like:

  • An admin dashboard for quickly managing your authorization model and access rules via an intuitive, easy-to-use UI
  • Multi-region availability
  • Improved access check latency & throughput for large scale use cases.

Once you've created an account, refer to our docs to get started.

Self-hosting

Warrant requires a database to store authorization models and access rules. The open source version currently has support for the following databases:

  • MySQL
  • Postgres (coming soon)
  • SQLite (coming soon)
  • To request support for another database, please open an issue!

If you'd like to self-host the open source version of Warrant, you have a few options:

Install and run the binary

Run with Docker

Run with Kubernetes

SDKs

Warrant's native SDKs are compatible with both the cloud and open-source versions of Warrant. We currently support SDKs for:

Documentation

Visit our docs to learn more about Warrant's key concepts & architecture and view our quickstarts & API reference.

Support

Join our Slack community to ask questions and get support.

Contributing

To report a bug you found or request a feature that you'd like, open an issue. If you'd like to contribute, submit a PR to resolve the issue.

Contributions from the community are welcome! Just be sure to follow some ground rules:

  • Never submit a PR without an issue.
  • Issues should mention whether the issue is a bug or a feature.
  • Issues reporting a bug should describe (1) steps to reproduce the bug, (2) what the current behavior is, and (3) what the expected behavior should be.
  • Issues requesting a feature should (1) provide a description of the feature and (2) explain the intended use case for the feature.

About

An open source application authorization and access control service built for developers and product teams.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 95.2%
  • PLpgSQL 4.6%
  • Other 0.2%