Top Description Fields Constructors Methods
org.bouncycastle.jcajce

public Class CompositePublicKey

extends Object
implements PublicKey
Class Inheritance
All Implemented Interfaces
java.security.PublicKey, java.security.AsymmetricKey, java.security.Key, java.io.Serializable
Imports
java.io.IOException, java.security.PublicKey, java.util.ArrayList, .Collections, .List, org.bouncycastle.asn1.ASN1EncodableVector, .ASN1Encoding, .ASN1ObjectIdentifier, .DERSequence, org.bouncycastle.asn1.x509.AlgorithmIdentifier, .SubjectPublicKeyInfo, org.bouncycastle.internal.asn1.misc.MiscObjectIdentifiers, org.bouncycastle.jcajce.provider.asymmetric.compositesignatures.CompositeIndex, .KeyFactorySpi, org.bouncycastle.jcajce.provider.util.AsymmetricKeyInfoConverter

A composite key class.

Field Summary

Modifier and TypeField and Description
private final ASN1ObjectIdentifier
private final List<PublicKey>

Constructor Summary

AccessConstructor and Description
public
CompositePublicKey(PublicKey...
The component public keys.
keys
)

Create a composite public key from an array of PublicKeys.

public
CompositePublicKey(ASN1ObjectIdentifier algorithmIdentifier, PublicKey... keys)

Create a composite public key which corresponds to a composite signature algorithm in algorithmIdentifier.

public
CompositePublicKey(SubjectPublicKeyInfo
SubjectPublicKeyInfo object containing a composite public key.
keyInfo
)

Create a composite public key from a SubjectPublicKeyInfo.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public String
getAlgorithm()

Implements java.security.Key.getAlgorithm.

Returns the standard algorithm name for this key.

public ASN1ObjectIdentifier
public byte[]
getEncoded()

Implements java.security.Key.getEncoded.

Returns the composite public key encoded as a SubjectPublicKeyInfo.

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.

public List<PublicKey>

Returns:

an immutable list of public keys.
getPublicKeys
()

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

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

algorithmIdentifierback to summary
private final ASN1ObjectIdentifier algorithmIdentifier
keysback to summary
private final List<PublicKey> keys

Constructor Detail

CompositePublicKeyback to summary
public CompositePublicKey(PublicKey... keys)

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

Parameters
keys:PublicKey[]

The component public keys.

CompositePublicKeyback to summary
public CompositePublicKey(ASN1ObjectIdentifier algorithmIdentifier, PublicKey... keys)

Create a composite public key which corresponds to a composite signature algorithm in algorithmIdentifier. The component public 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.

CompositePublicKeyback to summary
public CompositePublicKey(SubjectPublicKeyInfo keyInfo)

Create a composite public key from a SubjectPublicKeyInfo.

Parameters
keyInfo:SubjectPublicKeyInfo

SubjectPublicKeyInfo object containing a composite public key.

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

getAlgorithmback to summary
public 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

the name of the algorithm associated with this key.

getAlgorithmIdentifierback to summary
public ASN1ObjectIdentifier getAlgorithmIdentifier()
getEncodedback to summary
public byte[] getEncoded()

Implements java.security.Key.getEncoded.

Returns the composite public key encoded as a SubjectPublicKeyInfo. If the composite public key is legacy (MiscObjectIdentifiers.id_composite_key), it each component public key is wrapped in its own SubjectPublicKeyInfo. Other composite public keys are encoded according to https://www.ietf.org/archive/id/draft-ounsworth-pq-composite-sigs-13.html#name-compositesignaturepublickey where each component public key is a BIT STRING which contains the result of calling getEncoded() for each component public key.

Annotations
@Override
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.

getPublicKeysback to summary
public List<PublicKey> getPublicKeys()

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

Returns:List<PublicKey>

an immutable list of public keys.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this 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