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

public Class BCFalconPrivateKey

extends Object
implements FalconPrivateKey
Class Inheritance
All Implemented Interfaces
org.bouncycastle.pqc.jcajce.interfaces.FalconPrivateKey, org.bouncycastle.pqc.jcajce.interfaces.FalconKey, java.security.Key, java.io.Serializable, java.security.PrivateKey, javax.security.auth.Destroyable
Imports
java.io.IOException, .ObjectInputStream, .ObjectOutputStream, org.bouncycastle.asn1.ASN1Set, org.bouncycastle.asn1.pkcs.PrivateKeyInfo, org.bouncycastle.pqc.crypto.crystals.dilithium.DilithiumPrivateKeyParameters, org.bouncycastle.pqc.crypto.falcon.FalconPrivateKeyParameters, .FalconPublicKeyParameters, org.bouncycastle.pqc.crypto.util.PrivateKeyFactory, .PrivateKeyInfoFactory, org.bouncycastle.pqc.jcajce.interfaces.FalconPrivateKey, .FalconPublicKey, org.bouncycastle.pqc.jcajce.provider.util.KeyUtil, org.bouncycastle.pqc.jcajce.spec.FalconParameterSpec, org.bouncycastle.util.Arrays, .Strings

Field Summary

Modifier and TypeField and Description
private transient String
algorithm

private transient ASN1Set
attributes

private transient byte[]
encoding

private transient FalconPrivateKeyParameters
params

private static final long
serialVersionUID

Hides java.security.PrivateKey.serialVersionUID, java.security.Key.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
BCFalconPrivateKey(FalconPrivateKeyParameters params)

public
BCFalconPrivateKey(PrivateKeyInfo keyInfo)

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

the result of the comparison
equals(Object
the other object
o)

Overrides java.lang.Object.equals.

Compare this Falcon private key with another object.
public final String

Returns:

name of the algorithm - "FALCON-512 or FALCON-1024"
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 FalconPrivateKeyParameters
getKeyParams()

public FalconParameterSpec
getParameterSpec()

Implements org.bouncycastle.pqc.jcajce.interfaces.FalconKey.getParameterSpec.

Return the parameters for this key.
public FalconPublicKey
getPublicKey()

Implements org.bouncycastle.pqc.jcajce.interfaces.FalconPrivateKey.getPublicKey.

Return the public key corresponding to this private key.
public int
hashCode()

Overrides java.lang.Object.hashCode.

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

private void
init(FalconPrivateKeyParameters params, ASN1Set attributes)

private void
readObject(ObjectInputStream in)

private void
writeObject(ObjectOutputStream out)

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

algorithmback to summary
private transient String algorithm
attributesback to summary
private transient ASN1Set attributes
encodingback to summary
private transient byte[] encoding
paramsback to summary
private transient FalconPrivateKeyParameters params
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.security.PrivateKey.serialVersionUID, java.security.Key.serialVersionUID.

Constructor Detail

BCFalconPrivateKeyback to summary
public BCFalconPrivateKey(FalconPrivateKeyParameters params)
BCFalconPrivateKeyback to summary
public BCFalconPrivateKey(PrivateKeyInfo keyInfo) throws IOException

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Compare this Falcon private key with another object.

Parameters
o:Object

the other object

Returns:boolean

the result of the comparison

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 - "FALCON-512 or FALCON-1024"

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 FalconPrivateKeyParameters getKeyParams()
getParameterSpecback to summary
public FalconParameterSpec getParameterSpec()

Implements org.bouncycastle.pqc.jcajce.interfaces.FalconKey.getParameterSpec.

Doc from org.bouncycastle.pqc.jcajce.interfaces.FalconKey.getParameterSpec.

Return the parameters for this key.

Returns:FalconParameterSpec

a FalconParameterSpec

getPublicKeyback to summary
public FalconPublicKey getPublicKey()

Implements org.bouncycastle.pqc.jcajce.interfaces.FalconPrivateKey.getPublicKey.

Doc from org.bouncycastle.pqc.jcajce.interfaces.FalconPrivateKey.getPublicKey.

Return the public key corresponding to this private key.

Returns:FalconPublicKey

a Falcon Public 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.

initback to summary
private void init(PrivateKeyInfo keyInfo) throws IOException
initback to summary
private void init(FalconPrivateKeyParameters params, ASN1Set attributes)
readObjectback to summary
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
writeObjectback to summary
private void writeObject(ObjectOutputStream out) throws IOException