Package com.clevercloud.biscuit.token

Class UnverifiedBiscuit

java.lang.Object

com.clevercloud.biscuit.token.UnverifiedBiscuit

Direct Known Subclasses:

Biscuit

public class UnverifiedBiscuit
extends Object

UnverifiedBiscuit auth token. UnverifiedBiscuit means it's deserialized without checking signatures.

Method Summary

Modifier and Type	Method	Description
UnverifiedBiscuit	attenuate(Block block)	Generates a new token from an existing one and a new block
UnverifiedBiscuit	attenuate(SecureRandom rng, KeyPair keypair, Block block)	Generates a new token from an existing one and a new block
List<List<Check>>	checks()
protected Object	clone()
List<io.vavr.control.Option<String>>	context()
UnverifiedBiscuit	copy()
Block	create_block()	Creates a Block builder
static SymbolTable	default_symbol_table()	Default symbols list
static UnverifiedBiscuit	from_b64url(String data)	Deserializes a Biscuit token from a base64 url (RFC4648_URLSAFE) string
static UnverifiedBiscuit	from_bytes(byte[] data)	Deserializes a Biscuit token from a byte array
static UnverifiedBiscuit	from_bytes_with_symbols(byte[] data, SymbolTable symbols)	Deserializes a UnverifiedBiscuit from a byte array
String	print()	Prints a token's content
List<RevocationIdentifier>	revocation_identifiers()
io.vavr.control.Option<Integer>	root_key_id()
byte[]	serialize()	Serializes a token to a byte array
String	serialize_b64url()	Serializes a token to base 64 url String using RFC4648_URLSAFE
Biscuit	verify(KeyDelegate delegate)
Biscuit	verify(PublicKey publicKey)

Methods inherited from class java.lang.Object

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

Method Detail

from_b64url

public static UnverifiedBiscuit from_b64url(String data)
                                     throws Error

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

This method uses the default symbol table

Parameters:

data -

Returns:

Biscuit

Throws:

Error

from_bytes

public static UnverifiedBiscuit from_bytes(byte[] data)
                                    throws Error

Deserializes a Biscuit token from a byte array

This method uses the default symbol table

Parameters:

data -

Returns:

Throws:

Error

from_bytes_with_symbols

public static UnverifiedBiscuit from_bytes_with_symbols(byte[] data,
                                                        SymbolTable symbols)
                                                 throws Error

Deserializes a UnverifiedBiscuit from a byte array

Parameters:

data -

Returns:

UnverifiedBiscuit

Throws:

Error

serialize

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

Serializes a token to a byte array

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

Returns:

String

Throws:

Error.FormatError.SerializationError

create_block

public Block create_block()

Creates a Block builder

Returns:

attenuate

public UnverifiedBiscuit attenuate(Block block)
                            throws NoSuchAlgorithmException,
                                   SignatureException,
                                   InvalidKeyException,
                                   Error

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

Parameters:

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

Returns:

Throws:

NoSuchAlgorithmException

SignatureException

InvalidKeyException

Error

attenuate

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

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

Parameters:

rng - random number generator

keypair - ephemeral key pair

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

Returns:

Throws:

Error

revocation_identifiers

public List<RevocationIdentifier> revocation_identifiers()

checks

public List<List<Check>> checks()

context

public List<io.vavr.control.Option<String>> context()

root_key_id

public io.vavr.control.Option<Integer> root_key_id()

print

public String print()

Prints a token's content

default_symbol_table

public static SymbolTable default_symbol_table()

Default symbols list

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

copy

public UnverifiedBiscuit copy()
                       throws Error

Throws:

Error

verify

public Biscuit verify(PublicKey publicKey)
               throws Error,
                      NoSuchAlgorithmException,
                      SignatureException,
                      InvalidKeyException

Throws:

Error

NoSuchAlgorithmException

SignatureException

InvalidKeyException

verify

public Biscuit verify(KeyDelegate delegate)
               throws Error,
                      NoSuchAlgorithmException,
                      SignatureException,
                      InvalidKeyException

Throws:

Error

NoSuchAlgorithmException

SignatureException

InvalidKeyException