Package org.bouncycastle.jcajce

Class KTSKeyWithEncapsulation

java.lang.Object
org.bouncycastle.jcajce.KTSKeyWithEncapsulation
All Implemented Interfaces:
Serializable, Key, SecretKey, Destroyable
public final class KTSKeyWithEncapsulation extends Object implements SecretKey
Carrier class for a KTS secret key plus its encapsulation, as well as details about the MAC key if provided.
See Also:

  • Constructor Details

    • KTSKeyWithEncapsulation

      public KTSKeyWithEncapsulation(SecretKey secretKey, byte[] encapsulation)
      Basic constructor.
      Parameters:
      secretKey - the secret key that was arrived at.
      encapsulation - the encapsulation the key data was carried in.

  • Method Details

    • getAlgorithm

      public String getAlgorithm()
      Return the algorithm for the agreed secret key.
      Specified by:
      getAlgorithm in interface Key
      Returns:
      the secret key value.

    • getFormat

      public String getFormat()
      Return the format for the agreed secret key.
      Specified by:
      getFormat in interface Key
      Returns:
      the secret key format.

    • getEncoded

      public byte[] getEncoded()
      Return the encoding of the agreed secret key.
      Specified by:
      getEncoded in interface Key
      Returns:
      the secret key encoding.

    • getEncapsulation

      public byte[] getEncapsulation()
      Return the encapsulation that carried the key material used in creating the agreed secret key.
      Returns:
      the encrypted encapsulation of the agreed secret key.

    • getMacKey

      public ZeroizableSecretKey getMacKey()
      Return the mac key if there is one present.
      Returns:
      the associated MAC key for this KTS key (null if there isn't one).

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object