org.spongycastle.pqc.jcajce.provider.mceliece

Class BCMcElieceCCA2PrivateKey

java.lang.Object

org.spongycastle.pqc.jcajce.provider.mceliece.BCMcElieceCCA2PrivateKey

All Implemented Interfaces:

java.io.Serializable, java.security.Key, java.security.PrivateKey, javax.security.auth.Destroyable

public class BCMcElieceCCA2PrivateKey
extends java.lang.Object
implements java.security.PrivateKey

This class implements a McEliece CCA2 private key and is usually instantiated by the McElieceCCA2KeyPairGenerator or McElieceCCA2KeyFactorySpi.

See Also:

McElieceCCA2KeyPairGenerator, Serialized Form

Constructor Summary

Constructors

Constructor and Description
BCMcElieceCCA2PrivateKey(org.spongycastle.pqc.crypto.mceliece.McElieceCCA2PrivateKeyParameters params)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other) Compare this key with another object.
java.lang.String	getAlgorithm() Return the name of the algorithm.
byte[]	getEncoded() Return the keyData to encode in the SubjectPublicKeyInfo structure.
org.spongycastle.pqc.math.linearalgebra.GF2mField	getField()
java.lang.String	getFormat()
org.spongycastle.pqc.math.linearalgebra.PolynomialGF2mSmallM	getGoppaPoly()
org.spongycastle.pqc.math.linearalgebra.GF2Matrix	getH()
int	getK()
int	getN()
org.spongycastle.pqc.math.linearalgebra.Permutation	getP()
org.spongycastle.pqc.math.linearalgebra.PolynomialGF2mSmallM[]	getQInv()
int	getT()
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.security.auth.Destroyable

destroy, isDestroyed

Constructor Detail

BCMcElieceCCA2PrivateKey

public BCMcElieceCCA2PrivateKey(org.spongycastle.pqc.crypto.mceliece.McElieceCCA2PrivateKeyParameters params)

Method Detail

getAlgorithm

public java.lang.String getAlgorithm()

Return the name of the algorithm.

Specified by:

getAlgorithm in interface java.security.Key

Returns:

"McEliece-CCA2"

getN

public int getN()

Returns:

the length of the code

getK

public int getK()

Returns:

the dimension of the code

getT

public int getT()

Returns:

the degree of the Goppa polynomial (error correcting capability)

getField

public org.spongycastle.pqc.math.linearalgebra.GF2mField getField()

Returns:

the finite field

getGoppaPoly

public org.spongycastle.pqc.math.linearalgebra.PolynomialGF2mSmallM getGoppaPoly()

Returns:

the irreducible Goppa polynomial

getP

public org.spongycastle.pqc.math.linearalgebra.Permutation getP()

Returns:

the permutation vector

getH

public org.spongycastle.pqc.math.linearalgebra.GF2Matrix getH()

Returns:

the canonical check matrix

getQInv

public org.spongycastle.pqc.math.linearalgebra.PolynomialGF2mSmallM[] getQInv()

Returns:

the matrix used to compute square roots in (GF(2^m))^t

equals

public boolean equals(java.lang.Object other)

Compare this key with another object.

Overrides:

equals in class java.lang.Object

Parameters:

other - the other object

Returns:

the result of the comparison

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code of this key

getEncoded

public byte[] getEncoded()

Return the keyData to encode in the SubjectPublicKeyInfo structure.

The ASN.1 definition of the key structure is

   McEliecePrivateKey ::= SEQUENCE {
     m             INTEGER                  -- extension degree of the field
     k             INTEGER                  -- dimension of the code
     field         OCTET STRING             -- field polynomial
     goppaPoly     OCTET STRING             -- irreducible Goppa polynomial
     p             OCTET STRING             -- permutation vector
     matrixH       OCTET STRING             -- canonical check matrix
     sqRootMatrix  SEQUENCE OF OCTET STRING -- square root matrix
   }
 

Specified by:

getEncoded in interface java.security.Key

Returns:

the keyData to encode in the SubjectPublicKeyInfo structure

getFormat

public java.lang.String getFormat()

Specified by:

getFormat in interface java.security.Key