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

Field Summary

Modifier and Type	Field and Description
private final String	keyAlg
private final String	label
private final int	outputLength
private final int	prfBlockSize
private final String	prfHashAlg
private final int	prfHashLength
private final SecretKey	secret
private final byte[]	seed

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	TlsPrfParameterSpec(SecretKey the secret to use in the calculation (or null) secret, String the label to use in the calculation label, byte[] the random seed to use in the calculation seed, int the length in bytes of the output key to be produced outputLength, 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 TlsPrfParameterSpec.
public	TlsPrfParameterSpec(SecretKey the secret to use in the calculation (or null) secret, String the algorithm name for the generated `SecretKey` keyAlg, String the label to use in the calculation label, byte[] the random seed to use in the calculation seed, int the length in bytes of the output key to be produced outputLength, 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 TlsPrfParameterSpec.

public

TlsPrfParameterSpec(SecretKey

the secret to use in the calculation (or null)

secret, String

the label to use in the calculation

label, byte[]

the random seed to use in the calculation

seed, int

the length in bytes of the output key to be produced

outputLength, 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 TlsPrfParameterSpec.

public

TlsPrfParameterSpec(SecretKey

the secret to use in the calculation (or null)

secret, String

the algorithm name for the generated SecretKey

keyAlg, String

the label to use in the calculation

label, byte[]

the random seed to use in the calculation

seed, int

the length in bytes of the output key to be produced

outputLength, 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 TlsPrfParameterSpec.

Method Summary

Modifier and Type	Method and Description
public String	Returns: the key algorithm name getKeyAlg() Returns the key algorithm name to use when generating the SecretKey.
public String	Returns: the label to use in the PRF calculation. getLabel() Returns the label to use in the PRF calculation.
public int	Returns: the length in bytes of the output key to be produced. getOutputLength() Returns the length in bytes of the output key to be produced.
public int	Returns: the hash algorithm length. getPRFBlockSize() Obtains the length of PRF hash algorithm.
public String	Returns: the hash algorithm, or null if no algorithm was specified. getPRFHashAlg() Obtains the PRF hash algorithm to use in the PRF calculation.
public int	Returns: the hash algorithm length. getPRFHashLength() Obtains the length of PRF hash algorithm.
public SecretKey	Returns: the secret to use in the PRF calculation, or null if there is no secret. getSecret() Returns the secret to use in the PRF calculation, or null if there is no secret.
public byte[]	Returns: a copy of the seed to use in the PRF calculation. getSeed() Returns a copy of the seed to use in the PRF calculation.

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

Field Detail

keyAlg	back to summary
private final String keyAlg

label	back to summary
private final String label

outputLength	back to summary
private final int outputLength

prfBlockSize	back to summary
private final int prfBlockSize

prfHashAlg	back to summary
private final String prfHashAlg

prfHashLength	back to summary
private final int prfHashLength

secret	back to summary
private final SecretKey secret

seed	back to summary
private final byte[] seed

Constructor Detail

TlsPrfParameterSpec	back to summary
public TlsPrfParameterSpec(SecretKey secret, String label, byte[] seed, int outputLength, String prfHashAlg, int prfHashLength, int prfBlockSize) Constructs a new TlsPrfParameterSpec. Parameters secret:SecretKey the secret to use in the calculation (or null) label:String the label to use in the calculation seed:byte[] the random seed to use in the calculation outputLength:int the length in bytes of the output key to be produced 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 label or seed is null IllegalArgumentException: if outputLength is negative

TlsPrfParameterSpec

back to summary

public TlsPrfParameterSpec(SecretKey secret, String label, byte[] seed, int outputLength, String prfHashAlg, int prfHashLength, int prfBlockSize)

Constructs a new TlsPrfParameterSpec.

Parameters

secret:SecretKey: the secret to use in the calculation (or null)
label:String: the label to use in the calculation
seed:byte[]: the random seed to use in the calculation
outputLength:int: the length in bytes of the output key to be produced
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 label or seed is null
IllegalArgumentException:: if outputLength is negative

TlsPrfParameterSpec back to summary

TlsPrfParameterSpec	back to summary
public TlsPrfParameterSpec(SecretKey secret, String keyAlg, String label, byte[] seed, int outputLength, String prfHashAlg, int prfHashLength, int prfBlockSize) Constructs a new TlsPrfParameterSpec. Parameters secret:SecretKey the secret to use in the calculation (or null) keyAlg:String the algorithm name for the generated `SecretKey` label:String the label to use in the calculation seed:byte[] the random seed to use in the calculation outputLength:int the length in bytes of the output key to be produced 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 keyAlg, label or seed is null IllegalArgumentException: if outputLength is negative or keyAlg is empty

public TlsPrfParameterSpec(SecretKey secret, String keyAlg, String label, byte[] seed, int outputLength, String prfHashAlg, int prfHashLength, int prfBlockSize)

Constructs a new TlsPrfParameterSpec.

Parameters

secret:SecretKey: the secret to use in the calculation (or null)
keyAlg:String: the algorithm name for the generated SecretKey
label:String: the label to use in the calculation
seed:byte[]: the random seed to use in the calculation
outputLength:int: the length in bytes of the output key to be produced
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 keyAlg, label or seed is null
IllegalArgumentException:: if outputLength is negative or keyAlg is empty

Method Detail

getKeyAlg	back to summary
public String getKeyAlg() Returns the key algorithm name to use when generating the SecretKey. Returns:String the key algorithm name

getKeyAlg

back to summary

public String getKeyAlg()

Returns the key algorithm name to use when generating the SecretKey.

Returns:String: the key algorithm name

getLabel	back to summary
public String getLabel() Returns the label to use in the PRF calculation. Returns:String the label to use in the PRF calculation.

getLabel

back to summary

public String getLabel()

Returns the label to use in the PRF calculation.

Returns:String: the label to use in the PRF calculation.

getOutputLength	back to summary
public int getOutputLength() Returns the length in bytes of the output key to be produced. Returns:int the length in bytes of the output key to be produced.

getOutputLength

back to summary

public int getOutputLength()

Returns the length in bytes of the output key to be produced.

Returns:int: the length in bytes of the output key to be produced.

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

getPRFBlockSize

back to summary

public int getPRFBlockSize()

Obtains the length of PRF hash algorithm.

Returns:int: the hash algorithm length.

getPRFHashAlg	back to summary
public String getPRFHashAlg() Obtains the PRF hash algorithm to use in the PRF calculation. Returns:String the hash algorithm, or null if no algorithm was specified.

getPRFHashAlg

back to summary

public String getPRFHashAlg()

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

Returns:String: the hash algorithm, or null if no algorithm was specified.

getPRFHashLength	back to summary
public int getPRFHashLength() Obtains the length of PRF hash algorithm. It would have been preferred to use MessageDigest.getDigestLength(), but the API does not require implementations to support the method. Returns:int the hash algorithm length.

getPRFHashLength

back to summary

public int getPRFHashLength()

Obtains the length of PRF hash algorithm. It would have been preferred to use MessageDigest.getDigestLength(), but the API does not require implementations to support the method.

Returns:int: the hash algorithm length.

getSecret	back to summary
public SecretKey getSecret() Returns the secret to use in the PRF calculation, or null if there is no secret. Returns:SecretKey the secret to use in the PRF calculation, or null if there is no secret.

getSecret

back to summary

public SecretKey getSecret()

Returns the secret to use in the PRF calculation, or null if there is no secret.

Returns:SecretKey: the secret to use in the PRF calculation, or null if there is no secret.

getSeed	back to summary
public byte[] getSeed() Returns a copy of the seed to use in the PRF calculation. Returns:byte[] a copy of the seed to use in the PRF calculation.

getSeed

back to summary

public byte[] getSeed()

Returns a copy of the seed to use in the PRF calculation.

Returns:byte[]: a copy of the seed to use in the PRF calculation.

public Class TlsPrfParameterSpec

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail