Class OpenSSLKey

java.lang.Object

org.conscrypt.OpenSSLKey

@Internal
public final class OpenSSLKey
extends Object

Represents a BoringSSL EVP_PKEY.

Field Summary

Fields

Modifier and Type	Field	Description
private final NativeRef.EVP_PKEY	ctx
private final boolean	hardwareBacked
private final boolean	wrapped

Constructor Summary

Constructors

Constructor	Description
OpenSSLKey(long ctx)
OpenSSLKey(long ctx, boolean wrapped)
OpenSSLKey(long ctx, boolean wrapped, boolean hardwareBacked)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
(package private) static OpenSSLKey	fromECPrivateKeyForTLSStackOnly(PrivateKey key, ECParameterSpec ecParams)	Gets an OpenSSLKey instance backed by the provided EC private key.
private static OpenSSLKey	fromKeyMaterial(PrivateKey key)	Gets an OpenSSLKey instance initialized with the key material of the provided key.
(package private) static OpenSSLKey	fromPrivateKey(PrivateKey key)
(package private) static OpenSSLKey	fromPrivateKeyForTLSStackOnly(PrivateKey privateKey, PublicKey publicKey)	Gets an OpenSSLKey instance backed by the provided private key.
(package private) static OpenSSLKey	fromPrivateKeyPemInputStream(InputStream is)	Parse a private key in PEM encoding from the provided input stream.
(package private) static OpenSSLKey	fromPublicKey(PublicKey key)
static OpenSSLKey	fromPublicKeyPemInputStream(InputStream is)	Parse a public key in PEM encoding from the provided input stream.
(package private) NativeRef.EVP_PKEY	getNativeRef()	Returns the EVP_PKEY context for use in JNI calls.
private static OpenSSLKey	getOpenSSLKey(PrivateKey key)	Gets the OpenSSLKey instance of the provided key.
(package private) PrivateKey	getPrivateKey()
(package private) static PrivateKey	getPrivateKey(PKCS8EncodedKeySpec keySpec, int type)
PublicKey	getPublicKey()
(package private) static PublicKey	getPublicKey(X509EncodedKeySpec keySpec, int type)
int	hashCode()
(package private) boolean	isHardwareBacked()
(package private) boolean	isWrapped()
private static OpenSSLKey	wrapJCAPrivateKeyForTLSStackOnly(PrivateKey privateKey, PublicKey publicKey)	Wraps the provided private key for use in the TLS/SSL stack only.
private static OpenSSLKey	wrapPrivateKey(PrivateKey key)

Methods inherited from class Object

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

Field Details

ctx

private final NativeRef.EVP_PKEY ctx

wrapped

private final boolean wrapped

hardwareBacked

private final boolean hardwareBacked

Constructor Details

OpenSSLKey

OpenSSLKey(long ctx)

OpenSSLKey

OpenSSLKey(long ctx,
 boolean wrapped)

OpenSSLKey

OpenSSLKey(long ctx,
 boolean wrapped,
 boolean hardwareBacked)

Method Details

getNativeRef

NativeRef.EVP_PKEY getNativeRef()

Returns the EVP_PKEY context for use in JNI calls.

isWrapped

boolean isWrapped()

isHardwareBacked

boolean isHardwareBacked()

fromPrivateKey

static OpenSSLKey fromPrivateKey(PrivateKey key)
                          throws InvalidKeyException

Throws:

InvalidKeyException

fromPrivateKeyPemInputStream

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

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

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

getOpenSSLKey

private static OpenSSLKey getOpenSSLKey(PrivateKey key)

Gets the OpenSSLKey instance of the provided key.

Returns:

instance or null if the key is not backed by OpenSSL's EVP_PKEY.

fromKeyMaterial

private static OpenSSLKey fromKeyMaterial(PrivateKey key)
                                   throws InvalidKeyException

Gets an OpenSSLKey instance initialized with the key material of the provided key.

Returns:

instance or null if the key does not export its key material in a suitable format.

Throws:

InvalidKeyException

wrapJCAPrivateKeyForTLSStackOnly

private static OpenSSLKey wrapJCAPrivateKeyForTLSStackOnly(PrivateKey privateKey,
 PublicKey publicKey)
                                                    throws InvalidKeyException

Wraps the provided private key for use in the TLS/SSL stack only. Sign/decrypt operations using the key will be delegated to the Signature/Cipher implementation of the provider which accepts the key.

Throws:

InvalidKeyException

wrapPrivateKey

private static OpenSSLKey wrapPrivateKey(PrivateKey key)
                                  throws InvalidKeyException

Throws:

InvalidKeyException

fromPublicKey

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

getPublicKey

static PublicKey getPublicKey(X509EncodedKeySpec keySpec,
 int type)
                       throws InvalidKeySpecException

Throws:

InvalidKeySpecException

getPrivateKey

PrivateKey getPrivateKey()
                  throws NoSuchAlgorithmException

Throws:

NoSuchAlgorithmException

getPrivateKey

static PrivateKey getPrivateKey(PKCS8EncodedKeySpec keySpec,
 int type)
                         throws InvalidKeySpecException

Throws:

InvalidKeySpecException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object