Bouncy Castle Provider (FIPS Distribution) 1.0.2.5 · org.bouncycastle.jcajce.AgreedKeyWithMacKey

Modifier and Type	Field and Description
private final AtomicBoolean	hasBeenDestroyed
private final AtomicBoolean	isZeroed
private String	macAlgorithm
private byte[]	macKey
private SecretKey	secretKey

Access	Constructor and Description
public	AgreedKeyWithMacKey(SecretKey the secret key that was arrived at. secretKey) Basic constructor, no MAC.
public	AgreedKeyWithMacKey(SecretKey the secret key that was arrived at. secretKey, String the MAC algorithm to use. macAlgorithm, byte[] the bytes representing the agreed MAC key. macKey) Constructor containing MAC details

Method Summary

Modifier and Type	Method and Description
public void	destroy() Overrides default javax.security.auth.Destroyable.destroy. Destroy this `Object`.
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	Returns: the secret key value. getAlgorithm() Implements java.security.Key.getAlgorithm. Return the algorithm for the agreed secret key.
public byte[]	Returns: the secret key encoding. getEncoded() Implements java.security.Key.getEncoded. Return the encoding of the agreed secret key.
public String	Returns: the secret key format. getFormat() Implements java.security.Key.getFormat. Return the format for the agreed secret key.
public ZeroizableSecretKey	Returns: the MAC secret key (null otherwise). getMacKey() Return a key for the MAC associated with the KTS process (if available).
private byte[]	getMacKeyBytes()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isDestroyed() Overrides default javax.security.auth.Destroyable.isDestroyed. Determine if this `Object` has been destroyed.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

hasBeenDestroyed	back to summary
private final AtomicBoolean hasBeenDestroyed

isZeroed	back to summary
private final AtomicBoolean isZeroed

macAlgorithm	back to summary
private String macAlgorithm

macKey	back to summary
private byte[] macKey

secretKey	back to summary
private SecretKey secretKey

AgreedKeyWithMacKey	back to summary
public AgreedKeyWithMacKey(SecretKey secretKey) Basic constructor, no MAC. Parameters secretKey:SecretKey the secret key that was arrived at.

AgreedKeyWithMacKey	back to summary
public AgreedKeyWithMacKey(SecretKey secretKey, String macAlgorithm, byte[] macKey) Constructor containing MAC details Parameters secretKey:SecretKey the secret key that was arrived at. macAlgorithm:String the MAC algorithm to use. macKey:byte[] the bytes representing the agreed MAC key.

Method Detail

destroy back to summary

destroy	back to summary
public void destroy() Overrides default javax.security.auth.Destroyable.destroy. Doc from javax.security.auth.Destroyable.destroy. Destroy this `Object`. Sensitive information associated with this `Object` is destroyed or cleared. Subsequent calls to certain methods on this `Object` will result in an `IllegalStateException` being thrown.

public void destroy()

Overrides default javax.security.auth.Destroyable.destroy.

Doc from javax.security.auth.Destroyable.destroy.

Destroy this Object.

Sensitive information associated with this Object is destroyed or cleared. Subsequent calls to certain methods on this Object will result in an IllegalStateException being thrown.

equals back to summary

equals	back 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.

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.

getAlgorithm	back to summary
public String getAlgorithm() Implements java.security.Key.getAlgorithm. Return the algorithm for the agreed secret key. Returns:String the secret key value.

getAlgorithm

back to summary

public String getAlgorithm()

Implements java.security.Key.getAlgorithm.

Return the algorithm for the agreed secret key.

Returns:String: the secret key value.

getEncoded	back to summary
public byte[] getEncoded() Implements java.security.Key.getEncoded. Return the encoding of the agreed secret key. Returns:byte[] the secret key encoding.

getEncoded

back to summary

public byte[] getEncoded()

Implements java.security.Key.getEncoded.

Return the encoding of the agreed secret key.

Returns:byte[]: the secret key encoding.

getFormat	back to summary
public String getFormat() Implements java.security.Key.getFormat. Return the format for the agreed secret key. Returns:String the secret key format.

getFormat

back to summary

public String getFormat()

Implements java.security.Key.getFormat.

Return the format for the agreed secret key.

Returns:String: the secret key format.

getMacKey	back to summary
public ZeroizableSecretKey getMacKey() Return a key for the MAC associated with the KTS process (if available). Returns:ZeroizableSecretKey the MAC secret key (null otherwise).

getMacKey

back to summary

public ZeroizableSecretKey getMacKey()

Return a key for the MAC associated with the KTS process (if available).

Returns:ZeroizableSecretKey: the MAC secret key (null otherwise).

getMacKeyBytes	back to summary
private byte[] getMacKeyBytes()

hashCode back to summary

hashCode	back 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

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

isDestroyed back to summary

isDestroyed	back to summary
public boolean isDestroyed() Overrides default javax.security.auth.Destroyable.isDestroyed. Doc from javax.security.auth.Destroyable.isDestroyed. Determine if this `Object` has been destroyed. Returns:boolean true if this `Object` has been destroyed, false otherwise.

public boolean isDestroyed()

Overrides default javax.security.auth.Destroyable.isDestroyed.

Doc from javax.security.auth.Destroyable.isDestroyed.

Determine if this Object has been destroyed.

Returns:boolean: true if this Object has been destroyed, false otherwise.

public final Class AgreedKeyWithMacKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail