OpenJDK 27 · sun.security.ec.ECPrivateKeyImpl · APIdia, the JavaDoc alternative

Key implementation for EC private keys.

ASN.1 syntax for EC private keys from SEC 1 v1.5 (draft):

EXPLICIT TAGS

ECPrivateKey ::= SEQUENCE {
  version INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
  privateKey OCTET STRING,
  parameters [0] ECDomainParameters {{ SECGCurveNames }} OPTIONAL,
  publicKey [1] BIT STRING OPTIONAL
}

We currently ignore the optional parameters and publicKey fields. We require that the parameters are encoded as part of the AlgorithmIdentifier, not in the private key structure.

Field Summary

Modifier and Type	Field and Description
private byte[]	arrayS
private byte[]	domainParams
private ECParameterSpec	params
private BigInteger	s
private final byte	SEC1v2
private static final long	serialVersionUID Hides sun.security.pkcs.PKCS8Key.serialVersionUID, java.security.interfaces.ECPrivateKey.serialVersionUID, java.security.PrivateKey.serialVersionUID.

Inherited from sun.security.pkcs.PKCS8Key:: algid encodedKey privKeyMaterial pubKeyEncoded V1 V2

Access	Constructor and Description
pack-priv	ECPrivateKeyImpl(byte[] encoded) Construct a key from its encoding.
pack-priv	ECPrivateKeyImpl(BigInteger s, ECParameterSpec params) Construct a key from its components.
pack-priv	ECPrivateKeyImpl(byte[] s, ECParameterSpec params)

Method Summary

Modifier and Type	Method and Description
public PublicKey	calculatePublicKey() Overrides default sun.security.util.InternalPrivateKey.calculatePublicKey. Calculates a matching public key.
public String	getAlgorithm() Overrides sun.security.pkcs.PKCS8Key.getAlgorithm. Implements java.security.Key.getAlgorithm. Returns the standard algorithm name for this key.
public byte[]	getArrayS()
public ECParameterSpec	getParams() Overrides default java.security.interfaces.ECPrivateKey.getParams, java.security.AsymmetricKey.getParams. Returns the parameters associated with this key.
public BigInteger	getS() Implements java.security.interfaces.ECPrivateKey.getS. Returns the private value S.
private void	makeEncoding(byte[] privBytes)
private void	parseKeyBits() Parse the ASN.1 of the privateKey Octet
public static BitArray	parsePublicBits(byte[] privateBytes)
private void	readObject(ObjectInputStream the `ObjectInputStream` from which data is read stream) Hides sun.security.pkcs.PKCS8Key.readObject. Restores the state of this object from the stream.

Inherited from sun.security.pkcs.PKCS8Key:: clear equals getAlgorithmId getEncoded getEncoded getFormat getPubKeyEncoded getVersion hashCode hasPublicKey parseKey parseKey writeReplace

Field Detail

arrayS	back to summary
private byte[] arrayS

domainParams	back to summary
private byte[] domainParams

params	back to summary
private ECParameterSpec params Annotations @SuppressWarnings:serial

s	back to summary
private BigInteger s

SEC1v2	back to summary
private final byte SEC1v2

serialVersionUID	back to summary
private static final long serialVersionUID Hides sun.security.pkcs.PKCS8Key.serialVersionUID, java.security.interfaces.ECPrivateKey.serialVersionUID, java.security.PrivateKey.serialVersionUID. Annotations @Serial

Constructor Detail

ECPrivateKeyImpl	back to summary
pack-priv ECPrivateKeyImpl(byte[] encoded) throws InvalidKeyException Construct a key from its encoding. Called by the ECKeyFactory.

ECPrivateKeyImpl	back to summary
pack-priv ECPrivateKeyImpl(BigInteger s, ECParameterSpec params) throws InvalidKeyException Construct a key from its components. Used by the KeyFactory.

ECPrivateKeyImpl	back to summary
pack-priv ECPrivateKeyImpl(byte[] s, ECParameterSpec params) throws InvalidKeyException

Method Detail

calculatePublicKey	back to summary
public PublicKey calculatePublicKey() Overrides default sun.security.util.InternalPrivateKey.calculatePublicKey. Doc from sun.security.util.InternalPrivateKey.calculatePublicKey. Calculates a matching public key.

calculatePublicKey

back to summary

public PublicKey calculatePublicKey()

Overrides default sun.security.util.InternalPrivateKey.calculatePublicKey.

Doc from sun.security.util.InternalPrivateKey.calculatePublicKey.

Calculates a matching public key.

getAlgorithm	back to summary
public String getAlgorithm() Overrides sun.security.pkcs.PKCS8Key.getAlgorithm. Implements java.security.Key.getAlgorithm. Doc from java.security.Key.getAlgorithm. Returns the standard algorithm name for this key. For example, "RSA" would indicate that this key is an RSA key. See the Key Algorithms section in the Java Security Standard Algorithm Names Specification for information about standard key algorithm names.

getAlgorithm

back to summary

public String getAlgorithm()

Overrides sun.security.pkcs.PKCS8Key.getAlgorithm.

Implements java.security.Key.getAlgorithm.

Doc from java.security.Key.getAlgorithm.

Returns the standard algorithm name for this key. For example, "RSA" would indicate that this key is an RSA key. See the Key Algorithms section in the Java Security Standard Algorithm Names Specification for information about standard key algorithm names.

getArrayS	back to summary
public byte[] getArrayS()

getParams	back to summary
public ECParameterSpec getParams() Overrides default java.security.interfaces.ECPrivateKey.getParams, java.security.AsymmetricKey.getParams. Doc from java.security.interfaces.ECPrivateKey.getParams. Returns the parameters associated with this key. The parameters are optional and may be either explicitly specified or implicitly created during key pair generation.

getParams

back to summary

public ECParameterSpec getParams()

Overrides default java.security.interfaces.ECPrivateKey.getParams, java.security.AsymmetricKey.getParams.

Doc from java.security.interfaces.ECPrivateKey.getParams.

Returns the parameters associated with this key. The parameters are optional and may be either explicitly specified or implicitly created during key pair generation.

getS	back to summary
public BigInteger getS() Implements java.security.interfaces.ECPrivateKey.getS. Doc from java.security.interfaces.ECPrivateKey.getS. Returns the private value S.

getS

back to summary

public BigInteger getS()

Implements java.security.interfaces.ECPrivateKey.getS.

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

Returns the private value S.

makeEncoding	back to summary
private void makeEncoding(byte[] privBytes) throws InvalidKeyException

parseKeyBits	back to summary
private void parseKeyBits() throws InvalidKeyException Parse the ASN.1 of the privateKey Octet

parsePublicBits	back to summary
public static BitArray parsePublicBits(byte[] privateBytes)

readObject back to summary

readObject	back to summary
private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException Hides sun.security.pkcs.PKCS8Key.readObject. Restores the state of this object from the stream. Deserialization of this object is not supported. Parameters stream:ObjectInputStream the `ObjectInputStream` from which data is read Annotations @Serial Exceptions IOException: if an I/O error occurs ClassNotFoundException: if a serialized class cannot be loaded

private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException

Hides sun.security.pkcs.PKCS8Key.readObject.

Restores the state of this object from the stream.

Deserialization of this object is not supported.

Parameters

stream:ObjectInputStream: the ObjectInputStream from which data is read

Annotations

@Serial

Exceptions

IOException:: if an I/O error occurs
ClassNotFoundException:: if a serialized class cannot be loaded

public final Class ECPrivateKeyImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail