Streamed read for binary HTTP

Cargo.toml

@@ -7,6 +7,7 @@ members = [
   "ohttp-client",
   "ohttp-client-cli",
   "ohttp-server",
+  "sync-async",
 ]
 
 [workspace.package]
@@ -17,7 +18,7 @@ description = "Oblivious HTTP"
 keywords = ["ohttp", "http", "bhttp", "ietf"]
 categories = ["network-programming", "web-programming", "security"]
 readme = "README.md"
-version = "0.6.1"
+version = "0.7.0"
 edition = "2021"
 license = "MIT OR Apache-2.0"
 rust-version = "1.82.0"

README.md

@@ -17,19 +17,11 @@ descriptive.
 
 The `bhttp` crate has the following features:
 
-- `read-bhttp` enables parsing of binary HTTP messages.  This is enabled by
-  default.
+- `http` enables parsing and generation of binary HTTP messages.
+  This is disabled by default.
 
-- `write-bhttp` enables writing of binary HTTP messages.  This is enabled by
-  default.
-
-- `read-http` enables a simple HTTP/1.1 message parser.  This parser is fairly
-  basic and is not recommended for production use.  Getting an HTTP/1.1 parser
-  right is a massive enterprise; this one only does the basics.  This is
-  disabled by default.
-
-- `write-http` enables writing of HTTP/1.1 messages.  This is disabled by
-  default.
+- `stream` enables stream processing (presently just reading)
+  of binary HTTP messages.  This is disabled by default until it stabilizes.
 
 The `ohttp` crate has the following features:
 
@@ -47,6 +39,10 @@ The `ohttp` crate has the following features:
   [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`.
 
+- `stream` enables stream processing (presently just reading)
+  of [chunked Oblivious HTTP messages](https://datatracker.ietf.org/doc/html/draft-ietf-ohai-chunked-ohttp).
+  This is disabled by default until it stabilizes.
+
 
 ## Utilities
 
@@ -128,16 +124,15 @@ export NSS_DIR=$workspace/nss
 export LD_LIBRARY_PATH=$workspace/dist/Debug/lib
 ```
 
-You might need to tweak this.  On a Mac, use `DYLD_LIBRARY_PATH` instead of
-`LD_LIBRARY_PATH`.  And if you are building with `--release`, the path includes
-"Release" rather than "Debug".
+On a Mac, use `DYLD_LIBRARY_PATH` instead of `LD_LIBRARY_PATH`.
+If you are building with `--release`, the path includes "Release" rather than "Debug".
 
 Then you should be able to build and run tests:
 
 ```sh
 cd $workspace
-cargo build
-cargo test
+cargo build -F nss,client,server,http --no-default-features
+cargo test -F nss,client,server,http --no-default-features
 ```
 
 

bhttp-convert/Cargo.toml

@@ -9,4 +9,4 @@ structopt = "0.3"
 
 [dependencies.bhttp]
 path= "../bhttp"
-features = ["bhttp", "http"]
+features = ["http"]

bhttp-convert/src/main.rs

@@ -1,11 +1,12 @@
 #![deny(warnings, clippy::pedantic)]
 
-use bhttp::{Message, Mode};
 use std::{
     fs::File,
     io::{self, Read},
     path::PathBuf,
 };
+
+use bhttp::{Message, Mode};
 use structopt::StructOpt;
 
 #[derive(Debug, StructOpt)]

bhttp/Cargo.toml

@@ -13,17 +13,18 @@ categories.workspace = true
 readme.workspace = true
 
 [features]
-default = ["bhttp"]
-bhttp = ["read-bhttp", "write-bhttp"]
-http = ["read-http", "write-http"]
-read-bhttp = []
-write-bhttp = []
-read-http = ["url"]
-write-http = []
+default = []
+http = ["dep:url"]
+stream = ["dep:futures", "dep:pin-project"]
 
 [dependencies]
+futures = {version = "0.3", optional = true}
+pin-project = {version = "1.1", optional = true}
 thiserror = "1"
 url = {version = "2", optional = true}
 
 [dev-dependencies]
 hex = "0.4"
+
+[dev-dependencies.sync-async]
+path= "../sync-async"

bhttp/src/err.rs

@@ -1,6 +1,4 @@
-use thiserror::Error;
-
-#[derive(Error, Debug)]
+#[derive(thiserror::Error, Debug)]
 pub enum Error {
     #[error("a request used the CONNECT method")]
     ConnectUnsupported,
@@ -16,8 +14,14 @@ pub enum Error {
     InvalidMode,
     #[error("the status code of a response needs to be in 100..=599")]
     InvalidStatus,
+    #[cfg(feature = "stream")]
+    #[error("a method was called when the message was in the wrong state")]
+    InvalidState,
     #[error("IO error {0}")]
     Io(#[from] std::io::Error),
+    #[cfg(feature = "stream")]
+    #[error("the size of a vector exceeded the limit that was set")]
+    LimitExceeded,
     #[error("a field or line was missing a necessary character 0x{0:x}")]
     Missing(u8),
     #[error("a URL was missing a key component")]
@@ -31,14 +35,8 @@ pub enum Error {
     #[error("a message included the Upgrade field")]
     UpgradeUnsupported,
     #[error("a URL could not be parsed into components: {0}")]
-    #[cfg(feature = "read-http")]
+    #[cfg(feature = "http")]
     UrlParse(#[from] url::ParseError),
 }
 
-#[cfg(any(
-    feature = "read-http",
-    feature = "write-http",
-    feature = "read-bhttp",
-    feature = "write-bhttp"
-))]
 pub type Res<T> = Result<T, Error>;