Top Fields Constructors Methods
org.bouncycastle.pqc.jcajce.provider.lms

public Class BCLMSPublicKey

extends Object
implements PublicKey, LMSKey
Class Inheritance
All Implemented Interfaces
org.bouncycastle.pqc.jcajce.interfaces.LMSKey, java.security.Key, java.io.Serializable, java.security.PublicKey, java.security.AsymmetricKey
Imports
java.io.IOException, .ObjectInputStream, .ObjectOutputStream, java.security.PublicKey, org.bouncycastle.asn1.x509.SubjectPublicKeyInfo, org.bouncycastle.crypto.CipherParameters, org.bouncycastle.pqc.crypto.lms.HSSPublicKeyParameters, .LMSKeyParameters, .LMSPublicKeyParameters, org.bouncycastle.pqc.crypto.util.PublicKeyFactory, .SubjectPublicKeyInfoFactory, org.bouncycastle.pqc.jcajce.interfaces.LMSKey, org.bouncycastle.util.Arrays, .Encodable

Field Summary

Modifier and TypeField and Description
private transient LMSKeyParameters
private static final long

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

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

public final String

Returns:

name of the algorithm - "LMS"
getAlgorithm
()

Implements java.security.Key.getAlgorithm.

Returns the standard algorithm name for this key.

public byte[]
getEncoded()

Implements java.security.Key.getEncoded.

Returns the key in its primary encoding format, or null if this key does not support encoding.

public String
getFormat()

Implements java.security.Key.getFormat.

Returns the name of the primary encoding format of this key, or null if this key does not support encoding.

pack-priv CipherParameters
public int
getLevels()

Implements org.bouncycastle.pqc.jcajce.interfaces.LMSKey.getLevels.

Return the number of levels (L) associated with the key.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

private void
private void
private void
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

keyParamsback to summary
private transient LMSKeyParameters keyParams
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.security.PublicKey.serialVersionUID, java.security.Key.serialVersionUID.

Constructor Detail

BCLMSPublicKeyback to summary
public BCLMSPublicKey(LMSKeyParameters keyParams)
BCLMSPublicKeyback to summary
public BCLMSPublicKey(SubjectPublicKeyInfo keyInfo) throws IOException

Method Detail

equalsback to summary
public boolean equals(Object o)

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
o:Object

the reference object with which to compare.

Returns:boolean

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

getAlgorithmback to summary
public final String getAlgorithm()

Implements java.security.Key.getAlgorithm.

Doc from java.security.Key.getAlgorithm.

Returns the standard algorithm name for this key. For example, "DSA" would indicate that this key is a DSA key. See the key related sections (KeyFactory, KeyGenerator, KeyPairGenerator, and SecretKeyFactory) in the Java Security Standard Algorithm Names Specification for information about standard key algorithm names.

Returns:String

name of the algorithm - "LMS"

getEncodedback to summary
public byte[] getEncoded()

Implements java.security.Key.getEncoded.

Doc from java.security.Key.getEncoded.

Returns the key in its primary encoding format, or null if this key does not support encoding.

Returns:byte[]

the encoded key, or null if the key does not support encoding.

getFormatback to summary
public String getFormat()

Implements java.security.Key.getFormat.

Doc from java.security.Key.getFormat.

Returns the name of the primary encoding format of this key, or null if this key does not support encoding. The primary encoding format is named in terms of the appropriate ASN.1 data format, if an ASN.1 specification for this key exists. For example, the name of the ASN.1 data format for public keys is SubjectPublicKeyInfo, as defined by the X.509 standard; in this case, the returned format is "X.509". Similarly, the name of the ASN.1 data format for private keys is PrivateKeyInfo, as defined by the PKCS #8 standard; in this case, the returned format is "PKCS#8".

Returns:String

the primary encoding format of the key.

getKeyParamsback to summary
pack-priv CipherParameters getKeyParams()
getLevelsback to summary
public int getLevels()

Implements org.bouncycastle.pqc.jcajce.interfaces.LMSKey.getLevels.

Doc from org.bouncycastle.pqc.jcajce.interfaces.LMSKey.getLevels.

Return the number of levels (L) associated with the key.

Returns:int

L.

hashCodeback 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

initback to summary
private void init(SubjectPublicKeyInfo keyInfo) throws IOException
readObjectback to summary
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
writeObjectback to summary
private void writeObject(ObjectOutputStream out) throws IOException