Bouncy Castle Cryptography Library 1.80 · org.bouncycastle.pqc.legacy.crypto.ntru.NTRUSigningParameters

Modifier and Type	Field and Description
public int	B
pack-priv double	beta
public double	betaSq
pack-priv int	bitsF
public int	d
public int	d1
public int	d2
public int	d3
public Digest	hashAlg
public int	N
pack-priv double	normBound
public double	normBoundSq
public int	q
public int	signFailTolerance

Constructor Summary

Access	Constructor and Description
public	NTRUSigningParameters(int number of polynomial coefficients N, int modulus q, int number of -1's in the private polynomials `f` and `g` d, int number of perturbations B, double balancing factor for the transpose lattice beta, double maximum norm for valid signatures normBound, Digest a valid identifier for a `java.security.MessageDigest` instance such as `SHA-256`. The `MessageDigest` must support the `getDigestLength()` method. hashAlg) Constructs a parameter set that uses ternary private keys (i.e. `polyType=SIMPLE`).
public	NTRUSigningParameters(int number of polynomial coefficients N, int modulus q, int number of -1's in the private polynomials `f` and `g` d1, int number of -1's in the private polynomials `f` and `g` d2, int number of -1's in the private polynomials `f` and `g` d3, int number of perturbations B, double balancing factor for the transpose lattice beta, double maximum norm for valid signatures normBound, double maximum norm for the ploynomials `F` and `G` keyNormBound, Digest a valid identifier for a `java.security.MessageDigest` instance such as `SHA-256`. The `MessageDigest` must support the `getDigestLength()` method. hashAlg) Constructs a parameter set that uses product-form private keys (i.e. `polyType=PRODUCT`).
public	NTRUSigningParameters(InputStream an input stream is) Reads a parameter set from an input stream.

Method Summary

Modifier and Type	Method and Description
public NTRUSigningParameters	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
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 int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private void	init()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	writeTo(OutputStream an output stream os) Writes the parameter set to an output stream

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

Field Detail

B	back to summary
public int B

beta	back to summary
pack-priv double beta

betaSq	back to summary
public double betaSq

bitsF	back to summary
pack-priv int bitsF

d	back to summary
public int d

d1	back to summary
public int d1

d2	back to summary
public int d2

d3	back to summary
public int d3

hashAlg	back to summary
public Digest hashAlg

N	back to summary
public int N

normBound	back to summary
pack-priv double normBound

normBoundSq	back to summary
public double normBoundSq

q	back to summary
public int q

signFailTolerance	back to summary
public int signFailTolerance

Constructor Detail

NTRUSigningParameters back to summary

NTRUSigningParameters	back to summary
public NTRUSigningParameters(int N, int q, int d, int B, double beta, double normBound, Digest hashAlg) Constructs a parameter set that uses ternary private keys (i.e. `polyType=SIMPLE`). Parameters N:int number of polynomial coefficients q:int modulus d:int number of -1's in the private polynomials `f` and `g` B:int number of perturbations beta:double balancing factor for the transpose lattice normBound:double maximum norm for valid signatures hashAlg:Digest a valid identifier for a `java.security.MessageDigest` instance such as `SHA-256`. The `MessageDigest` must support the `getDigestLength()` method.

public NTRUSigningParameters(int N, int q, int d, int B, double beta, double normBound, Digest hashAlg)

Constructs a parameter set that uses ternary private keys (i.e. polyType=SIMPLE).

Parameters

N:int: number of polynomial coefficients
q:int: modulus
d:int: number of -1's in the private polynomials f and g
B:int: number of perturbations
beta:double: balancing factor for the transpose lattice
normBound:double: maximum norm for valid signatures
hashAlg:Digest: a valid identifier for a java.security.MessageDigest instance such as SHA-256. The MessageDigest must support the getDigestLength() method.

NTRUSigningParameters back to summary

NTRUSigningParameters	back to summary
public NTRUSigningParameters(int N, int q, int d1, int d2, int d3, int B, double beta, double normBound, double keyNormBound, Digest hashAlg) Constructs a parameter set that uses product-form private keys (i.e. `polyType=PRODUCT`). Parameters N:int number of polynomial coefficients q:int modulus d1:int number of -1's in the private polynomials `f` and `g` d2:int number of -1's in the private polynomials `f` and `g` d3:int number of -1's in the private polynomials `f` and `g` B:int number of perturbations beta:double balancing factor for the transpose lattice normBound:double maximum norm for valid signatures keyNormBound:double maximum norm for the ploynomials `F` and `G` hashAlg:Digest a valid identifier for a `java.security.MessageDigest` instance such as `SHA-256`. The `MessageDigest` must support the `getDigestLength()` method.

public NTRUSigningParameters(int N, int q, int d1, int d2, int d3, int B, double beta, double normBound, double keyNormBound, Digest hashAlg)

Constructs a parameter set that uses product-form private keys (i.e. polyType=PRODUCT).

Parameters

N:int: number of polynomial coefficients
q:int: modulus
d1:int: number of -1's in the private polynomials f and g
d2:int: number of -1's in the private polynomials f and g
d3:int: number of -1's in the private polynomials f and g
B:int: number of perturbations
beta:double: balancing factor for the transpose lattice
normBound:double: maximum norm for valid signatures
keyNormBound:double: maximum norm for the ploynomials F and G
hashAlg:Digest: a valid identifier for a java.security.MessageDigest instance such as SHA-256. The MessageDigest must support the getDigestLength() method.

NTRUSigningParameters	back to summary
public NTRUSigningParameters(InputStream is) throws IOException Reads a parameter set from an input stream. Parameters is:InputStream an input stream

NTRUSigningParameters

back to summary

public NTRUSigningParameters(InputStream is) throws IOException

Reads a parameter set from an input stream.

Parameters

is:InputStream: an input stream

Method Detail

clone back to summary

clone	back to summary
public NTRUSigningParameters clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:NTRUSigningParameters a clone of this instance.

public NTRUSigningParameters clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:NTRUSigningParameters: a clone of this instance.

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.

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.

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

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

init	back to summary
private void init()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

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

writeTo

back to summary

public void writeTo(OutputStream os) throws IOException

Writes the parameter set to an output stream

Parameters

os:OutputStream: an output stream

public Class NTRUSigningParameters

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail