Function agree

pub fn agree<B: AsRef<[u8]>, F, R, E>(
    my_private_key: &PrivateKey,
    peer_public_key: &UnparsedPublicKey<B>,
    error_value: E,
    kdf: F,
) -> Result<R, E>
where
    F: FnOnce(&[u8]) -> Result<R, E>,

Performs a key agreement with a private key and the given public key.

my_private_key is the private key to use. Only a reference to the key is required, allowing the key to continue to be used.

peer_public_key is the peer’s public key. agree will return Err(error_value) if it does not match my_private_key's algorithm/curve. agree verifies that it is encoded in the standard form for the algorithm and that the key is valid; see the algorithm’s documentation for details on how keys are to be encoded and what constitutes a valid key for that algorithm.

error_value is the value to return if an error occurs before kdf is called, e.g. when decoding of the peer’s public key fails or when the public key is otherwise invalid.

After the key agreement is done, agree calls kdf with the raw key material from the key agreement operation and then returns what kdf returns.

Errors

error_value on internal failure.