https://github.com/auth0/node-xml-encryption
W3C XML Encryption implementation for node.js (http://www.w3.org/TR/xmlenc-core/)
https://github.com/auth0/node-xml-encryption
Last synced: 8 months ago
JSON representation
W3C XML Encryption implementation for node.js (http://www.w3.org/TR/xmlenc-core/)
- Host: GitHub
- URL: https://github.com/auth0/node-xml-encryption
- Owner: auth0
- License: mit
- Created: 2013-04-15T20:24:35.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-01-21T14:33:27.000Z (12 months ago)
- Last Synced: 2025-05-07T13:34:42.040Z (8 months ago)
- Language: JavaScript
- Size: 231 KB
- Stars: 37
- Watchers: 82
- Forks: 58
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/auth0/node-xml-encryption)
W3C XML Encryption implementation for Node.js (http://www.w3.org/TR/xmlenc-core/)
Node 18+ does not support Triple DES algorithms due to https://github.com/nodejs/node/issues/52017
## Usage
npm install xml-encryption
### encrypt
~~~js
var xmlenc = require('xml-encryption');
var options = {
rsa_pub: fs.readFileSync(__dirname + '/your_rsa.pub'),
pem: fs.readFileSync(__dirname + '/your_public_cert.pem'),
encryptionAlgorithm: 'http://www.w3.org/2001/04/xmlenc#aes256-cbc',
keyEncryptionAlgorithm: 'http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p',
keyEncryptionDigest: 'sha1',
disallowEncryptionWithInsecureAlgorithm: true,
warnInsecureAlgorithm: true
};
xmlenc.encrypt('content to encrypt', options, function(err, result) {
console.log(result);
}
~~~
Result:
~~~xml
MIIEDzCCAveg... base64 cert... q3uaLvlAUo=
sGH0hhzkjmLWYYY0gyQMampDM... encrypted symmetric key ...gewHMbtZafk1MHh9A==
V3Vb1vDl055Lp92zvK..... encrypted content.... kNzP6xTu7/L9EMAeU
~~~
### decrypt
~~~js
var options = {
key: fs.readFileSync(__dirname + '/your_private_key.key'),
disallowDecryptionWithInsecureAlgorithm: true,
warnInsecureAlgorithm: true
};
xmlenc.decrypt('', options, function(err, result) {
console.log(result);
}
// result
decrypted content
~~~
## Supported algorithms
Currently the library supports:
* EncryptedKey to transport symmetric key using:
* http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p
* http://www.w3.org/2001/04/xmlenc#rsa-1_5 (Insecure Algorithm)
* EncryptedData using:
* http://www.w3.org/2001/04/xmlenc#aes128-cbc
* http://www.w3.org/2001/04/xmlenc#aes256-cbc
* http://www.w3.org/2009/xmlenc11#aes128-gcm
* http://www.w3.org/2009/xmlenc11#aes256-gcm
* http://www.w3.org/2001/04/xmlenc#tripledes-cbc (Insecure Algorithm)
Insecure Algorithms can be disabled via `disallowEncryptionWithInsecureAlgorithm`/`disallowDecryptionWithInsecureAlgorithm` flags when encrypting/decrypting. This flag is off by default in 0.x versions.
A warning will be piped to `stderr` using console.warn() by default when the aforementioned algorithms are used. This can be disabled via the `warnInsecureAlgorithm` flag.
## Issue Reporting
If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues.
## Author
[Auth0](auth0.com)
## License
This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info.
## Releases
Release notes may be found under github release page: https://github.com/auth0/node-xml-encryption/releases