Package com.clevercloud.biscuit.token

Class Biscuit

java.lang.Object

com.clevercloud.biscuit.token.UnverifiedBiscuit

com.clevercloud.biscuit.token.Biscuit

public class Biscuit
extends UnverifiedBiscuit

Biscuit auth token

Method Summary

Modifier and Type	Method	Description
Biscuit	attenuate(Block block)	Generates a new token from an existing one and a new block
Biscuit	attenuate(SecureRandom rng, KeyPair keypair, Block block)	Generates a new token from an existing one and a new block
Authorizer	authorizer()	Creates a authorizer for this token
static Biscuit	builder(KeyPair root)	Creates a token builder
static Biscuit	builder(SecureRandom rng, KeyPair root)	Creates a token builder
static Biscuit	builder(SecureRandom rng, KeyPair root, SymbolTable symbols)	Creates a token builder
static Biscuit	builder(SecureRandom rng, KeyPair root, io.vavr.control.Option<Integer> root_key_id, SymbolTable symbols)	Creates a token builder
Biscuit	copy()
static Biscuit	from_b64(String data, PublicKey root)	Deprecated.
static Biscuit	from_b64url(String data, KeyDelegate delegate)	Deserializes a Biscuit token from a base64 url (RFC4648_URLSAFE) string
static Biscuit	from_b64url(String data, PublicKey root)	Deserializes a Biscuit token from a base64 url (RFC4648_URLSAFE) string
static Biscuit	from_bytes(byte[] data, KeyDelegate delegate)	Deserializes a Biscuit token from a byte array
static Biscuit	from_bytes(byte[] data, PublicKey root)	Deserializes a Biscuit token from a byte array
static Biscuit	from_bytes_with_symbols(byte[] data, KeyDelegate delegate, SymbolTable symbols)	Deserializes a Biscuit token from a byte array
static Biscuit	from_bytes_with_symbols(byte[] data, PublicKey root, SymbolTable symbols)	Deserializes a Biscuit token from a byte array
static Biscuit	make(SecureRandom rng, KeyPair root, SymbolTable symbols, Block authority)	Deprecated.
static Biscuit	make(SecureRandom rng, KeyPair root, io.vavr.control.Option<Integer> root_key_id, SymbolTable symbols, Block authority)	Creates a token
String	print()	Prints a token's content
byte[]	serialize()	Serializes a token to a byte array
String	serialize_b64()	Deprecated.
String	serialize_b64url()	Serializes a token to base 64 url String using RFC4648_URLSAFE

Methods inherited from class com.clevercloud.biscuit.token.UnverifiedBiscuit

checks, clone, context, create_block, default_symbol_table, from_b64url, from_bytes, from_bytes_with_symbols, revocation_identifiers, root_key_id, verify, verify

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static Biscuit builder(KeyPair root)

Creates a token builder

this function uses the default symbol table

Parameters:

root - root private key

Returns:

builder

public static Biscuit builder(SecureRandom rng,
                              KeyPair root)

Creates a token builder

this function uses the default symbol table

Parameters:

rng - random number generator

root - root private key

Returns:

builder

public static Biscuit builder(SecureRandom rng,
                              KeyPair root,
                              io.vavr.control.Option<Integer> root_key_id,
                              SymbolTable symbols)

Creates a token builder

Parameters:

rng - random number generator

root - root private key

symbols - symbol table

Returns:

builder

public static Biscuit builder(SecureRandom rng,
                              KeyPair root,
                              SymbolTable symbols)

Creates a token builder

Parameters:

rng - random number generator

root - root private key

symbols - symbol table

Returns:

make

@Deprecated
public static Biscuit make(SecureRandom rng,
                           KeyPair root,
                           SymbolTable symbols,
                           Block authority)
                    throws Error.SymbolTableOverlap,
                           Error.FormatError

Deprecated.

Creates a token

Parameters:

rng - random number generator

root - root private key

authority - authority block

Returns:

Throws:

Error.SymbolTableOverlap

Error.FormatError

make

public static Biscuit make(SecureRandom rng,
                           KeyPair root,
                           io.vavr.control.Option<Integer> root_key_id,
                           SymbolTable symbols,
                           Block authority)
                    throws Error.SymbolTableOverlap,
                           Error.FormatError

Creates a token

Parameters:

rng - random number generator

root - root private key

authority - authority block

Returns:

Throws:

Error.SymbolTableOverlap

Error.FormatError

from_b64

@Deprecated
public static Biscuit from_b64(String data,
                               PublicKey root)
                        throws NoSuchAlgorithmException,
                               SignatureException,
                               InvalidKeyException,
                               Error

Deprecated.

Deserializes a Biscuit token from a hex string

This checks the signature, but does not verify that the first key is the root key, to allow appending blocks without knowing about the root key.

The root key check is performed in the verify method

This method uses the default symbol table

Parameters:

data -

Returns:

Throws:

NoSuchAlgorithmException

SignatureException

InvalidKeyException

Error

from_b64url

public static Biscuit from_b64url(String data,
                                  PublicKey root)
                           throws NoSuchAlgorithmException,
                                  SignatureException,
                                  InvalidKeyException,
                                  Error

Deserializes a Biscuit token from a base64 url (RFC4648_URLSAFE) string

This checks the signature, but does not verify that the first key is the root key, to allow appending blocks without knowing about the root key.

The root key check is performed in the verify method

This method uses the default symbol table

Parameters:

data -

Returns:

Biscuit

Throws:

NoSuchAlgorithmException

SignatureException

InvalidKeyException

Error

from_b64url

public static Biscuit from_b64url(String data,
                                  KeyDelegate delegate)
                           throws NoSuchAlgorithmException,
                                  SignatureException,
                                  InvalidKeyException,
                                  Error

Deserializes a Biscuit token from a base64 url (RFC4648_URLSAFE) string

This checks the signature, but does not verify that the first key is the root key, to allow appending blocks without knowing about the root key.

The root key check is performed in the verify method

This method uses the default symbol table

Parameters:

data -

Returns:

Biscuit

Throws:

NoSuchAlgorithmException

SignatureException

InvalidKeyException

Error

from_bytes

public static Biscuit from_bytes(byte[] data,
                                 PublicKey root)
                          throws NoSuchAlgorithmException,
                                 SignatureException,
                                 InvalidKeyException,
                                 Error

Deserializes a Biscuit token from a byte array

This checks the signature, but does not verify that the first key is the root key, to allow appending blocks without knowing about the root key.

The root key check is performed in the verify method

This method uses the default symbol table

Parameters:

data -

Returns:

Throws:

NoSuchAlgorithmException

SignatureException

InvalidKeyException

Error

from_bytes

public static Biscuit from_bytes(byte[] data,
                                 KeyDelegate delegate)
                          throws NoSuchAlgorithmException,
                                 SignatureException,
                                 InvalidKeyException,
                                 Error

Deserializes a Biscuit token from a byte array

This checks the signature, but does not verify that the first key is the root key, to allow appending blocks without knowing about the root key.

The root key check is performed in the verify method

This method uses the default symbol table

Parameters:

data -

Returns:

Throws:

NoSuchAlgorithmException

SignatureException

InvalidKeyException

Error

from_bytes_with_symbols

public static Biscuit from_bytes_with_symbols(byte[] data,
                                              PublicKey root,
                                              SymbolTable symbols)
                                       throws NoSuchAlgorithmException,
                                              SignatureException,
                                              InvalidKeyException,
                                              Error

Deserializes a Biscuit token from a byte array

This checks the signature, but does not verify that the first key is the root key, to allow appending blocks without knowing about the root key.

The root key check is performed in the verify method

Parameters:

data -

Returns:

Throws:

NoSuchAlgorithmException

SignatureException

InvalidKeyException

Error

from_bytes_with_symbols

public static Biscuit from_bytes_with_symbols(byte[] data,
                                              KeyDelegate delegate,
                                              SymbolTable symbols)
                                       throws NoSuchAlgorithmException,
                                              SignatureException,
                                              InvalidKeyException,
                                              Error

Deserializes a Biscuit token from a byte array

This checks the signature, but does not verify that the first key is the root key, to allow appending blocks without knowing about the root key.

The root key check is performed in the verify method

Parameters:

data -

Returns:

Throws:

NoSuchAlgorithmException

SignatureException

InvalidKeyException

Error

authorizer

public Authorizer authorizer()
                      throws Error.FailedLogic

Creates a authorizer for this token

This function checks that the root key is the one we expect

Returns:

Throws:

Error.FailedLogic

serialize

public byte[] serialize()
                 throws Error.FormatError.SerializationError

Serializes a token to a byte array

Overrides:

serialize in class UnverifiedBiscuit

Returns:

Throws:

Error.FormatError.SerializationError

serialize_b64

@Deprecated
public String serialize_b64()
                     throws Error.FormatError.SerializationError

Deprecated.

Serializes a token to a base 64 String

Returns:

Throws:

Error.FormatError.SerializationError

serialize_b64url

public String serialize_b64url()
                        throws Error.FormatError.SerializationError

Serializes a token to base 64 url String using RFC4648_URLSAFE

Overrides:

serialize_b64url in class UnverifiedBiscuit

Returns:

String

Throws:

Error.FormatError.SerializationError

attenuate

public Biscuit attenuate(Block block)
                  throws Error

Generates a new token from an existing one and a new block

Overrides:

attenuate in class UnverifiedBiscuit

Parameters:

block - new block (should be generated from a Block builder)

Returns:

Throws:

Error

attenuate

public Biscuit attenuate(SecureRandom rng,
                         KeyPair keypair,
                         Block block)
                  throws Error

Generates a new token from an existing one and a new block

Overrides:

attenuate in class UnverifiedBiscuit

Parameters:

rng - random number generator

keypair - ephemeral key pair

block - new block (should be generated from a Block builder)

Returns:

Throws:

Error

print

public String print()

Prints a token's content

Overrides:

print in class UnverifiedBiscuit

copy

public Biscuit copy()
             throws Error

Overrides:

copy in class UnverifiedBiscuit

Throws:

Error