Top Description Fields Constructors Methods
org.bouncycastle.pqc.legacy.crypto.ntru

public Class NTRUEncryptionPrivateKeyParameters

extends NTRUEncryptionKeyParameters
Class Inheritance
Imports
java.io.ByteArrayInputStream, .IOException, .InputStream, .OutputStream, org.bouncycastle.pqc.legacy.math.ntru.polynomial.DenseTernaryPolynomial, .IntegerPolynomial, .Polynomial, .ProductFormPolynomial, .SparseTernaryPolynomial
A NtruEncrypt private key is essentially a polynomial named f which takes different forms depending on whether product-form polynomials are used, and on fastP
The inverse of f modulo p is precomputed on initialization.

Field Summary

Modifier and TypeField and Description
public IntegerPolynomial
fp

public IntegerPolynomial
h

public Polynomial
t

Inherited from org.bouncycastle.pqc.legacy.crypto.ntru.NTRUEncryptionKeyParameters:
params

Constructor Summary

AccessConstructor and Description
public
NTRUEncryptionPrivateKeyParameters(IntegerPolynomial
the public polynomial for the key.
h, Polynomial
the polynomial which determines the key: if fastFp=true, f=1+3t; otherwise, f=t
t, IntegerPolynomial
the inverse of f
fp, NTRUEncryptionParameters
the NtruEncrypt parameters to use
params)

Constructs a new private key from a polynomial

public
NTRUEncryptionPrivateKeyParameters(byte[]
an encoded polynomial
b, NTRUEncryptionParameters
the NtruEncrypt parameters to use
params)

Converts a byte array to a polynomial f and constructs a new private key

public
NTRUEncryptionPrivateKeyParameters(InputStream
an input stream
is, NTRUEncryptionParameters
the NtruEncrypt parameters to use
params)

Reads a polynomial f from an input stream and constructs a new private key

Method Summary

Modifier and TypeMethod and Description
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 byte[]

Returns:

the encoded key
getEncoded()

Converts the key to a byte array

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
private void
init()

Initializes fp from t.

public void
writeTo(OutputStream
an output stream
os)

Writes the key to an output stream

Inherited from org.bouncycastle.pqc.legacy.crypto.ntru.NTRUEncryptionKeyParameters:
getParameters

Field Detail

fpback to summary
public IntegerPolynomial fp
hback to summary
public IntegerPolynomial h
tback to summary
public Polynomial t

Constructor Detail

NTRUEncryptionPrivateKeyParametersback to summary
public NTRUEncryptionPrivateKeyParameters(IntegerPolynomial h, Polynomial t, IntegerPolynomial fp, NTRUEncryptionParameters params)

Constructs a new private key from a polynomial

Parameters
h:IntegerPolynomial

the public polynomial for the key.

t:Polynomial

the polynomial which determines the key: if fastFp=true, f=1+3t; otherwise, f=t

fp:IntegerPolynomial

the inverse of f

params:NTRUEncryptionParameters

the NtruEncrypt parameters to use

NTRUEncryptionPrivateKeyParametersback to summary
public NTRUEncryptionPrivateKeyParameters(byte[] b, NTRUEncryptionParameters params) throws IOException

Converts a byte array to a polynomial f and constructs a new private key

Parameters
b:byte[]

an encoded polynomial

params:NTRUEncryptionParameters

the NtruEncrypt parameters to use

See Also
getEncoded()
NTRUEncryptionPrivateKeyParametersback to summary
public NTRUEncryptionPrivateKeyParameters(InputStream is, NTRUEncryptionParameters params) throws IOException

Reads a polynomial f from an input stream and constructs a new private key

Parameters
is:InputStream

an input stream

params:NTRUEncryptionParameters

the NtruEncrypt parameters to use

See Also
writeTo(OutputStream)

Method Detail

equalsback 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.

getEncodedback to summary
public byte[] getEncoded()

Converts the key to a byte array

Returns:byte[]

the encoded key

See Also
NTRUEncryptionPrivateKeyParameters(byte[], NTRUEncryptionParameters)
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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.

initback to summary
private void init()

Initializes fp from t.

writeToback to summary
public void writeTo(OutputStream os) throws IOException

Writes the key to an output stream

Parameters
os:OutputStream

an output stream

See Also
NTRUEncryptionPrivateKeyParameters(InputStream, NTRUEncryptionParameters)