OpenJDK 27 · sun.security.internal.spec.TlsKeyMaterialParameterSpec

Field Summary

Modifier and Type	Field and Description
private final String	cipherAlgorithm
private final int	cipherKeyLength
private final byte[]	clientRandom
private final int	expandedCipherKeyLength
private final int	ivLength
private final int	macKeyLength
private final int	majorVersion
private final SecretKey	masterSecret
private final int	minorVersion
private final int	prfBlockSize
private final String	prfHashAlg
private final int	prfHashLength
private final byte[]	serverRandom

Constructor Summary

Access	Constructor and Description
public	TlsKeyMaterialParameterSpec(SecretKey the master secret masterSecret, int the major number of the protocol version majorVersion, int the minor number of the protocol version minorVersion, byte[] the client's random value clientRandom, byte[] the server's random value serverRandom, String the algorithm name of the cipher keys to be generated cipherAlgorithm, int if 0, no cipher keys will be generated; otherwise, the length in bytes of cipher keys to be generated for domestic cipher suites; for cipher suites defined as exportable, the number of key material bytes to be generated; cipherKeyLength, int 0 for domestic cipher suites; for exportable cipher suites the length in bytes of the key to be generated. expandedCipherKeyLength, int the length in bytes of the initialization vector to be generated, or 0 if no initialization vector is required ivLength, int the length in bytes of the MAC key to be generated macKeyLength, String the name of the TLS PRF hash algorithm to use. Used only for TLS 1.2+. TLS1.1 and earlier use a fixed PRF. prfHashAlg, int the output length of the TLS PRF hash algorithm. Used only for TLS 1.2+. prfHashLength, int the input block size of the TLS PRF hash algorithm. Used only for TLS 1.2+. prfBlockSize) Constructs a new TlsKeyMaterialParameterSpec.

Access

Constructor and Description

public

TlsKeyMaterialParameterSpec(SecretKey

the master secret

masterSecret, int

the major number of the protocol version

majorVersion, int

the minor number of the protocol version

minorVersion, byte[]

the client's random value

clientRandom, byte[]

the server's random value

serverRandom, String

the algorithm name of the cipher keys to be generated

cipherAlgorithm, int

if 0, no cipher keys will be generated; otherwise, the length in bytes of cipher keys to be generated for domestic cipher suites; for cipher suites defined as exportable, the number of key material bytes to be generated;

cipherKeyLength, int

0 for domestic cipher suites; for exportable cipher suites the length in bytes of the key to be generated.

expandedCipherKeyLength, int

the length in bytes of the initialization vector to be generated, or 0 if no initialization vector is required

ivLength, int

the length in bytes of the MAC key to be generated

macKeyLength, String

the name of the TLS PRF hash algorithm to use. Used only for TLS 1.2+. TLS1.1 and earlier use a fixed PRF.

prfHashAlg, int

the output length of the TLS PRF hash algorithm. Used only for TLS 1.2+.

prfHashLength, int

the input block size of the TLS PRF hash algorithm. Used only for TLS 1.2+.

prfBlockSize)

Constructs a new TlsKeyMaterialParameterSpec.

Method Summary

Modifier and Type	Method and Description
private static int	checkSign(int k)
public String	Returns: the cipher algorithm. getCipherAlgorithm() Returns the cipher algorithm.
public int	Returns: the length in bytes of the encryption key to be generated. getCipherKeyLength() Returns the length in bytes of the encryption key to be generated.
public byte[]	Returns: a copy of the client's random value. getClientRandom() Returns a copy of the client's random value.
public int	Returns: the length in bytes of the expanded encryption key to be generated. getExpandedCipherKeyLength() Returns the length in bytes of the expanded encryption key to be generated.
public int	Returns: the length in bytes of the initialization vector to be generated. getIvLength() Returns the length in bytes of the initialization vector to be generated.
public int	Returns: the length in bytes of the MAC key to be generated. getMacKeyLength() Returns the length in bytes of the MAC key to be generated.
public int	Returns: the major version number. getMajorVersion() Returns the major version number.
public SecretKey	Returns: the master secret. getMasterSecret() Returns the master secret.
public int	Returns: the minor version number. getMinorVersion() Returns the minor version number.
public int	Returns: the hash algorithm block size getPRFBlockSize() Obtains the block size of the PRF hash algorithm.
public String	Returns: the hash algorithm. getPRFHashAlg() Obtains the PRF hash algorithm to use in the PRF calculation.
public int	Returns: the hash algorithm length. getPRFHashLength() Obtains the length of the PRF hash algorithm.
public byte[]	Returns: a copy of the server's random value. getServerRandom() Returns a copy of the server's random value.

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

Field Detail

cipherAlgorithm	back to summary
private final String cipherAlgorithm

cipherKeyLength	back to summary
private final int cipherKeyLength

clientRandom	back to summary
private final byte[] clientRandom

expandedCipherKeyLength	back to summary
private final int expandedCipherKeyLength

ivLength	back to summary
private final int ivLength

macKeyLength	back to summary
private final int macKeyLength

majorVersion	back to summary
private final int majorVersion

masterSecret	back to summary
private final SecretKey masterSecret

minorVersion	back to summary
private final int minorVersion

prfBlockSize	back to summary
private final int prfBlockSize

prfHashAlg	back to summary
private final String prfHashAlg

prfHashLength	back to summary
private final int prfHashLength

serverRandom	back to summary
private final byte[] serverRandom

Constructor Detail

TlsKeyMaterialParameterSpec	back to summary
public TlsKeyMaterialParameterSpec(SecretKey masterSecret, int majorVersion, int minorVersion, byte[] clientRandom, byte[] serverRandom, String cipherAlgorithm, int cipherKeyLength, int expandedCipherKeyLength, int ivLength, int macKeyLength, String prfHashAlg, int prfHashLength, int prfBlockSize) Constructs a new TlsKeyMaterialParameterSpec. Parameters masterSecret:SecretKey the master secret majorVersion:int the major number of the protocol version minorVersion:int the minor number of the protocol version clientRandom:byte[] the client's random value serverRandom:byte[] the server's random value cipherAlgorithm:String the algorithm name of the cipher keys to be generated cipherKeyLength:int if 0, no cipher keys will be generated; otherwise, the length in bytes of cipher keys to be generated for domestic cipher suites; for cipher suites defined as exportable, the number of key material bytes to be generated; expandedCipherKeyLength:int 0 for domestic cipher suites; for exportable cipher suites the length in bytes of the key to be generated. ivLength:int the length in bytes of the initialization vector to be generated, or 0 if no initialization vector is required macKeyLength:int the length in bytes of the MAC key to be generated prfHashAlg:String the name of the TLS PRF hash algorithm to use. Used only for TLS 1.2+. TLS1.1 and earlier use a fixed PRF. prfHashLength:int the output length of the TLS PRF hash algorithm. Used only for TLS 1.2+. prfBlockSize:int the input block size of the TLS PRF hash algorithm. Used only for TLS 1.2+. Exceptions NullPointerException: if masterSecret, clientRandom, serverRandom, or cipherAlgorithm are null IllegalArgumentException: if the algorithm of masterSecret is not TlsMasterSecret, or if majorVersion or minorVersion are negative or larger than 255; or if cipherKeyLength, expandedKeyLength, ivLength, or macKeyLength are negative

TlsKeyMaterialParameterSpec

back to summary

public TlsKeyMaterialParameterSpec(SecretKey masterSecret, int majorVersion, int minorVersion, byte[] clientRandom, byte[] serverRandom, String cipherAlgorithm, int cipherKeyLength, int expandedCipherKeyLength, int ivLength, int macKeyLength, String prfHashAlg, int prfHashLength, int prfBlockSize)

Constructs a new TlsKeyMaterialParameterSpec.

Parameters

masterSecret:SecretKey: the master secret
majorVersion:int: the major number of the protocol version
minorVersion:int: the minor number of the protocol version
clientRandom:byte[]: the client's random value
serverRandom:byte[]: the server's random value
cipherAlgorithm:String: the algorithm name of the cipher keys to be generated
cipherKeyLength:int: if 0, no cipher keys will be generated; otherwise, the length in bytes of cipher keys to be generated for domestic cipher suites; for cipher suites defined as exportable, the number of key material bytes to be generated;
expandedCipherKeyLength:int: 0 for domestic cipher suites; for exportable cipher suites the length in bytes of the key to be generated.
ivLength:int: the length in bytes of the initialization vector to be generated, or 0 if no initialization vector is required
macKeyLength:int: the length in bytes of the MAC key to be generated
prfHashAlg:String: the name of the TLS PRF hash algorithm to use. Used only for TLS 1.2+. TLS1.1 and earlier use a fixed PRF.
prfHashLength:int: the output length of the TLS PRF hash algorithm. Used only for TLS 1.2+.
prfBlockSize:int: the input block size of the TLS PRF hash algorithm. Used only for TLS 1.2+.

Exceptions

NullPointerException:: if masterSecret, clientRandom, serverRandom, or cipherAlgorithm are null
IllegalArgumentException:: if the algorithm of masterSecret is not TlsMasterSecret, or if majorVersion or minorVersion are negative or larger than 255; or if cipherKeyLength, expandedKeyLength, ivLength, or macKeyLength are negative

Method Detail

checkSign	back to summary
private static int checkSign(int k)

getCipherAlgorithm	back to summary
public String getCipherAlgorithm() Returns the cipher algorithm. Returns:String the cipher algorithm.

getCipherAlgorithm

back to summary

public String getCipherAlgorithm()

Returns the cipher algorithm.

Returns:String: the cipher algorithm.

getCipherKeyLength	back to summary
public int getCipherKeyLength() Returns the length in bytes of the encryption key to be generated. Returns:int the length in bytes of the encryption key to be generated.

getCipherKeyLength

back to summary

public int getCipherKeyLength()

Returns the length in bytes of the encryption key to be generated.

Returns:int: the length in bytes of the encryption key to be generated.

getClientRandom	back to summary
public byte[] getClientRandom() Returns a copy of the client's random value. Returns:byte[] a copy of the client's random value.

getClientRandom

back to summary

public byte[] getClientRandom()

Returns a copy of the client's random value.

Returns:byte[]: a copy of the client's random value.

getExpandedCipherKeyLength	back to summary
public int getExpandedCipherKeyLength() Returns the length in bytes of the expanded encryption key to be generated. Returns zero if the expanded encryption key is not supposed to be generated. Returns:int the length in bytes of the expanded encryption key to be generated.

getExpandedCipherKeyLength

back to summary

public int getExpandedCipherKeyLength()

Returns the length in bytes of the expanded encryption key to be generated. Returns zero if the expanded encryption key is not supposed to be generated.

Returns:int: the length in bytes of the expanded encryption key to be generated.

getIvLength	back to summary
public int getIvLength() Returns the length in bytes of the initialization vector to be generated. Returns zero if the initialization vector is not supposed to be generated. Returns:int the length in bytes of the initialization vector to be generated.

getIvLength

back to summary

public int getIvLength()

Returns the length in bytes of the initialization vector to be generated. Returns zero if the initialization vector is not supposed to be generated.

Returns:int: the length in bytes of the initialization vector to be generated.

getMacKeyLength	back to summary
public int getMacKeyLength() Returns the length in bytes of the MAC key to be generated. Returns:int the length in bytes of the MAC key to be generated.

getMacKeyLength

back to summary

public int getMacKeyLength()

Returns the length in bytes of the MAC key to be generated.

Returns:int: the length in bytes of the MAC key to be generated.

getMajorVersion	back to summary
public int getMajorVersion() Returns the major version number. Returns:int the major version number.

getMajorVersion

back to summary

public int getMajorVersion()

Returns the major version number.

Returns:int: the major version number.

getMasterSecret	back to summary
public SecretKey getMasterSecret() Returns the master secret. Returns:SecretKey the master secret.

getMasterSecret

back to summary

public SecretKey getMasterSecret()

Returns the master secret.

Returns:SecretKey: the master secret.

getMinorVersion	back to summary
public int getMinorVersion() Returns the minor version number. Returns:int the minor version number.

getMinorVersion

back to summary

public int getMinorVersion()

Returns the minor version number.

Returns:int: the minor version number.

getPRFBlockSize	back to summary
public int getPRFBlockSize() Obtains the block size of the PRF hash algorithm. Returns:int the hash algorithm block size

getPRFBlockSize

back to summary

public int getPRFBlockSize()

Obtains the block size of the PRF hash algorithm.

Returns:int: the hash algorithm block size

getPRFHashAlg	back to summary
public String getPRFHashAlg() Obtains the PRF hash algorithm to use in the PRF calculation. Returns:String the hash algorithm.

getPRFHashAlg

back to summary

public String getPRFHashAlg()

Obtains the PRF hash algorithm to use in the PRF calculation.

Returns:String: the hash algorithm.

getPRFHashLength	back to summary
public int getPRFHashLength() Obtains the length of the PRF hash algorithm. Returns:int the hash algorithm length.

getPRFHashLength

back to summary

public int getPRFHashLength()

Obtains the length of the PRF hash algorithm.

Returns:int: the hash algorithm length.

getServerRandom	back to summary
public byte[] getServerRandom() Returns a copy of the server's random value. Returns:byte[] a copy of the server's random value.

getServerRandom

back to summary

public byte[] getServerRandom()

Returns a copy of the server's random value.

Returns:byte[]: a copy of the server's random value.

public Class TlsKeyMaterialParameterSpec

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail