org.conscrypt:conscrypt-openjdk 2.5.2 · org.conscrypt.OpenSSLKey

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

Access	Constructor and Description
pack-priv	OpenSSLKey(long ctx)
pack-priv	OpenSSLKey(long ctx, boolean wrapped)
pack-priv	OpenSSLKey(long ctx, boolean wrapped, boolean hardwareBacked)

Method Summary

Modifier and Type	Method and Description
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.
pack-priv static OpenSSLKey	fromECPrivateKeyForTLSStackOnly(PrivateKey private key. key, ECParameterSpec 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. ecParams) Gets an `OpenSSLKey` instance backed by the provided EC private key.
private static OpenSSLKey	Returns: instance or `null` if the `key` does not export its key material in a suitable format. fromKeyMaterial(PrivateKey key) Gets an `OpenSSLKey` instance initialized with the key material of the provided key.
pack-priv static OpenSSLKey	fromPrivateKey(PrivateKey key)
pack-priv static OpenSSLKey	fromPrivateKeyForTLSStackOnly(PrivateKey private key. privateKey, 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. publicKey) Gets an `OpenSSLKey` instance backed by the provided private key.
pack-priv static OpenSSLKey	fromPrivateKeyPemInputStream(InputStream is) Parse a private key in PEM encoding from the provided input stream.
pack-priv static OpenSSLKey	fromPublicKey(PublicKey key)
pack-priv static OpenSSLKey	fromPublicKeyPemInputStream(InputStream is) Parse a public key in PEM encoding from the provided input stream.
pack-priv NativeRef.EVP_PKEY	getNativeRef() Returns the EVP_PKEY context for use in JNI calls.
private static OpenSSLKey	Returns: instance or `null` if the `key` is not backed by OpenSSL's `EVP_PKEY`. getOpenSSLKey(PrivateKey key) Gets the `OpenSSLKey` instance of the provided key.
pack-priv PrivateKey	getPrivateKey()
pack-priv static PrivateKey	getPrivateKey(PKCS8EncodedKeySpec keySpec, int type)
pack-priv PublicKey	getPublicKey()
pack-priv static PublicKey	getPublicKey(X509EncodedKeySpec keySpec, int type)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
pack-priv boolean	isHardwareBacked()
pack-priv 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)

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

ctx	back to summary
private final NativeRef.EVP_PKEY ctx

hardwareBacked	back to summary
private final boolean hardwareBacked

wrapped	back to summary
private final boolean wrapped

OpenSSLKey	back to summary
pack-priv OpenSSLKey(long ctx)

OpenSSLKey	back to summary
pack-priv OpenSSLKey(long ctx, boolean wrapped)

OpenSSLKey	back to summary
pack-priv OpenSSLKey(long ctx, boolean wrapped, boolean hardwareBacked)

Method Detail

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. Annotations @Override

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.

Annotations

@Override

fromECPrivateKeyForTLSStackOnly back to summary

fromECPrivateKeyForTLSStackOnly	back to summary
pack-priv 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:PrivateKey private key. ecParams:ECParameterSpec 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.

pack-priv 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:PrivateKey: private key.
ecParams:ECParameterSpec: 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.

fromKeyMaterial back to summary

fromKeyMaterial	back to summary
private static OpenSSLKey fromKeyMaterial(PrivateKey key) throws InvalidKeyException Gets an `OpenSSLKey` instance initialized with the key material of the provided key. Returns:OpenSSLKey instance or `null` if the `key` does not export its key material in a suitable format.

private static OpenSSLKey fromKeyMaterial(PrivateKey key) throws InvalidKeyException

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

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

fromPrivateKey	back to summary
pack-priv static OpenSSLKey fromPrivateKey(PrivateKey key) throws InvalidKeyException

fromPrivateKeyForTLSStackOnly back to summary

fromPrivateKeyForTLSStackOnly	back to summary
pack-priv 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:PrivateKey private key. publicKey: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.

pack-priv 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:PrivateKey: private key.
publicKey: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.

fromPrivateKeyPemInputStream	back to summary
pack-priv static OpenSSLKey fromPrivateKeyPemInputStream(InputStream is) throws InvalidKeyException Parse a private key in PEM encoding from the provided input stream. Exceptions InvalidKeyException: if parsing fails

fromPrivateKeyPemInputStream

back to summary

pack-priv static OpenSSLKey fromPrivateKeyPemInputStream(InputStream is) throws InvalidKeyException

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

Exceptions

InvalidKeyException:: if parsing fails

fromPublicKey	back to summary
pack-priv static OpenSSLKey fromPublicKey(PublicKey key) throws InvalidKeyException

fromPublicKeyPemInputStream	back to summary
pack-priv static OpenSSLKey fromPublicKeyPemInputStream(InputStream is) throws InvalidKeyException Parse a public key in PEM encoding from the provided input stream. Exceptions InvalidKeyException: if parsing fails

fromPublicKeyPemInputStream

back to summary

pack-priv static OpenSSLKey fromPublicKeyPemInputStream(InputStream is) throws InvalidKeyException

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

Exceptions

InvalidKeyException:: if parsing fails

getNativeRef	back to summary
pack-priv NativeRef.EVP_PKEY getNativeRef() Returns the EVP_PKEY context for use in JNI calls.

getOpenSSLKey back to summary

getOpenSSLKey	back to summary
private static OpenSSLKey getOpenSSLKey(PrivateKey key) Gets the `OpenSSLKey` instance of the provided key. Returns:OpenSSLKey instance or `null` if the `key` is not backed by OpenSSL's `EVP_PKEY`.

private static OpenSSLKey getOpenSSLKey(PrivateKey key)

Gets the OpenSSLKey instance of the provided key.

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

getPrivateKey	back to summary
pack-priv PrivateKey getPrivateKey() throws NoSuchAlgorithmException

getPrivateKey	back to summary
pack-priv static PrivateKey getPrivateKey(PKCS8EncodedKeySpec keySpec, int type) throws InvalidKeySpecException

getPublicKey	back to summary
pack-priv PublicKey getPublicKey() throws NoSuchAlgorithmException

getPublicKey	back to summary
pack-priv static PublicKey getPublicKey(X509EncodedKeySpec keySpec, int type) throws InvalidKeySpecException

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 the 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. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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.

Annotations

@Override

isHardwareBacked	back to summary
pack-priv boolean isHardwareBacked()

isWrapped	back to summary
pack-priv boolean isWrapped()

wrapJCAPrivateKeyForTLSStackOnly	back to summary
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.

wrapPrivateKey	back to summary
private static OpenSSLKey wrapPrivateKey(PrivateKey key) throws InvalidKeyException

pack-priv final Class OpenSSLKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail