Top Description Fields Constructors Methods
org.conscrypt

pack-priv final Class OpenSSLECPrivateKey

extends Object
implements ECPrivateKey, OpenSSLKeyHolder
Class Inheritance
All Implemented Interfaces
org.conscrypt.OpenSSLKeyHolder, java.security.interfaces.ECPrivateKey, java.security.interfaces.ECKey, java.security.PrivateKey, javax.security.auth.Destroyable, java.security.Key, java.io.Serializable
Imports
java.io.IOException, .NotSerializableException, .ObjectInputStream, .ObjectOutputStream, java.math.BigInteger, java.security.InvalidAlgorithmParameterException, .InvalidKeyException, .PrivateKey, .PublicKey, java.security.interfaces.ECKey, .ECPrivateKey, java.security.spec.ECParameterSpec, .ECPrivateKeySpec, .InvalidKeySpecException, java.util.Arrays, org.conscrypt.OpenSSLX509CertificateFactory.ParsingException

An implementation of a PrivateKey for EC keys based on BoringSSL.

Field Summary

Modifier and TypeField and Description
private static final String
protected transient OpenSSLECGroupContext
protected transient OpenSSLKey
private static final long

Constructor Summary

AccessConstructor and Description
pack-priv
pack-priv
pack-priv

Method Summary

Modifier and TypeMethod 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.
public String
getAlgorithm()

Implements java.security.Key.getAlgorithm.

Returns the standard algorithm name for this key.
public byte[]
getEncoded()

Implements java.security.Key.getEncoded.

Returns the key in its primary encoding format, or null if this key does not support encoding.
public String
getFormat()

Implements java.security.Key.getFormat.

Returns the name of the primary encoding format of this key, or null if this key does not support encoding.
pack-priv static OpenSSLKey
getInstance(ECPrivateKey ecPrivateKey)

public OpenSSLKey
public ECParameterSpec
getParams()

Implements java.security.interfaces.ECKey.getParams.

Returns the domain parameters associated with this key.
private BigInteger
public BigInteger
getS()

Implements java.security.interfaces.ECPrivateKey.getS.

Returns the private value S.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
private void
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
pack-priv static OpenSSLKey
wrapJCAPrivateKeyForTLSStackOnly(PrivateKey privateKey, PublicKey publicKey)

Wraps the provided private key for use in the TLS/SSL stack only.

pack-priv static OpenSSLKey
wrapJCAPrivateKeyForTLSStackOnly(PrivateKey privateKey, ECParameterSpec params)

Wraps the provided private key for use in the TLS/SSL stack only.

pack-priv static OpenSSLKey
private static OpenSSLKey
private void
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

ALGORITHMback to summary
private static final String ALGORITHM
groupback to summary
protected transient OpenSSLECGroupContext group
keyback to summary
protected transient OpenSSLKey key
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.security.interfaces.ECPrivateKey.serialVersionUID.

Constructor Detail

OpenSSLECPrivateKeyback to summary
pack-priv OpenSSLECPrivateKey(OpenSSLECGroupContext group, OpenSSLKey key)
OpenSSLECPrivateKeyback to summary
pack-priv OpenSSLECPrivateKey(OpenSSLKey key)
OpenSSLECPrivateKeyback to summary
pack-priv OpenSSLECPrivateKey(ECPrivateKeySpec ecKeySpec) throws InvalidKeySpecException

Method Detail

equalsback 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
getAlgorithmback to summary
public String getAlgorithm()

Implements java.security.Key.getAlgorithm.

Doc from java.security.Key.getAlgorithm.

Returns the standard algorithm name for this key. For example, "DSA" would indicate that this key is a DSA key. See the key related sections (KeyFactory, KeyGenerator, KeyPairGenerator, and SecretKeyFactory) in the Java Security Standard Algorithm Names Specification for information about standard key algorithm names.

Returns:String

the name of the algorithm associated with this key.

Annotations
@Override
getEncodedback to summary
public byte[] getEncoded()

Implements java.security.Key.getEncoded.

Doc from java.security.Key.getEncoded.

Returns the key in its primary encoding format, or null if this key does not support encoding.

Returns:byte[]

the encoded key, or null if the key does not support encoding.

Annotations
@Override
getFormatback to summary
public String getFormat()

Implements java.security.Key.getFormat.

Doc from java.security.Key.getFormat.

Returns the name of the primary encoding format of this key, or null if this key does not support encoding. The primary encoding format is named in terms of the appropriate ASN.1 data format, if an ASN.1 specification for this key exists. For example, the name of the ASN.1 data format for public keys is SubjectPublicKeyInfo, as defined by the X.509 standard; in this case, the returned format is "X.509". Similarly, the name of the ASN.1 data format for private keys is PrivateKeyInfo, as defined by the PKCS #8 standard; in this case, the returned format is "PKCS#8".

Returns:String

the primary encoding format of the key.

Annotations
@Override
getInstanceback to summary
pack-priv static OpenSSLKey getInstance(ECPrivateKey ecPrivateKey) throws InvalidKeyException
getOpenSSLKeyback to summary
public OpenSSLKey getOpenSSLKey()

Implements org.conscrypt.OpenSSLKeyHolder.getOpenSSLKey.

Annotations
@Override
getParamsback to summary
public ECParameterSpec getParams()

Implements java.security.interfaces.ECKey.getParams.

Doc from java.security.interfaces.ECKey.getParams.

Returns the domain parameters associated with this key. The domain parameters are either explicitly specified or implicitly created during key generation.

Returns:ECParameterSpec

the associated domain parameters.

Annotations
@Override
getPrivateKeyback to summary
private BigInteger getPrivateKey()
getSback to summary
public BigInteger getS()

Implements java.security.interfaces.ECPrivateKey.getS.

Doc from java.security.interfaces.ECPrivateKey.getS.

Returns the private value S.

Returns:BigInteger

the private value S.

Annotations
@Override
hashCodeback 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
readObjectback to summary
private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
wrapJCAPrivateKeyForTLSStackOnlyback to summary
pack-priv 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.

wrapJCAPrivateKeyForTLSStackOnlyback to summary
pack-priv static OpenSSLKey wrapJCAPrivateKeyForTLSStackOnly(PrivateKey privateKey, ECParameterSpec params) 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.

wrapPlatformKeyback to summary
pack-priv static OpenSSLKey wrapPlatformKey(ECPrivateKey ecPrivateKey) throws InvalidKeyException
wrapPlatformKeyback to summary
private static OpenSSLKey wrapPlatformKey(ECPrivateKey ecPrivateKey, OpenSSLECGroupContext group) throws InvalidKeyException
writeObjectback to summary
private void writeObject(ObjectOutputStream stream) throws IOException