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

public Class NTRUSigningPublicKeyParameters

extends AsymmetricKeyParameter
Class Inheritance
Imports
java.io.IOException, .InputStream, .OutputStream, org.bouncycastle.crypto.params.AsymmetricKeyParameter, org.bouncycastle.pqc.legacy.math.ntru.polynomial.IntegerPolynomial

A NtruSign public key is essentially a polynomial named h.

Field Summary

Modifier and TypeField and Description
public IntegerPolynomial
h

private NTRUSigningParameters

Constructor Summary

AccessConstructor and Description
public
NTRUSigningPublicKeyParameters(IntegerPolynomial
the polynomial h which determines the key
h
,
NTRUSigningParameters
the NtruSign parameters to use
params
)

Constructs a new public key from a polynomial

public
NTRUSigningPublicKeyParameters(byte[]
an encoded polynomial
b
,
NTRUSigningParameters
the NtruSign parameters to use
params
)

Converts a byte array to a polynomial h and constructs a new public key

public
NTRUSigningPublicKeyParameters(InputStream
an input stream
is
,
NTRUSigningParameters
the NtruSign parameters to use
params
)

Reads a polynomial h from an input stream and constructs a new public 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.
public void
writeTo(OutputStream
an output stream
os
)

Writes the key to an output stream

Inherited from org.bouncycastle.crypto.params.AsymmetricKeyParameter:
isPrivate

Field Detail

hback to summary
public IntegerPolynomial h
paramsback to summary
private NTRUSigningParameters params

Constructor Detail

NTRUSigningPublicKeyParametersback to summary
public NTRUSigningPublicKeyParameters(IntegerPolynomial h, NTRUSigningParameters params)

Constructs a new public key from a polynomial

Parameters
h:IntegerPolynomial

the polynomial h which determines the key

params:NTRUSigningParameters

the NtruSign parameters to use

NTRUSigningPublicKeyParametersback to summary
public NTRUSigningPublicKeyParameters(byte[] b, NTRUSigningParameters params)

Converts a byte array to a polynomial h and constructs a new public key

Parameters
b:byte[]

an encoded polynomial

params:NTRUSigningParameters

the NtruSign parameters to use

NTRUSigningPublicKeyParametersback to summary
public NTRUSigningPublicKeyParameters(InputStream is, NTRUSigningParameters params) throws IOException

Reads a polynomial h from an input stream and constructs a new public key

Parameters
is:InputStream

an input stream

params:NTRUSigningParameters

the NtruSign parameters to use

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.

Annotations
@Override
getEncodedback to summary
public byte[] getEncoded()

Converts the key to a byte array

Returns:byte[]

the encoded key

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.

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

Writes the key to an output stream

Parameters
os:OutputStream

an output stream