Skip to content

README.md: Remove obsolete requirement for openssl binary #514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cjbarth merged 2 commits into from
Oct 22, 2025
Merged

README.md: Remove obsolete requirement for openssl binary #514

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
525ac6d
README.md: Remove obsolete requirement for `openssl` binary
markstos Oct 7, 2025
1f61214
Merge branch 'master' into markstos-remove-install-from-README
cjbarth Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 1 addition & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

---

# Upgrading
## Upgrading

The `.getReferences()` AND the `.references` APIs are deprecated.
Please do not attempt to access them. The content in them should be treated as unsigned.
Expand All @@ -14,18 +14,6 @@ Instead, we strongly encourage users to migrate to the `.getSignedReferences()`
We understand that this may take a lot of efforts to migrate, feel free to ask for help.
This will help prevent future XML signature wrapping attacks.

---

## Install

Install with [npm](http://github.com/isaacs/npm):

```shell
npm install xml-crypto
```

A pre requisite it to have [openssl](http://www.openssl.org/) installed and its /bin to be on the system path. I used version 1.0.1c but it should work on older versions too.

## Supported Algorithms

### Canonicalization and Transformation Algorithms
Expand Down