summaryrefslogtreecommitdiffstats
path: root/third_party/rust/ece/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
commit2aa4a82499d4becd2284cdb482213d541b8804dd (patch)
treeb80bf8bf13c3766139fbacc530efd0dd9d54394c /third_party/rust/ece/README.md
parentInitial commit. (diff)
downloadfirefox-2aa4a82499d4becd2284cdb482213d541b8804dd.tar.xz
firefox-2aa4a82499d4becd2284cdb482213d541b8804dd.zip
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/ece/README.md')
-rw-r--r--third_party/rust/ece/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/third_party/rust/ece/README.md b/third_party/rust/ece/README.md
new file mode 100644
index 0000000000..880aafa839
--- /dev/null
+++ b/third_party/rust/ece/README.md
@@ -0,0 +1,23 @@
+# rust-ece &emsp; [![Build Status]][circleci] [![Latest Version]][crates.io]
+
+[Build Status]: https://circleci.com/gh/mozilla/rust-ece.svg?style=svg
+[circleci]: https://circleci.com/gh/mozilla/rust-ece
+[Latest Version]: https://img.shields.io/crates/v/ece.svg
+[crates.io]: https://crates.io/crates/ece
+
+*This crate has not been security reviewed yet, use at your own risk ([tracking issue](https://github.com/mozilla/rust-ece/issues/18))*.
+
+[ece](https://crates.io/crates/ece) is a Rust implementation of the HTTP Encrypted Content-Encoding standard (RFC 8188). It is a port of the [ecec](https://github.com/web-push-libs/ecec) C library.
+This crate is destined to be used by higher-level Web Push libraries, both on the server and the client side.
+
+[Documentation](https://docs.rs/ece/)
+
+## Cryptographic backends
+
+This crate is designed to be used with different crypto backends. At the moment only [openssl](https://github.com/sfackler/rust-openssl) is supported.
+
+## Implemented schemes
+
+Currently, two HTTP ece schemes are available to consumers of the crate:
+- The newer [RFC8188](https://tools.ietf.org/html/rfc8188) `aes128gcm` standard.
+- The legacy [draft-03](https://tools.ietf.org/html/draft-ietf-httpbis-encryption-encoding-03) `aesgcm` scheme.