Modifier and Type	Class and Description
public static class	NTRUSigningPrivateKeyParameters.Basis A NtruSign basis.

Modifier and Type	Field and Description
private List<NTRUSigningPrivateKeyParameters.Basis>	bases
private NTRUSigningPublicKeyParameters	publicKey

Access	Constructor and Description
public	NTRUSigningPrivateKeyParameters(byte[] an encoded private key b, NTRUSigningKeyGenerationParameters the NtruSign parameters to use params) Constructs a new private key from a byte array
public	NTRUSigningPrivateKeyParameters(InputStream an input stream is, NTRUSigningKeyGenerationParameters the NtruSign parameters to use params) Constructs a new private key from an input stream
public	NTRUSigningPrivateKeyParameters(List<NTRUSigningPrivateKeyParameters.Basis> bases, NTRUSigningPublicKeyParameters publicKey)

Modifier and Type	Method and Description
private void	add(NTRUSigningPrivateKeyParameters.Basis a NtruSign basis b) Adds a basis to the key.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public NTRUSigningPrivateKeyParameters.Basis	Returns: the basis at index `i` getBasis(int the index i) Returns the `i`-th basis
public byte[]	Returns: the encoded key getEncoded() Converts the key to a byte array
public NTRUSigningPublicKeyParameters	getPublicKey()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	writeTo(OutputStream an output stream os) Writes the key to an output stream

bases	back to summary
private List<NTRUSigningPrivateKeyParameters.Basis> bases

publicKey	back to summary
private NTRUSigningPublicKeyParameters publicKey

NTRUSigningPrivateKeyParameters	back to summary
public NTRUSigningPrivateKeyParameters(byte[] b, NTRUSigningKeyGenerationParameters params) throws IOException Constructs a new private key from a byte array Parameters b:byte[] an encoded private key params:NTRUSigningKeyGenerationParameters the NtruSign parameters to use

NTRUSigningPrivateKeyParameters	back to summary
public NTRUSigningPrivateKeyParameters(InputStream is, NTRUSigningKeyGenerationParameters params) throws IOException Constructs a new private key from an input stream Parameters is:InputStream an input stream params:NTRUSigningKeyGenerationParameters the NtruSign parameters to use

NTRUSigningPrivateKeyParameters	back to summary
public NTRUSigningPrivateKeyParameters(List<NTRUSigningPrivateKeyParameters.Basis> bases, NTRUSigningPublicKeyParameters publicKey)

Method Detail

add	back to summary
private void add(NTRUSigningPrivateKeyParameters.Basis b) Adds a basis to the key. Parameters b:NTRUSigningPrivateKeyParameters.Basis a NtruSign basis

add

back to summary

private void add(NTRUSigningPrivateKeyParameters.Basis b)

Adds a basis to the key.

Parameters

b:NTRUSigningPrivateKeyParameters.Basis: a NtruSign basis

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getBasis back to summary

getBasis	back to summary
public NTRUSigningPrivateKeyParameters.Basis getBasis(int i) Returns the `i`-th basis Parameters i:int the index Returns:NTRUSigningPrivateKeyParameters.Basis the basis at index `i`

public NTRUSigningPrivateKeyParameters.Basis getBasis(int i)

Returns the i-th basis

Parameters

i:int: the index

Returns:NTRUSigningPrivateKeyParameters.Basis

the basis at index i

getEncoded	back to summary
public byte[] getEncoded() throws IOException Converts the key to a byte array Returns:byte[] the encoded key

getEncoded

back to summary

public byte[] getEncoded() throws IOException

Converts the key to a byte array

Returns:byte[]: the encoded key

getPublicKey	back to summary
public NTRUSigningPublicKeyParameters getPublicKey()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

writeTo	back to summary
public void writeTo(OutputStream os) throws IOException Writes the key to an output stream Parameters os:OutputStream an output stream

writeTo

back to summary

public void writeTo(OutputStream os) throws IOException

Writes the key to an output stream

Parameters

os:OutputStream: an output stream

org.bouncycastle.pqc.legacy.crypto.ntru back to summary

public Class NTRUSigningPrivateKeyParameters.Basis

Class Inheritance

extends Object

java.lang.Object
org.bouncycastle.pqc.legacy.crypto.ntru.NTRUSigningPrivateKeyParameters.Basis

Known Direct Subclasses

org.bouncycastle.pqc.legacy.crypto.ntru.NTRUSigningKeyPairGenerator.FGBasis

A NtruSign basis. Contains three polynomials f, f', h.

Field Summary

Modifier and Type	Field and Description
public Polynomial	f
public Polynomial	fPrime
public IntegerPolynomial	h
pack-priv NTRUSigningKeyGenerationParameters	params

Constructor Summary

Access	Constructor and Description
protected	Basis(Polynomial f, Polynomial fPrime, IntegerPolynomial h, NTRUSigningKeyGenerationParameters NtruSign parameters params) Constructs a new basis from polynomials `f, f', h`.
pack-priv	Basis(InputStream an input stream is, NTRUSigningKeyGenerationParameters NtruSign parameters params, boolean whether to read the polynomial `h` (`true`) or only `f` and `f'` (`false`) include_h) Reads a basis from an input stream and constructs a new basis.

Method Summary

Modifier and Type	Method and Description
pack-priv void	encode(OutputStream an output stream os, boolean whether to write the polynomial `h` (`true`) or only `f` and `f'` (`false`) include_h) Writes the basis to an output stream
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
private byte[]	getEncoded(Polynomial p)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.

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

Field Detail

f	back to summary
public Polynomial f

fPrime	back to summary
public Polynomial fPrime

h	back to summary
public IntegerPolynomial h

params	back to summary
pack-priv NTRUSigningKeyGenerationParameters params

Constructor Detail

Basis back to summary

Basis	back to summary
protected Basis(Polynomial f, Polynomial fPrime, IntegerPolynomial h, NTRUSigningKeyGenerationParameters params) Constructs a new basis from polynomials `f, f', h`. Parameters params:NTRUSigningKeyGenerationParameters NtruSign parameters

protected Basis(Polynomial f, Polynomial fPrime, IntegerPolynomial h, NTRUSigningKeyGenerationParameters params)

Constructs a new basis from polynomials f, f', h.

Parameters

params:NTRUSigningKeyGenerationParameters: NtruSign parameters

Basis back to summary

Basis	back to summary
pack-priv Basis(InputStream is, NTRUSigningKeyGenerationParameters params, boolean include_h) throws IOException Reads a basis from an input stream and constructs a new basis. Parameters is:InputStream an input stream params:NTRUSigningKeyGenerationParameters NtruSign parameters include_h:boolean whether to read the polynomial `h` (`true`) or only `f` and `f'` (`false`)

pack-priv Basis(InputStream is, NTRUSigningKeyGenerationParameters params, boolean include_h) throws IOException

Reads a basis from an input stream and constructs a new basis.

Parameters

is:InputStream: an input stream
params:NTRUSigningKeyGenerationParameters: NtruSign parameters
include_h:boolean: whether to read the polynomial h (true) or only f and f' (false)

Method Detail

encode back to summary

encode	back to summary
pack-priv void encode(OutputStream os, boolean include_h) throws IOException Writes the basis to an output stream Parameters os:OutputStream an output stream include_h:boolean whether to write the polynomial `h` (`true`) or only `f` and `f'` (`false`)

pack-priv void encode(OutputStream os, boolean include_h) throws IOException

Writes the basis to an output stream

Parameters

os:OutputStream: an output stream
include_h:boolean: whether to write the polynomial h (true) or only f and f' (false)

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getEncoded	back to summary
private byte[] getEncoded(Polynomial p)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

public Class NTRUSigningPrivateKeyParameters

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class NTRUSigningPrivateKeyParameters.Basis

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail