Top Description Fields Constructors Methods
org.bouncycastle.crypto.fips

public Class FipsAgreementParameters

extends FipsParameters
Class Inheritance
Known Direct Subclasses
org.bouncycastle.crypto.fips.FipsDH.AgreementParameters, org.bouncycastle.crypto.fips.FipsDH.MQVAgreementParameters, org.bouncycastle.crypto.fips.FipsDH.DHUAgreementParameters, org.bouncycastle.crypto.fips.FipsEC.AgreementParameters, org.bouncycastle.crypto.fips.FipsEC.MQVAgreementParameters, org.bouncycastle.crypto.fips.FipsEC.DHUAgreementParameters
Imports
org.bouncycastle.util.Arrays
Base parameters class for Diffie-Hellman and MQV based key agreement algorithms.

Field Summary

Modifier and TypeField and Description
pack-priv final FipsAlgorithm
digestAlgorithm

pack-priv final FipsKDF.AgreementKDFParametersBuilder
kdfType

pack-priv final int
outputSize

pack-priv final FipsKDF.PRF
prfAlgorithm

pack-priv final byte[]
salt

Constructor Summary

AccessConstructor and Description
pack-priv
FipsAgreementParameters(FipsAlgorithm
the agreement algorithm these parameters are for.
agreementAlgorithm, FipsAlgorithm
the digest algorithm to use.
digestAlgorithm)

Constructor which specifies returning a digest of the raw secret on agreement calculation.

pack-priv
FipsAgreementParameters(FipsAlgorithm
the agreement algorithm these parameters are for.
agreementAlgorithm, FipsKDF.PRF
the MAC/HMAC algorithm to use.
prfAlgorithm, byte[]
the byte string to key the MAC/HMAC with.
salt)

Constructor which specifies returning a MAC/HMAC of the raw secret on agreement calculation using one of the standard PRFs as described in SP800-56C.

pack-priv
FipsAgreementParameters(FipsAlgorithm agreementAlgorithm, FipsKDF.AgreementKDFParametersBuilder
KDF algorithm type to use for parameter creation.
kdfType, byte[]
the iv parameter for KDF initialization.
iv, int
the size of the output to be generated from the KDF.
outputSize)

Constructor with a KDF to process the Z value with.

Method Summary

Modifier and TypeMethod and Description
public FipsAlgorithm

Returns:

the digest algorithm ID, null if not present.
getDigestAlgorithm()

Return the digest algorithm ID associated with these parameters.

public FipsKDF.PRF

Returns:

the PRF ID, null if not present.
getPrfAlgorithm()

Return the PRF associated with these parameters.

public byte[]

Returns:

the salt, null if not present.
getSalt()

Return the salt/iv associated with these parameters.

Inherited from org.bouncycastle.crypto.fips.FipsParameters:
getAlgorithm

Field Detail

digestAlgorithmback to summary
pack-priv final FipsAlgorithm digestAlgorithm
kdfTypeback to summary
pack-priv final FipsKDF.AgreementKDFParametersBuilder kdfType
outputSizeback to summary
pack-priv final int outputSize
prfAlgorithmback to summary
pack-priv final FipsKDF.PRF prfAlgorithm
saltback to summary
pack-priv final byte[] salt

Constructor Detail

FipsAgreementParametersback to summary
pack-priv FipsAgreementParameters(FipsAlgorithm agreementAlgorithm, FipsAlgorithm digestAlgorithm)

Constructor which specifies returning a digest of the raw secret on agreement calculation.

Parameters
agreementAlgorithm:FipsAlgorithm

the agreement algorithm these parameters are for.

digestAlgorithm:FipsAlgorithm

the digest algorithm to use.

FipsAgreementParametersback to summary
pack-priv FipsAgreementParameters(FipsAlgorithm agreementAlgorithm, FipsKDF.PRF prfAlgorithm, byte[] salt)

Constructor which specifies returning a MAC/HMAC of the raw secret on agreement calculation using one of the standard PRFs as described in SP800-56C.

Parameters
agreementAlgorithm:FipsAlgorithm

the agreement algorithm these parameters are for.

prfAlgorithm:FipsKDF.PRF

the MAC/HMAC algorithm to use.

salt:byte[]

the byte string to key the MAC/HMAC with.

FipsAgreementParametersback to summary
pack-priv FipsAgreementParameters(FipsAlgorithm agreementAlgorithm, FipsKDF.AgreementKDFParametersBuilder kdfType, byte[] iv, int outputSize)

Constructor with a KDF to process the Z value with. The outputSize parameter determines how many bytes will be generated.

Parameters
kdfType:FipsKDF.AgreementKDFParametersBuilder

KDF algorithm type to use for parameter creation.

iv:byte[]

the iv parameter for KDF initialization.

outputSize:int

the size of the output to be generated from the KDF.

Method Detail

getDigestAlgorithmback to summary
public FipsAlgorithm getDigestAlgorithm()

Return the digest algorithm ID associated with these parameters.

Returns:FipsAlgorithm

the digest algorithm ID, null if not present.

getPrfAlgorithmback to summary
public FipsKDF.PRF getPrfAlgorithm()

Return the PRF associated with these parameters.

Returns:FipsKDF.PRF

the PRF ID, null if not present.

getSaltback to summary
public byte[] getSalt()

Return the salt/iv associated with these parameters.

Returns:byte[]

the salt, null if not present.