org.conscrypt

Class OpenSSLKey

java.lang.Object

org.conscrypt.OpenSSLKey

public class OpenSSLKey
extends Object

Constructor Summary

Constructors

Constructor and Description
OpenSSLKey(long ctx)
OpenSSLKey(long ctx, boolean wrapped)
OpenSSLKey(long ctx, OpenSSLEngine engine, String alias)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
static OpenSSLKey	fromECPrivateKeyForTLSStackOnly(PrivateKey key, ECParameterSpec ecParams) Gets an OpenSSLKey instance backed by the provided EC private key.
static OpenSSLKey	fromPrivateKey(PrivateKey key)
static OpenSSLKey	fromPrivateKeyForTLSStackOnly(PrivateKey privateKey, PublicKey publicKey) Gets an OpenSSLKey instance backed by the provided private key.
static OpenSSLKey	fromPrivateKeyPemInputStream(InputStream is) Parse a private key in PEM encoding from the provided input stream.
static OpenSSLKey	fromPublicKey(PublicKey key)
static OpenSSLKey	fromPublicKeyPemInputStream(InputStream is) Parse a public key in PEM encoding from the provided input stream.
String	getAlias()
NativeRef.EVP_PKEY	getNativeRef() Returns the EVP_PKEY context for use in JNI calls.
PrivateKey	getPrivateKey()
PublicKey	getPublicKey()
int	hashCode() Returns an integer hash code for this object.
boolean	isWrapped()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenSSLKey

public OpenSSLKey(long ctx)

OpenSSLKey

public OpenSSLKey(long ctx,
                  boolean wrapped)

OpenSSLKey

public OpenSSLKey(long ctx,
                  OpenSSLEngine engine,
                  String alias)

Method Detail

getNativeRef

public NativeRef.EVP_PKEY getNativeRef()

Returns the EVP_PKEY context for use in JNI calls.

getAlias

public String getAlias()

isWrapped

public boolean isWrapped()

fromPrivateKey

public static OpenSSLKey fromPrivateKey(PrivateKey key)
                                 throws InvalidKeyException

Throws:

InvalidKeyException

fromPrivateKeyPemInputStream

public static OpenSSLKey fromPrivateKeyPemInputStream(InputStream is)
                                               throws InvalidKeyException

Parse a private key in PEM encoding from the provided input stream.

Throws:

InvalidKeyException - if parsing fails

fromPrivateKeyForTLSStackOnly

public static OpenSSLKey fromPrivateKeyForTLSStackOnly(PrivateKey privateKey,
                                                       PublicKey publicKey)
                                                throws InvalidKeyException

Gets an OpenSSLKey instance backed by the provided private key. The resulting key is usable only by this provider's TLS/SSL stack.

Parameters:

privateKey - private key.

publicKey - corresponding public key or null if not available. Some opaque private keys cannot be used by the TLS/SSL stack without the public key.

Throws:

InvalidKeyException

fromECPrivateKeyForTLSStackOnly

public static OpenSSLKey fromECPrivateKeyForTLSStackOnly(PrivateKey key,
                                                         ECParameterSpec ecParams)
                                                  throws InvalidKeyException

Gets an OpenSSLKey instance backed by the provided EC private key. The resulting key is usable only by this provider's TLS/SSL stack.

Parameters:

key - private key.

ecParams - EC parameters null if not available. Some opaque private keys cannot be used by the TLS/SSL stack without the parameters because the private key itself might not expose the parameters.

Throws:

InvalidKeyException

fromPublicKey

public static OpenSSLKey fromPublicKey(PublicKey key)
                                throws InvalidKeyException

Throws:

InvalidKeyException

fromPublicKeyPemInputStream

public static OpenSSLKey fromPublicKeyPemInputStream(InputStream is)
                                              throws InvalidKeyException

Parse a public key in PEM encoding from the provided input stream.

Throws:

InvalidKeyException - if parsing fails

getPublicKey

public PublicKey getPublicKey()
                       throws NoSuchAlgorithmException

Throws:

NoSuchAlgorithmException

getPrivateKey

public PrivateKey getPrivateKey()
                         throws NoSuchAlgorithmException

Throws:

NoSuchAlgorithmException

equals

public boolean equals(Object o)

Description copied from class: Object

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and Object.hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Overrides:

equals in class Object

Parameters:

o - the object to compare this instance with.

Returns:

true if the specified object is equal to this Object; false otherwise.

See Also:

Object.hashCode()

hashCode

public int hashCode()

Description copied from class: Object

Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Overrides:

hashCode in class Object

Returns:

this object's hash code.

See Also:

Object.equals(java.lang.Object)