The EdDsaAlgorithm class provides a concrete implementation for cryptographic operations using the Edwards-curve Digital Signature Algorithm (EdDSA). This class implements both Signer and AsymmetricKeyGenerator interfaces, providing private key generation, public key derivation, and creation/verification of signatures.

This class is typically accessed through implementations that extend the CryptoApi interface.

Hierarchy (view full)

Implements

Constructors

Methods

  • Derives the public key in JWK format from a given private key.

    Parameters

    Returns Promise<Jwk>

    A Promise that resolves to the derived public key in JWK format.

    Remarks

    This method takes a private key in JWK format and derives its corresponding public key, also in JWK format. The process ensures that the derived public key correctly corresponds to the given private key.

    Example

    const eddsa = new EdDsaAlgorithm();
    const privateKey = { ... }; // A Jwk object representing a private key
    const publicKey = await eddsa.computePublicKey({ key: privateKey });
  • Generates a new private key with the specified algorithm in JSON Web Key (JWK) format.

    Parameters

    Returns Promise<Jwk>

    A Promise that resolves to the generated private key in JWK format.

    Example

    const eddsa = new EdDsaAlgorithm();
    const privateKey = await eddsa.generateKey({ algorithm: 'Ed25519' });
  • Retrieves the public key properties from a given private key in JWK format.

    Parameters

    Returns Promise<Jwk>

    A Promise that resolves to the public key in JWK format.

    Remarks

    This method extracts the public key portion from an EdDSA private key in JWK format. It does so by removing the private key property 'd' and making a shallow copy, effectively yielding the public key.

    Note: This method offers a significant performance advantage, being about 100 times faster than computePublicKey(). However, it does not mathematically validate the private key, nor does it derive the public key from the private key. It simply extracts existing public key properties from the private key object. This makes it suitable for scenarios where speed is critical and the private key's integrity is already assured.

    Example

    const eddsa = new EdDsaAlgorithm();
    const privateKey = { ... }; // A Jwk object representing a private key
    const publicKey = await eddsa.getPublicKey({ key: privateKey });
  • Generates an EdDSA signature of given data using a private key.

    Parameters

    • params: SignParams

      The parameters for the signing operation.

    Returns Promise<Uint8Array>

    A Promise resolving to the digital signature as a Uint8Array.

    Remarks

    This method uses the signature algorithm determined by the given algorithm to sign the provided data.

    The signature can later be verified by parties with access to the corresponding public key, ensuring that the data has not been tampered with and was indeed signed by the holder of the private key.

    Example

    const eddsa = new EdDsaAlgorithm();
    const data = new TextEncoder().encode('Message');
    const privateKey = { ... }; // A Jwk object representing a private key
    const signature = await eddsa.sign({
    key: privateKey,
    data
    });
  • Verifies an EdDSA signature associated with the provided data using the provided key.

    Parameters

    • params: VerifyParams

      The parameters for the verification operation.

    Returns Promise<boolean>

    A Promise resolving to a boolean indicating whether the signature is valid.

    Remarks

    This method uses the signature algorithm determined by the crv property of the provided key to check the validity of a digital signature against the original data. It confirms whether the signature was created by the holder of the corresponding private key and that the data has not been tampered with. s

    Example

    const eddsa = new EdDsaAlgorithm();
    const publicKey = { ... }; // Public key in JWK format corresponding to the private key that signed the data
    const signature = new Uint8Array([...]); // Signature to verify
    const data = new TextEncoder().encode('Message');
    const isValid = await eddsa.verify({
    key: publicKey,
    signature,
    data
    });