Package com.clevercloud.biscuit.token.format

Class SerializedBiscuit

java.lang.Object

com.clevercloud.biscuit.token.format.SerializedBiscuit

public class SerializedBiscuit
extends Object

Intermediate representation of a token before full serialization

Field Summary

Fields

Modifier and Type	Field	Description
SignedBlock	authority
List<SignedBlock>	blocks
static int	MAX_SCHEMA_VERSION
static int	MIN_SCHEMA_VERSION
Proof	proof
io.vavr.control.Option<Integer>	root_key_id

Method Summary

Modifier and Type	Method	Description
io.vavr.control.Either<Error.FormatError,SerializedBiscuit>	append(KeyPair next, Block newBlock)
static SerializedBiscuit	from_bytes(byte[] slice, KeyDelegate delegate)	Deserializes a SerializedBiscuit from a byte array
static SerializedBiscuit	from_bytes(byte[] slice, PublicKey root)	Deserializes a SerializedBiscuit from a byte array
static io.vavr.control.Either<Error.FormatError,SerializedBiscuit>	make(KeyPair root, Block authority, KeyPair next)
static io.vavr.control.Either<Error.FormatError,SerializedBiscuit>	make(KeyPair root, io.vavr.control.Option<Integer> root_key_id, Block authority, KeyPair next)
List<byte[]>	revocation_identifiers()
io.vavr.control.Either<Error,Void>	seal()
byte[]	serialize()	Serializes a SerializedBiscuit to a byte array
static SerializedBiscuit	unsafe_deserialize(byte[] slice)	Warning: this deserializes without verifying the signature
io.vavr.control.Either<Error,Void>	verify(PublicKey root)

Methods inherited from class java.lang.Object

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

Field Detail

authority

public SignedBlock authority

blocks

public List<SignedBlock> blocks

proof

public Proof proof

root_key_id

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

MIN_SCHEMA_VERSION

public static int MIN_SCHEMA_VERSION

MAX_SCHEMA_VERSION

public static int MAX_SCHEMA_VERSION

Method Detail

from_bytes

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

Deserializes a SerializedBiscuit from a byte array

Parameters:

slice -

Returns:

Throws:

NoSuchAlgorithmException

SignatureException

InvalidKeyException

Error

from_bytes

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

Deserializes a SerializedBiscuit from a byte array

Parameters:

slice -

Returns:

Throws:

NoSuchAlgorithmException

SignatureException

InvalidKeyException

Error

unsafe_deserialize

public static SerializedBiscuit unsafe_deserialize(byte[] slice)
                                            throws Error.FormatError.DeserializationError

Warning: this deserializes without verifying the signature

Parameters:

slice -

Returns:

SerializedBiscuit

Throws:

Error.FormatError.DeserializationError

serialize

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

Serializes a SerializedBiscuit to a byte array

Returns:

Throws:

Error.FormatError.SerializationError

make

public static io.vavr.control.Either<Error.FormatError,SerializedBiscuit> make(KeyPair root,
                                                                                     Block authority,
                                                                                     KeyPair next)

make

public static io.vavr.control.Either<Error.FormatError,SerializedBiscuit> make(KeyPair root,
                                                                                     io.vavr.control.Option<Integer> root_key_id,
                                                                                     Block authority,
                                                                                     KeyPair next)

append

public io.vavr.control.Either<Error.FormatError,SerializedBiscuit> append(KeyPair next,
                                                                                Block newBlock)

verify

public io.vavr.control.Either<Error,Void> verify(PublicKey root)
                                                throws NoSuchAlgorithmException,
                                                       InvalidKeyException,
                                                       SignatureException

Throws:

NoSuchAlgorithmException

InvalidKeyException

SignatureException

seal

public io.vavr.control.Either<Error,Void> seal()
                                              throws InvalidKeyException,
                                                     NoSuchAlgorithmException,
                                                     SignatureException

Throws:

InvalidKeyException

NoSuchAlgorithmException

SignatureException

revocation_identifiers

public List<byte[]> revocation_identifiers()