Public key encryption system combining X25519 Diffie-Hellman with the STREAM construction
npm install xstream-crypto[npm-shield]: https://img.shields.io/npm/v/xstream-crypto.svg
[npm-link]: https://www.npmjs.com/package/xstream-crypto
[build-image]: https://secure.travis-ci.org/miscreant/xstream.svg?branch=master
[build-link]: http://travis-ci.org/miscreant/xstream
[snyk-image]: https://snyk.io/test/github/miscreant/xstream/badge.svg?targetFile=js%2Fpackage.json
[snyk-link]: https://snyk.io/test/github/miscreant/xstream?targetFile=js%2Fpackage.json
[license-image]: https://img.shields.io/badge/license-MIT/Apache2.0-blue.svg
[license-link]: https://github.com/miscreant/xstream/blob/master/LICENSE.txt
[gitter-image]: https://badges.gitter.im/badge.svg
[gitter-link]: https://gitter.im/miscreant/Lobby
XSTREAM (pronounced "extreme!") is a public key encryption system combining
X25519 Elliptic Curve Diffie-Hellman ([RFC 7748]) with the [STREAM] construction.
The implementations in this repository are built on top of the
[Miscreant] misuse-resistant symmetric encryption library, which provides
the [AES-SIV] and [AES-PMAC-SIV] algorithms.
More information on XSTREAM
is available in the Wiki.
[RFC 7748]: https://tools.ietf.org/html/rfc7748
[STREAM]: https://github.com/miscreant/miscreant/wiki/STREAM
[Miscreant]: https://github.com/miscreant/miscreant
[AES-SIV]: https://github.com/miscreant/miscreant/wiki/AES-SIV
[AES-PMAC-SIV]: https://github.com/miscreant/miscreant/wiki/AES-PMAC-SIV
Have questions? Want to suggest a feature or change?
* [Gitter]: web-based chat about miscreant projects including miscreant.rb
* [Google Group]: join via web or email ([miscreant-crypto+subscribe@googlegroups.com])
[Gitter]: https://gitter.im/miscreant/Lobby
[Google Group]: https://groups.google.com/forum/#!forum/miscreant-crypto
[miscreant-crypto+subscribe@googlegroups.com]: mailto:miscreant-crypto+subscribe@googlegroups.com?subject=subscribe
Though this library is written by cryptographic professionals, it has not
undergone a thorough security audit, and cryptographic professionals are still
humans that make mistakes.
Use this library at your own risk.
Please see the XSTREAM Wiki
for API documentation.
We abide by the [Contributor Covenant][cc] and ask that you do as well.
For more information, please see [CODE_OF_CONDUCT.md].
[cc]: https://contributor-covenant.org
[CODE_OF_CONDUCT.md]: https://github.com/miscreant/xstream/blob/master/CODE_OF_CONDUCT.md
Bug reports and pull requests are welcome on GitHub at https://github.com/miscreant/xstream.
Copyright (c) 2017-2018 [The Miscreant Developers][AUTHORS].
All XSTREAM libraries are licensed under either of:
* Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
[AUTHORS]: https://github.com/miscreant/miscreant/blob/master/AUTHORS.md