KeyFactory Class

Definition

Namespace:

Java.Security

Assembly:

Mono.Android.dll

Key factories are used to convert keys (opaque cryptographic keys of type Key) into key specifications (transparent representations of the underlying key material), and vice versa.

[Android.Runtime.Register("java/security/KeyFactory", DoNotGenerateAcw=true)]
public class KeyFactory : Java.Lang.Object

[<Android.Runtime.Register("java/security/KeyFactory", DoNotGenerateAcw=true)>]
type KeyFactory = class
    inherit Object

Inheritance

Object

Object

KeyFactory

Attributes

RegisterAttribute

Remarks

Key factories are used to convert keys (opaque cryptographic keys of type Key) into key specifications (transparent representations of the underlying key material), and vice versa.

Key factories are bi-directional. That is, they allow you to build an opaque key object from a given key specification (key material), or to retrieve the underlying key material of a key object in a suitable format.

Multiple compatible key specifications may exist for the same key. For example, a DSA public key may be specified using DSAPublicKeySpec or X509EncodedKeySpec. A key factory can be used to translate between compatible key specifications.

The following is an example of how to use a key factory in order to instantiate a DSA public key from its encoding. Assume Alice has received a digital signature from Bob. Bob also sent her his public key (in encoded format) to verify his signature. Alice then performs the following actions:

X509EncodedKeySpec bobPubKeySpec = new X509EncodedKeySpec(bobEncodedPubKey);
            KeyFactory keyFactory = KeyFactory.getInstance("DSA");
            PublicKey bobPubKey = keyFactory.generatePublic(bobPubKeySpec);
            Signature sig = Signature.getInstance("DSA");
            sig.initVerify(bobPubKey);
            sig.update(data);
            sig.verify(signature);

Android provides the following KeyFactory 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>DSA</td> <td>1+</td> </tr> <tr> <td>EC</td> <td>11+</td> </tr> <tr> <td>RSA</td> <td>1+</td> </tr> <tr class="deprecated"> <td>X.509</td> <td>1-8</td> </tr> </tbody> </table>

Added in 1.2.

Java documentation for java.security.KeyFactory.

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

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

Properties

Algorithm	Gets the name of the algorithm associated with this KeyFactory.
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 key factory 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)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GeneratePrivate(IKeySpec)	Generates a private key object from the provided key specification (key material).
GeneratePublic(IKeySpec)	Generates a public key object from the provided key specification (key material).
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
GetInstance(String, Provider)	Returns a KeyFactory object that converts public/private keys of the specified algorithm.
GetInstance(String, String)	Returns a KeyFactory object that converts public/private keys of the specified algorithm.
GetInstance(String)	Returns a KeyFactory object that converts public/private keys of the specified algorithm.
GetKeySpec(IKey, Class)	Returns a specification (key material) of the given key object.
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)
TranslateKey(IKey)	Translates a key object, whose provider may be unknown or potentially untrusted, into a corresponding key object of this key factory.
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)