Skip to content

Bug/Outdated README: unclear whether signatureAlgorithm required or not #431

@Roman-Octavian

Description

@Roman-Octavian

Context

In README.md it is stated that signatureAlgorithm is OPTIONAL:

- `signatureAlgorithm` - **[optional]** one of the supported [signature algorithms](#signature-algorithms). Ex: `sign.signatureAlgorithm = "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"`

But this does not correspond to actual usage:

image

Reproduction

This behavior started occurring after updating to latest version xml-crypto: 5.0.0, therefore:

  1. Install xml-crypto version 5.0.0
  2. Try to sign XML document without specifying signatureAlgorithm
  3. Get runtime error

Environment

  • xml-crypto version 5.0.0
  • NodeJS version 20.10.0
  • NextJS version 13.5.4
  • Windows 11 Pro 22H2
  • Firefox 120.0.1 (64-bit)

Suggested solution

a. Update README to reflect changes from version 5.0.0

b. If signatureAlgorithm is not supposed to be required, fix requirement bug introduced in version 5.0.0

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions