EcdhKeyDeriveParams

{{ APIRef("Web Crypto API") }}

The EcdhKeyDeriveParams dictionary of the Web Crypto API represents the object that should be passed as the algorithm parameter into {{domxref("SubtleCrypto.deriveKey()")}} and {{domxref("SubtleCrypto.deriveBits()")}}, when using the ECDH or X25519 algorithms.

ECDH enables two people who each have a key pair consisting of a public and a private key to derive a shared secret. They exchange public keys and use the combination of their private key and the other entity's public key to derive a secret key that they — and no one else — share.

The parameters for ECDH deriveKey() therefore include the other entity's public key, which is combined with this entity's private key to derive the shared secret.

Instance properties

• name
  • : A string. This should be set to ECDH or X25519, depending on the algorithm used.
• public
  • : A {{domxref("CryptoKey")}} object representing the public key of the other entity.

Examples

See the examples for {{domxref("SubtleCrypto.deriveKey()")}} and {{domxref("SubtleCrypto.deriveBits()")}}.

Specifications

{{Specifications}}

Browser compatibility

Browsers that support the "ECDH" or "X25519" algorithm for the {{domxref("SubtleCrypto.deriveKey()")}} method will support this type.

See also

• {{domxref("SubtleCrypto.deriveKey()")}}.
• {{domxref("SubtleCrypto.deriveBits()")}}