iaik.security.pq.kyber

Class KyberPrivateKey

java.lang.Object

iaik.pkcs.pkcs8.PrivateKeyInfo

iaik.security.pq.kyber.KyberPrivateKey

All Implemented Interfaces:

iaik.asn1.ASN1Type, Serializable, Cloneable, Key, PrivateKey, Destroyable

public class KyberPrivateKey
extends iaik.pkcs.pkcs8.PrivateKeyInfo

This class holds a Kyber [0] Private Key. Is being updated according to FIPS 203 Draft [1]. [0] Roberto Avanzi, Joppe Bos, Léo Ducas, Eike Kiltz, Tancrède Lepoint, Vadim Lyubashevsky, John M. Schanck, Peter Schwabe, Gregor Seiler, and Damien Stehlé: "CRYSTALS-Kyber (version 3.02)" – Submission to round 3 of the NIST post-quantum project. [1] @see NIST.FIPS.203

See Also:

Serialized Form

Field Summary

Fields inherited from class iaik.pkcs.pkcs8.PrivateKeyInfo

private_key_algorithm

Constructor Summary

Constructors

Constructor and Description
KyberPrivateKey(byte[] encoded) Create private key from an ASN.1 encoded byte sequence
KyberPrivateKey(byte[] byteDk, byte[] byteEk, byte[] byteHashedEk, byte[] z, KyberParameterSpec parameterSpec) Create private key from private key byte array, public key byte array, public key hash and seed z
KyberPrivateKey(byte[] byteDk, byte[] byteHashedEk, byte[] z, KyberParameterSpec parameterSpec) Create private key from private key byte array, public key hash and seed z
KyberPrivateKey(byte[] byteRawEncoded, KyberParameterSpec parameterSpec) Create private key from raw byte array only, which contains the private key, optionally the public key, the hash of the public key and the seed

Method Summary

Modifier and Type	Method and Description
protected void	decode(byte[] bytes)
protected byte[]	encode()
boolean	equals(Object o)
String	getAlgorithm()
protected byte[]	getRawEncoded() Returns the private key as a byte array (raw data).
int	hashCode()
String	toString()

Methods inherited from class iaik.pkcs.pkcs8.PrivateKeyInfo

clone, createPrivateKeyInfo, decode, getAlgorithmID, getAttributes, getEncoded, getFormat, getPrivateKey, getPrivateKey, getPrivateKey, getPrivateKey, getPrivateKey, getPrivateKey, getPubKey, setAttributes, setPubKey, toASN1Object, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.security.auth.Destroyable

destroy, isDestroyed

Constructor Detail

KyberPrivateKey

public KyberPrivateKey(byte[] byteDk,
                       byte[] byteEk,
                       byte[] byteHashedEk,
                       byte[] z,
                       KyberParameterSpec parameterSpec)
                throws InvalidKeyException

Create private key from private key byte array, public key byte array, public key hash and seed z

Parameters:

byteDk - private key (KEM decaps key) as a byte sequence

byteEk - public key (KEM encaps key) as a byte sequence

byteHashedEk - public key hash

z - seed

parameterSpec - the given specification of the parameters

Throws:

InvalidKeyException - throws an error if failing to create the encoding of the private key

KyberPrivateKey

public KyberPrivateKey(byte[] byteDk,
                       byte[] byteHashedEk,
                       byte[] z,
                       KyberParameterSpec parameterSpec)
                throws InvalidKeyException

Create private key from private key byte array, public key hash and seed z

Parameters:

byteDk - private key (KEM decaps key) as a byte sequence

byteHashedEk - public key hash

z - seed

parameterSpec - the given specification of the parameters

Throws:

InvalidKeyException - throws an error if failing to create the encoding of the private key

KyberPrivateKey

public KyberPrivateKey(byte[] byteRawEncoded,
                       KyberParameterSpec parameterSpec)
                throws InvalidKeyException

Create private key from raw byte array only, which contains the private key, optionally the public key, the hash of the public key and the seed

Parameters:

byteRawEncoded - raw byte array which contains the private key, optionally the public key, the hash of the public key and the seed

parameterSpec - the given specification of the parameters

Throws:

InvalidKeyException - throws an error if failing to create the encoding of the private key

KyberPrivateKey

public KyberPrivateKey(byte[] encoded)
                throws InvalidKeyException

Create private key from an ASN.1 encoded byte sequence

Parameters:

encoded - private key encoded as ASN.1 byte sequence

Throws:

InvalidKeyException - if the encoding is not valid

Method Detail

getRawEncoded

protected byte[] getRawEncoded()

Returns the private key as a byte array (raw data).

Returns:

the key as byte array (byteDk||byteEk||byteHashedEk||z)

decode

protected void decode(byte[] bytes)
               throws InvalidKeyException

Specified by:

decode in class iaik.pkcs.pkcs8.PrivateKeyInfo

Throws:

InvalidKeyException

encode

protected byte[] encode()

Specified by:

encode in class iaik.pkcs.pkcs8.PrivateKeyInfo

getAlgorithm

public String getAlgorithm()

Specified by:

getAlgorithm in interface Key

Specified by:

getAlgorithm in class iaik.pkcs.pkcs8.PrivateKeyInfo

equals

public boolean equals(Object o)

Overrides:

equals in class iaik.pkcs.pkcs8.PrivateKeyInfo

hashCode

public int hashCode()

Overrides:

hashCode in class iaik.pkcs.pkcs8.PrivateKeyInfo

toString

public String toString()

Overrides:

toString in class iaik.pkcs.pkcs8.PrivateKeyInfo