biscuit-auth/biscuit
1
1
Fork 0
mirror of https://github.com/biscuit-auth/biscuit.git synced 2024-09-11 06:15:30 +03:00
Code Issues Packages Projects Releases Wiki Activity

update API

Browse Source
This commit is contained in:
Geoffroy Couprie 2019-09-17 15:04:21 +02:00 committed by GitHub
parent 653f534b1b
commit f74d21151f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
DESIGN.md
View File

@ -200,10 +200,10 @@ caveat4 = resource(#ambient, X?) | prefix(X?, "/folder/") // prefix or suffix ma
A biscuit token has the following operations:
```
Token {
create(authority: Block, root: PrivateKey) -> Token
append(&self, block: Block, key: PrivateKey) -> Token
deserialize(data: [u8], root: PublicKey) -> Result<Token, String>
deserialize_sealed(data: [u8], secret: SymmetricKey) -> Result<Token, String>
create(rng: Rng, root: PrivateKey, authority: Block) -> Token
append(&self, rng: Rng, key: PrivateKey, block: Block) -> Token
deserialize(data: [u8], root: PublicKey) -> Result<Token, Error>
deserialize_sealed(data: [u8], secret: SymmetricKey) -> Result<Token, Error>
serialize(&self) -> [u8]
serialize_sealed(&self, secret: SymmetricKey) -> [u8]
}
@ -231,15 +231,21 @@ some usual facts and rules without errors.
```
Token {
builder() -> BiscuitBuilder
create_block(&self) -> BlockBuilder
}
BiscuitBuilder {
create(rng: Rng, root: PrivateKey, base_symbols: SymbolTable) -> Result<Biscuit, Error>
add_authority_fact(&mut self, fact: Fact)
add_authority_rule(&mut self, caveat: Rule)
add_right(&mut self, resource: string, right: string)
}
BlockBuilder {
create(index: u32, base_symbols: SymbolTable) -> Block
add_symbol(&mut self, s: string) -> Symbol
add_fact(&mut self, fact: Fact)
add_rule(&mut self, caveat: Rule)
add_right(&mut self, resource: string, right: string)
add_caveat(&mut self, caveat: Rule)
check_right(&mut self, right: string)
resource_prefix(&mut self, prefix: string)
resource_suffix(&mut self, suffix: string)