org.bouncycastle.pqc.jcajce.provider.mceliece

Class BCMcEliecePublicKey

java.lang.Object

org.bouncycastle.pqc.jcajce.provider.mceliece.BCMcEliecePublicKey

All Implemented Interfaces:

Serializable, Key, PublicKey, CipherParameters

public class BCMcEliecePublicKey
extends Object
implements CipherParameters, PublicKey

This class implements a McEliece public key and is usually instantiated by the McElieceKeyPairGenerator or McElieceKeyFactorySpi.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BCMcEliecePublicKey(McEliecePublicKeyParameters params)
BCMcEliecePublicKey(McEliecePublicKeySpec keySpec) Constructor (used by the McElieceKeyFactorySpi).
BCMcEliecePublicKey(String oid, int n, int t, GF2Matrix g) Constructor (used by the McElieceKeyPairGenerator).

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Compare this key with another object.
String	getAlgorithm() Return the name of the algorithm.
protected ASN1Primitive	getAlgParams()
byte[]	getEncoded() Return the keyData to encode in the SubjectPublicKeyInfo structure.
String	getFormat()
GF2Matrix	getG()
int	getK()
McElieceParameters	getMcElieceParameters()
int	getN()
protected ASN1ObjectIdentifier	getOID()
String	getOIDString()
int	getT()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BCMcEliecePublicKey

public BCMcEliecePublicKey(String oid,
                           int n,
                           int t,
                           GF2Matrix g)

Constructor (used by the McElieceKeyPairGenerator).

Parameters:

oid -

n - the length of the code

t - the error correction capability of the code

g - the generator matrix

BCMcEliecePublicKey

public BCMcEliecePublicKey(McEliecePublicKeySpec keySpec)

Constructor (used by the McElieceKeyFactorySpi).

Parameters:

keySpec - a McEliecePublicKeySpec

BCMcEliecePublicKey

public BCMcEliecePublicKey(McEliecePublicKeyParameters params)

Method Detail

getAlgorithm

public String getAlgorithm()

Return the name of the algorithm.

Specified by:

getAlgorithm in interface Key

Returns:

"McEliece"

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 error correction capability of the code

getG

public GF2Matrix getG()

Returns:

the generator matrix

toString

public String toString()

Overrides:

toString in class Object

Returns:

a human readable form of the key

equals

public boolean equals(Object other)

Compare this key with another object.

Overrides:

equals in class Object

Parameters:

other - the other object

Returns:

the result of the comparison

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

the hash code of this key

getOIDString

public String getOIDString()

Returns:

the OID of the algorithm

getOID

protected ASN1ObjectIdentifier getOID()

Returns:

the OID to encode in the SubjectPublicKeyInfo structure

getAlgParams

protected ASN1Primitive getAlgParams()

Returns:

the algorithm parameters to encode in the SubjectPublicKeyInfo structure

getEncoded

public byte[] getEncoded()

Return the keyData to encode in the SubjectPublicKeyInfo structure.

The ASN.1 definition of the key structure is

       McEliecePublicKey ::= SEQUENCE {
         n           Integer      -- length of the code
         t           Integer      -- error correcting capability
         matrixG     OctetString  -- generator matrix as octet string
       }
 

Specified by:

getEncoded in interface Key

Returns:

the keyData to encode in the SubjectPublicKeyInfo structure

getFormat

public String getFormat()

Specified by:

getFormat in interface Key

getMcElieceParameters

public McElieceParameters getMcElieceParameters()