FipsEC.AgreementParameters

java.lang.Object
- org.bouncycastle.crypto.fips.FipsParameters
- - org.bouncycastle.crypto.fips.FipsAgreementParameters
  - - org.bouncycastle.crypto.fips.FipsEC.AgreementParameters

All Implemented Interfaces:

Parameters

Enclosing class:

FipsEC
```
public static final class FipsEC.AgreementParameters
extends FipsAgreementParameters
```
Parameters for EC key agreement.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`FipsEC.AgreementParameters`	`withDigest(FipsDigestAlgorithm digestAlgorithm)`	Add a digest algorithm to process the Z value with.
`FipsEC.AgreementParameters`	`withKDF(FipsKDF.AgreementKDFParametersBuilder kdfType, byte[] iv, int outputSize)`	Add a KDF to process the Z value with.
`FipsEC.AgreementParameters`	`withPRF(FipsKDF.PRF prfAlgorithm, byte[] salt)`	Add a PRF algorithm and salt to process the Z value with (as in SP 800-56C)

Methods inherited from class org.bouncycastle.crypto.fips.FipsAgreementParameters
getDigestAlgorithm, getPrfAlgorithm, getSalt

Methods inherited from class org.bouncycastle.crypto.fips.FipsParameters
getAlgorithm

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - withDigest
```
public FipsEC.AgreementParameters withDigest(FipsDigestAlgorithm digestAlgorithm)
```
    Add a digest algorithm to process the Z value with.
    
    Parameters:
    
    digestAlgorithm - digest algorithm to use.
    
    Returns:
    
    a new parameter set, including the digest algorithm
  - withPRF
```
public FipsEC.AgreementParameters withPRF(FipsKDF.PRF prfAlgorithm,
                                          byte[] salt)
```
    Add a PRF algorithm and salt to process the Z value with (as in SP 800-56C)
    
    Parameters:
    
    prfAlgorithm - PRF represent the MAC/HMAC algorithm to use.
    
    salt - the salt to use to initialise the PRF
    
    Returns:
    
    a new parameter set, including the digest algorithm
  - withKDF
```
public FipsEC.AgreementParameters withKDF(FipsKDF.AgreementKDFParametersBuilder kdfType,
                                          byte[] iv,
                                          int outputSize)
```
    Add a KDF to process the Z value with. The outputSize parameter determines how many bytes will be generated.
    
    Parameters:
    
    kdfType - KDF algorithm type to use for parameter creation.
    
    iv - the iv parameter for KDF initialization.
    
    outputSize - the size of the output to be generated from the KDF.
    
    Returns:
    
    a new parameter set, the KDF definition.