KeyAgreement Class

Reference

Definition

Namespace:: Javax.Crypto

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This class provides the functionality of a key agreement (or key exchange) protocol.

[Android.Runtime.Register("javax/crypto/KeyAgreement", DoNotGenerateAcw=true)]
public class KeyAgreement : Java.Lang.Object

[<Android.Runtime.Register("javax/crypto/KeyAgreement", DoNotGenerateAcw=true)>]
type KeyAgreement = class
    inherit Object

Inheritance: Object

Object
KeyAgreement

Attributes: RegisterAttribute

Remarks

This class provides the functionality of a key agreement (or key exchange) protocol.

The keys involved in establishing a shared secret are created by one of the key generators (KeyPairGenerator or KeyGenerator), a KeyFactory, or as a result from an intermediate phase of the key agreement protocol.

For each of the correspondents in the key exchange, doPhase needs to be called. For example, if this key exchange is with one other party, doPhase needs to be called once, with the lastPhase flag set to true. If this key exchange is with two other parties, doPhase needs to be called twice, the first time setting the lastPhase flag to false, and the second time setting it to true. There may be any number of parties involved in a key exchange.

Android provides the following KeyAgreement algorithms: <table> <thead> <tr> <th>Algorithm</th> <th>Supported API Levels</th> </tr> </thead> <tbody> <tr> <td>DH</td> <td>1+</td> </tr> <tr> <td>ECDH</td> <td>11+</td> </tr> </tbody> </table>

This algorithm is described in the KeyAgreement section of the Java Cryptography Architecture Standard Algorithm Name Documentation.

Added in 1.4.

Java documentation for javax.crypto.KeyAgreement.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

KeyAgreement(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.
KeyAgreement(KeyAgreementSpi, Provider, String)	Creates a KeyAgreement object.

Properties

Algorithm	Returns the algorithm name of this `KeyAgreement` object.
Class	Returns the runtime class of this `Object`. (Inherited from Object)
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PeerReference	(Inherited from Object)
Provider	Returns the provider of this `KeyAgreement` object.
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

Clone()	Creates and returns a copy of this object. (Inherited from Object)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
DoPhase(IKey, Boolean)	Executes the next phase of this key agreement with the given key that was received from one of the other parties involved in this key agreement.
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GenerateSecret()	Generates the shared secret and returns it in a new buffer.
GenerateSecret(Byte[], Int32)	Generates the shared secret, and places it into the buffer `sharedSecret`, beginning at `offset` inclusive.
GenerateSecret(String)	Creates the shared secret and returns it as a `SecretKey` object of the specified algorithm.
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
GetInstance(String, Provider)	Returns a `KeyAgreement` object that implements the specified key agreement algorithm.
GetInstance(String, String)	Returns a `KeyAgreement` object that implements the specified key agreement algorithm.
GetInstance(String)	Returns a `KeyAgreement` object that implements the specified key agreement algorithm.
Init(IKey, IAlgorithmParameterSpec, SecureRandom)	Initializes this key agreement with the given key, set of algorithm parameters, and source of randomness.
Init(IKey, IAlgorithmParameterSpec)	Initializes this key agreement with the given key and set of algorithm parameters.
Init(IKey, SecureRandom)	Initializes this key agreement with the given key and source of randomness.
Init(IKey)	Initializes this key agreement with the given key, which is required to contain all the algorithm parameters required for this key agreement.
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to

Share via