mirror of
https://github.com/biscuit-auth/biscuit.git
synced 2024-09-11 06:15:30 +03:00
delegated, decentralized, capabilities based authorization token
|
||
---|---|---|
assets | ||
biscuit-web-key | ||
experimentations | ||
samples | ||
DESIGN.md | ||
LICENSE | ||
README.md | ||
schema.proto | ||
SECURITY.md | ||
SPECIFICATIONS.md | ||
SUMMARY.md |
Biscuit authentication/authorization token
![](https://raw.githubusercontent.com/biscuit-auth/biscuit/master/assets/brown.png)
Goals
Biscuit is an authentication and authorization token for microservices architectures with the following properties:
- distributed authentication: any node could validate the token only with public information;
- offline delegation: a new, valid token can be created from another one by attenuating its rights, by its holder, without communicating with anyone;
- capabilities based: authorization in microservices should be tied to rights related to the request, instead of relying on an identity that might not make sense to the verifier;
- flexible rights managements: the token uses a logic language to specify attenuation and add bounds on ambient data, what it can model ranges from small rules like expiration dates, to more flexible architectures like hierarchical roles and user delegation;
- small enough to fit anywhere (cookies, etc).
Non goals
- This is not a new authentication protocol. Biscuit tokens can be used as opaque tokens delivered by other systems such as OAuth.
- Revocation: Biscuit generates unique revocation identifiers for each token, and can provide expiration dates as well, but revocation requires external state management (revocation lists, databases, etc) that is outside of this specification. See the revocation guide for more information.
Roadmap
You can follow the next steps on the roadmap.
Current status:
- the credentials language, cryptographic primitives and serialization format are done
- we have implementations for biscuits v2 in
- Rust
- Web Assembly (based on the Rust version)
- Python (based on the Rust version)
- Haskell
- we have implementations for biscuits v1 in
- a website with documentation and an interactive playground is live at https://biscuitsec.org
- Currently deploying to real world use cases such as Apache Pulsar at Clever Cloud
- looking for an audit of the token's design, cryptographic primitives and implementations
How to help us?
- provide use cases that we can test the token on (some specific kind of checks, auth delegation, etc)
- cryptographic design audit: we need reviews of algorithms, their usage and implementation in various languages
- add support for biscuit v2 to java and go implementations
Project organisation
SUMMARY.md
: introduction to Biscuit from a user's perspectiveSPECIFICATIONS.md
is the description of Biscuit, its format and behaviourbiscuit-web-key/
is a specification for publishing biscuit public keysDESIGN.md
holds the initial ideas about what Biscuit should beexperimentations/
holds initial code examples for the crypographic schemes and caveat language.code/biscuit-poc/
contains an experimental version of Biscuit, built to explore API issues
License
Licensed under Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
logo by Mathias Adam
originally created at Clever Cloud
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.