Modifier and Type	Class and Description
private static class	XMSSUtil.CheckingStream

Access	Constructor and Description
public	XMSSUtil()

Method Summary

Modifier and Type	Method and Description
public static boolean	Returns: true if all values in 2d-byte array are equal false else. areEqual(byte[][] 2d-byte array 1. a, byte[][] 2d-byte array 2. b) Compares two 2d-byte arrays.
public static long	bytesToXBigEndian(byte[] in, int offset, int size)
public static int	calculateTau(int index, int height)
public static byte[]	Returns: Copy of byte array. cloneArray(byte[] byte array. in) Clone a byte array.
public static byte[][]	Returns: Copy of 2d byte array. cloneArray(byte[][] 2d byte array. in) Clone a 2d byte array.
public static void	copyBytesAtOffset(byte[] Destination. dst, byte[] Source. src, int Destination offset. offset) Copy src byte array to dst byte array at offset.
public static Object	deserialize(byte[] data, final Class<T> clazz)
public static void	dumpByteArray(byte[][] byte array. x) Dump content of 2d byte array.
public static byte[]	Returns: New byte array. extractBytesAtOffset(byte[] Source byte array. src, int Offset in source byte array. offset, int Length of bytes to copy. length) Copy length bytes at position offset from src.
public static int	Returns: Digest size. getDigestSize(Digest Digest. digest) Determine digest size of digest.
public static int	getLeafIndex(long index, int xmssTreeHeight)
public static long	getTreeIndex(long index, int xmssTreeHeight)
public static boolean	Returns: true if at least one null pointer is found false else. hasNullPointer(byte[][] 2d byte array. in) Checks whether 2d byte array has null pointers.
public static boolean	Returns: true if index is valid false else. isIndexValid(int Height of binary tree. height, long Index to validate. index) Check whether an index is valid or not.
public static boolean	isNewAuthenticationPathNeeded(long globalIndex, int xmssHeight, int layer)
public static boolean	isNewBDSInitNeeded(long globalIndex, int xmssHeight, int layer)
public static int	Returns: Logarithm to base 2 of `n`. log2(int Number. n) Calculates the logarithm base 2 for a given Integer.
public static void	longToBigEndian(long value, byte[] in, int offset)
public static byte[]	serialize(Object obj)
public static byte[]	Returns: int/long as big-endian byte array of size `sizeInByte`. toBytesBigEndian(long int/long value. value, int Size of byte array in byte. sizeInByte) Convert int/long to n-byte array.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

XMSSUtil	back to summary
public XMSSUtil()

Method Detail

areEqual	back to summary
public static boolean areEqual(byte[][] a, byte[][] b) Compares two 2d-byte arrays. Parameters a:byte[][] 2d-byte array 1. b:byte[][] 2d-byte array 2. Returns:boolean true if all values in 2d-byte array are equal false else.

areEqual

back to summary

public static boolean areEqual(byte[][] a, byte[][] b)

Compares two 2d-byte arrays.

Parameters

a:byte[][]: 2d-byte array 1.
b:byte[][]: 2d-byte array 2.

Returns:boolean

true if all values in 2d-byte array are equal false else.

bytesToXBigEndian	back to summary
public static long bytesToXBigEndian(byte[] in, int offset, int size)

calculateTau	back to summary
public static int calculateTau(int index, int height)

cloneArray	back to summary
public static byte[] cloneArray(byte[] in) Clone a byte array. Parameters in:byte[] byte array. Returns:byte[] Copy of byte array.

cloneArray

back to summary

public static byte[] cloneArray(byte[] in)

Clone a byte array.

Parameters

in:byte[]: byte array.

Returns:byte[]

Copy of byte array.

cloneArray	back to summary
public static byte[][] cloneArray(byte[][] in) Clone a 2d byte array. Parameters in:byte[][] 2d byte array. Returns:byte[][] Copy of 2d byte array.

cloneArray

back to summary

public static byte[][] cloneArray(byte[][] in)

Clone a 2d byte array.

Parameters

in:byte[][]: 2d byte array.

Returns:byte[][]

Copy of 2d byte array.

copyBytesAtOffset	back to summary
public static void copyBytesAtOffset(byte[] dst, byte[] src, int offset) Copy src byte array to dst byte array at offset. Parameters dst:byte[] Destination. src:byte[] Source. offset:int Destination offset.

copyBytesAtOffset

back to summary

public static void copyBytesAtOffset(byte[] dst, byte[] src, int offset)

Copy src byte array to dst byte array at offset.

Parameters

dst:byte[]: Destination.
src:byte[]: Source.
offset:int: Destination offset.

deserialize	back to summary
public static Object deserialize(byte[] data, final Class<T> clazz) throws IOException, ClassNotFoundException

dumpByteArray	back to summary
public static void dumpByteArray(byte[][] x) Dump content of 2d byte array. Parameters x:byte[][] byte array.

dumpByteArray

back to summary

public static void dumpByteArray(byte[][] x)

Dump content of 2d byte array.

Parameters

x:byte[][]: byte array.

extractBytesAtOffset	back to summary
public static byte[] extractBytesAtOffset(byte[] src, int offset, int length) Copy length bytes at position offset from src. Parameters src:byte[] Source byte array. offset:int Offset in source byte array. length:int Length of bytes to copy. Returns:byte[] New byte array.

extractBytesAtOffset

back to summary

public static byte[] extractBytesAtOffset(byte[] src, int offset, int length)

Copy length bytes at position offset from src.

Parameters

src:byte[]: Source byte array.
offset:int: Offset in source byte array.
length:int: Length of bytes to copy.

Returns:byte[]

New byte array.

getDigestSize	back to summary
public static int getDigestSize(Digest digest) Determine digest size of digest. Parameters digest:Digest Digest. Returns:int Digest size.

getDigestSize

back to summary

public static int getDigestSize(Digest digest)

Determine digest size of digest.

Parameters

digest:Digest: Digest.

Returns:int

Digest size.

getLeafIndex	back to summary
public static int getLeafIndex(long index, int xmssTreeHeight)

getTreeIndex	back to summary
public static long getTreeIndex(long index, int xmssTreeHeight)

hasNullPointer	back to summary
public static boolean hasNullPointer(byte[][] in) Checks whether 2d byte array has null pointers. Parameters in:byte[][] 2d byte array. Returns:boolean true if at least one null pointer is found false else.

hasNullPointer

back to summary

public static boolean hasNullPointer(byte[][] in)

Checks whether 2d byte array has null pointers.

Parameters

in:byte[][]: 2d byte array.

Returns:boolean

true if at least one null pointer is found false else.

isIndexValid	back to summary
public static boolean isIndexValid(int height, long index) Check whether an index is valid or not. Parameters height:int Height of binary tree. index:long Index to validate. Returns:boolean true if index is valid false else.

isIndexValid

back to summary

public static boolean isIndexValid(int height, long index)

Check whether an index is valid or not.

Parameters

height:int: Height of binary tree.
index:long: Index to validate.

Returns:boolean

true if index is valid false else.

isNewAuthenticationPathNeeded	back to summary
public static boolean isNewAuthenticationPathNeeded(long globalIndex, int xmssHeight, int layer)

isNewBDSInitNeeded	back to summary
public static boolean isNewBDSInitNeeded(long globalIndex, int xmssHeight, int layer)

log2 back to summary

log2	back to summary
public static int log2(int n) Calculates the logarithm base 2 for a given Integer. Parameters n:int Number. Returns:int Logarithm to base 2 of `n`.

public static int log2(int n)

Calculates the logarithm base 2 for a given Integer.

Parameters

n:int: Number.

Returns:int

Logarithm to base 2 of n.

longToBigEndian	back to summary
public static void longToBigEndian(long value, byte[] in, int offset)

serialize	back to summary
public static byte[] serialize(Object obj) throws IOException

toBytesBigEndian back to summary

toBytesBigEndian	back to summary
public static byte[] toBytesBigEndian(long value, int sizeInByte) Convert int/long to n-byte array. Parameters value:long int/long value. sizeInByte:int Size of byte array in byte. Returns:byte[] int/long as big-endian byte array of size `sizeInByte`.

public static byte[] toBytesBigEndian(long value, int sizeInByte)

Convert int/long to n-byte array.

Parameters

value:long: int/long value.
sizeInByte:int: Size of byte array in byte.

Returns:byte[]

int/long as big-endian byte array of size sizeInByte.

org.bouncycastle.pqc.crypto.xmss back to summary

private Class XMSSUtil.CheckingStream

Class Inheritance

extends ObjectInputStream

java.lang.Object
java.io.InputStream
java.io.ObjectInputStream
org.bouncycastle.pqc.crypto.xmss.XMSSUtil.CheckingStream

Field Summary

Modifier and Type	Field and Description
private static final Set<E>	components
private boolean	found
private final Class<T>	mainClass

Constructor Summary

Access	Constructor and Description
pack-priv	CheckingStream(Class<T> mainClass, InputStream in)

Method Summary

Modifier and Type	Method and Description
protected Class<?>	resolveClass(ObjectStreamClass an instance of class `ObjectStreamClass` desc) Overrides java.io.ObjectInputStream.resolveClass. Load the local class equivalent of the specified stream class description.

Field Detail

components	back to summary
private static final Set<E> components

found	back to summary
private boolean found

mainClass	back to summary
private final Class<T> mainClass

Constructor Detail

CheckingStream	back to summary
pack-priv CheckingStream(Class<T> mainClass, InputStream in) throws IOException

Method Detail

resolveClass back to summary

resolveClass	back to summary
protected Class<?> resolveClass(ObjectStreamClass desc) throws IOException, ClassNotFoundException Overrides java.io.ObjectInputStream.resolveClass. Doc from java.io.ObjectInputStream.resolveClass. Load the local class equivalent of the specified stream class description. Subclasses may implement this method to allow classes to be fetched from an alternate source. The corresponding method in `ObjectOutputStream` is `annotateClass`. This method will be invoked only once for each unique class in the stream. This method can be implemented by subclasses to use an alternate loading mechanism but must return a `Class` object. Once returned, if the class is not an array class, its serialVersionUID is compared to the serialVersionUID of the serialized class, and if there is a mismatch, the deserialization fails and an `InvalidClassException` is thrown. The default implementation of this method in `ObjectInputStream` returns the result of calling `Class.forName(desc.getName(), false, loader)` Class.forName(desc.getName(), false, loader) where `loader` is the first class loader on the current thread's stack (starting from the currently executing method) that is neither the platform class loader nor its ancestor; otherwise, `loader` is the platform class loader. If this call results in a `ClassNotFoundException` and the name of the passed `ObjectStreamClass` instance is the Java language keyword for a primitive type or void, then the `Class` object representing that primitive type or void will be returned (e.g., an `ObjectStreamClass` with the name `"int"` will be resolved to `Integer.TYPE`). Otherwise, the `ClassNotFoundException` will be thrown to the caller of this method. Parameters desc:ObjectStreamClass an instance of class `ObjectStreamClass` Returns:Class<?> a `Class` object corresponding to `desc` Exceptions IOException: any of the usual Input/Output exceptions. ClassNotFoundException: if class of a serialized object cannot be found.

protected Class<?> resolveClass(ObjectStreamClass desc) throws IOException, ClassNotFoundException

Overrides java.io.ObjectInputStream.resolveClass.

Doc from java.io.ObjectInputStream.resolveClass.

Load the local class equivalent of the specified stream class description. Subclasses may implement this method to allow classes to be fetched from an alternate source.

The corresponding method in ObjectOutputStream is annotateClass. This method will be invoked only once for each unique class in the stream. This method can be implemented by subclasses to use an alternate loading mechanism but must return a Class object. Once returned, if the class is not an array class, its serialVersionUID is compared to the serialVersionUID of the serialized class, and if there is a mismatch, the deserialization fails and an InvalidClassException is thrown.

The default implementation of this method in ObjectInputStream returns the result of calling

Class.forName(desc.getName(), false, loader)

where loader is the first class loader on the current thread's stack (starting from the currently executing method) that is neither the platform class loader nor its ancestor; otherwise, loader is the platform class loader. If this call results in a ClassNotFoundException and the name of the passed ObjectStreamClass instance is the Java language keyword for a primitive type or void, then the Class object representing that primitive type or void will be returned (e.g., an ObjectStreamClass with the name "int" will be resolved to Integer.TYPE). Otherwise, the ClassNotFoundException will be thrown to the caller of this method.

Parameters

desc:ObjectStreamClass: an instance of class ObjectStreamClass

Returns:Class<?>

a Class object corresponding to desc

Exceptions

IOException:: any of the usual Input/Output exceptions.
ClassNotFoundException:: if class of a serialized object cannot be found.

public Class XMSSUtil

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class XMSSUtil.CheckingStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail