summaryrefslogtreecommitdiffstats
path: root/third_party/rust/ohttp/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /third_party/rust/ohttp/README.md
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/ohttp/README.md')
-rw-r--r--third_party/rust/ohttp/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/third_party/rust/ohttp/README.md b/third_party/rust/ohttp/README.md
new file mode 100644
index 0000000000..5ac73e3c45
--- /dev/null
+++ b/third_party/rust/ohttp/README.md
@@ -0,0 +1,33 @@
+# Oblivious HTTP
+
+This is a rust implementation of [Oblivious
+HTTP](https://ietf-wg-ohai.github.io/oblivious-http/draft-ietf-ohai-ohttp.html).
+
+This work is undergoing active revision in the IETF and so are these
+implementations. Use at your own risk.
+
+This crate uses either [hpke](https://github.com/rozbb/rust-hpke) or
+[NSS](https://firefox-source-docs.mozilla.org/security/nss/index.html) for
+cryptographic primitives.
+
+
+## Using
+
+The API documentation is currently sparse, but the API is fairly small and
+descriptive.
+
+The `ohttp` crate has the following features:
+
+- `client` enables the client-side processing of oblivious HTTP messages:
+ encrypting requests and decrypting responses. This is enabled by default.
+
+- `server` enables the server-side processing of oblivious HTTP messages:
+ decrypting requests and encrypting responses. This is enabled by default.
+
+- `rust-hpke` selects the [hpke](https://github.com/rozbb/rust-hpke) crate for
+ HPKE encryption. This is enabled by default and cannot be enabled at the same
+ time as `nss`.
+
+- `nss` selects
+ [NSS](https://firefox-source-docs.mozilla.org/security/nss/index.html). This is
+ disabled by default and cannot be enabled at the same time as `rust-hpke`.