Class CompositePrivateKey

java.lang.Object

org.bouncycastle.jcajce.CompositePrivateKey

All Implemented Interfaces:

Serializable, AsymmetricKey, DEREncodablePREVIEW, Key, PrivateKey, Destroyable

public class CompositePrivateKey
extends Object
implements PrivateKey

A composite private key class.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompositePrivateKey.Builder

Field Summary

Fields inherited from interface PrivateKey

serialVersionUID

Constructor Summary

Constructors

Constructor	Description
CompositePrivateKey(PrivateKey... keys)	Create a composite private key from an array of PublicKeys.
CompositePrivateKey(ASN1ObjectIdentifier algorithm, PrivateKey... keys)
CompositePrivateKey(PrivateKeyInfo keyInfo)	Create a composite private key from a PrivateKeyInfo.
CompositePrivateKey(AlgorithmIdentifier algorithmIdentifier, PrivateKey... keys)	Create a composite private key which corresponds to a composite signature algorithm in algorithmIdentifier.

Method Summary

Modifier and Type	Method	Description
static CompositePrivateKey.Builder	builder(String algorithmName)
static CompositePrivateKey.Builder	builder(ASN1ObjectIdentifier compAlgOid)
boolean	equals(Object o)
String	getAlgorithm()
AlgorithmIdentifier	getAlgorithmIdentifier()
byte[]	getEncoded()	Returns the encoding of the composite private key.
String	getFormat()
List<PrivateKey>	getPrivateKeys()	Return a list of the component private keys making up this composite.
List<Provider>	getProviders()	Return a list of the providers supporting the component private keys.
int	hashCode()

Methods inherited from class Object

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

Methods inherited from interface AsymmetricKey

getParams

Methods inherited from interface Destroyable

destroy, isDestroyed

Constructor Details

CompositePrivateKey

public CompositePrivateKey(PrivateKey... keys)

Create a composite private key from an array of PublicKeys. This constructor is currently used only for legacy composites implementation.

Parameters:

keys - The component private keys.

CompositePrivateKey

public CompositePrivateKey(ASN1ObjectIdentifier algorithm,
 PrivateKey... keys)

CompositePrivateKey

public CompositePrivateKey(AlgorithmIdentifier algorithmIdentifier,
 PrivateKey... keys)

Create a composite private key which corresponds to a composite signature algorithm in algorithmIdentifier. The component private keys are not checked if they satisfy the composite definition at this point, however, they will fail when they are fed into component algorithms which are defined by the algorithmIdentifier.

Parameters:

algorithmIdentifier -

keys -

CompositePrivateKey

public CompositePrivateKey(PrivateKeyInfo keyInfo)

Create a composite private key from a PrivateKeyInfo.

Parameters:

keyInfo - PrivateKeyInfo object containing a composite private key.

Method Details

builder

public static CompositePrivateKey.Builder builder(ASN1ObjectIdentifier compAlgOid)

builder

public static CompositePrivateKey.Builder builder(String algorithmName)

getPrivateKeys

public List<PrivateKey> getPrivateKeys()

Return a list of the component private keys making up this composite.

Returns:

an immutable list of private keys.

getProviders

public List<Provider> getProviders()

Return a list of the providers supporting the component private keys.

Returns:

an immutable list of Provider objects.

getAlgorithm

public String getAlgorithm()

Specified by:

getAlgorithm in interface Key

getAlgorithmIdentifier

public AlgorithmIdentifier getAlgorithmIdentifier()

getFormat

public String getFormat()

Specified by:

getFormat in interface Key

getEncoded

public byte[] getEncoded()

Returns the encoding of the composite private key. It is compliant with Composite ML-DSA for use in X.509 Public Key Infrastructure as each component is encoded as a PrivateKeyInfo (older name for OneAsymmetricKey).

Specified by:

getEncoded in interface Key

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object