Struct biscuit_auth::Biscuit

pub struct Biscuit { /* private fields */ }

This structure represents a valid Biscuit token

It contains multiple Block elements, the associated symbol table, and a serialized version of this data

extern crate biscuit_auth as biscuit;

use biscuit::{KeyPair, Biscuit, builder::*};

fn main() {
  let root = KeyPair::new();

  // first we define the authority block for global data,
  // like access rights
  // data from the authority block cannot be created in any other block
  let mut builder = Biscuit::builder(&root);
  builder.add_authority_fact(fact("right", &[string("/a/file1.txt"), s("read")]));

  // facts and rules can also be parsed from a string
  builder.add_authority_fact("right(\"/a/file1.txt\", \"read\")").expect("parse error");

  let token1 = builder.build().unwrap();

  // we can create a new block builder from that token
  let mut builder2 = token1.create_block();
  builder2.check_operation("read");

  let token2 = token1.append(builder2).unwrap();
}

Implementations

impl Biscuit

pub fn builder(root: &KeyPair) -> BiscuitBuilder<'_>

create the first block’s builder

call builder::BiscuitBuilder::build to create the token

pub fn from<T, F>(slice: T, f: F) -> Result<Self, Token> where
    F: Fn(Option<u32>) -> PublicKey,
    T: AsRef<[u8]>, 

deserializes a token and validates the signature using the root public key

pub fn from_base64<T, F>(slice: T, f: F) -> Result<Self, Token> where
    F: Fn(Option<u32>) -> PublicKey,
    T: AsRef<[u8]>, 

deserializes a token and validates the signature using the root public key

pub fn to_vec(&self) -> Result<Vec<u8>, Token>

serializes the token

pub fn to_base64(&self) -> Result<String, Token>

serializes the token and encode it to a (URL safe) base64 string

pub fn serialized_size(&self) -> Result<usize, Token>

serializes the token

pub fn seal(&self) -> Result<Biscuit, Token>

creates a sealed version of the token

sealed tokens cannot be attenuated

pub fn authorizer(&self) -> Result<Authorizer<'_>, Token>

creates a authorizer from this token

pub fn create_block(&self) -> BlockBuilder

creates a new block builder

pub fn append(&self, block_builder: BlockBuilder) -> Result<Self, Token>

adds a new block to the token

since the public key is integrated into the token, the keypair can be discarded right after calling this function

pub fn context(&self) -> Vec<Option<String>>

returns the list of context elements of each block

the context is a free form text field in which application specific data can be stored

pub fn revocation_identifiers(&self) -> Vec<Vec<u8>>

returns a list of revocation identifiers for each block, in order

if a token is generated with the same keys and the same content, those identifiers will stay the same

pub fn print(&self) -> String

pretty printer for this token

pub fn print_block_source(&self, index: usize) -> Option<String>

prints the content of a block as Datalog source code

pub fn builder_with_symbols(
    root: &KeyPair,
    symbols: SymbolTable
) -> BiscuitBuilder<'_>

create the first block’s builder, sing a provided symbol table

pub fn from_with_symbols<F>(
    slice: &[u8],
    f: F,
    symbols: SymbolTable
) -> Result<Self, Token> where
    F: Fn(Option<u32>) -> PublicKey, 

deserializes a token and validates the signature using the root public key, with a custom symbol table

pub fn from_base64_with_symbols<T, F>(
    slice: T,
    f: F,
    symbols: SymbolTable
) -> Result<Self, Token> where
    F: Fn(Option<u32>) -> PublicKey,
    T: AsRef<[u8]>, 

deserializes a token and validates the signature using the root public key, with a custom symbol table

pub fn container(&self) -> Option<&SerializedBiscuit>

returns the internal representation of the token

pub fn append_with_keypair(
    &self,
    keypair: &KeyPair,
    block_builder: BlockBuilder
) -> Result<Self, Token>

adds a new block to the token, using the provided CSPRNG

since the public key is integrated into the token, the keypair can be discarded right after calling this function

pub fn block_symbols(&self, index: usize) -> Option<Vec<String>>

gets the list of symbols from a block

pub fn block_count(&self) -> usize

returns the number of blocks (at least 1)

Trait Implementations

impl Clone for Biscuit

fn clone(&self) -> Biscuit

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Biscuit

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.