feat: add cross-platform HTTP/1.1 parser and local proxy server for iOS and Android#367
feat: add cross-platform HTTP/1.1 parser and local proxy server for iOS and Android#367
Conversation
cce3ff6 to
57d1b7c
Compare
29f9c27 to
0a09c12
Compare
Add a hardened, RFC-conformant HTTP/1.1 request parser and local proxy server for iOS. The parser is exposed to JavaScript running in the WebView, so it enforces strict validation per RFC 7230/9110/9112 to prevent request smuggling, header injection, and resource exhaustion. Includes: - HTTPRequestParser: Incremental parser with disk-backed buffering - HTTPRequestSerializer: Stateless header parsing with full RFC validation - HeaderValue: RFC 2045 parameter extraction with quoted string handling - MultipartPart: RFC 7578 multipart/form-data with lazy file-slice refs - RequestBody: In-memory and file-backed storage with InputStream access - HTTPServer: Local server on Network.framework with async handler API, connection limits, read timeouts (408 per RFC 9110 §15.5.9), and constant-time bearer token auth - HTTPResponse: Response serialization with header sanitization, Content-Length always derived from actual body size All size-related types use Int64 to match Kotlin's Long and prevent ambiguity on future platforms. 820+ tests covering RFC 7230, 7578, 8941, 9110, 9112, and 9651. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…tures Add a pure-Kotlin implementation of the HTTP/1.1 request parser that mirrors the Swift GutenbergKitHTTP library, enabling HTTP parsing on Android without native dependencies. Includes HeaderValue, HTTPRequestSerializer, HTTPRequestParser (with disk-backed buffering), ParsedHTTPRequest, MultipartPart, RequestBody, and HttpServer with bearer token authentication, constant-time token comparison, status code clamping, and Content-Length always derived from actual body size — matching the Swift server's security model. Both platforms are validated against 101 shared JSON test fixtures in test-fixtures/http/ covering header value extraction, request parsing (basic, error, incremental), multipart parsing (field-based, raw-body, error), and 8 dedicated UTF-8 edge cases (overlong encodings, lone surrogates, truncated sequences). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add demo app screens that start the local HTTP server and display its address for manual testing with curl or a browser. Enables on-device validation of the parser against adversarial inputs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Run the shared JSON test fixtures on an actual Android device via connectedDebugAndroidTest, validating the pure-Kotlin HTTP parser under ART in addition to the JVM unit tests. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
0a09c12 to
e8cda3c
Compare
dcalhoun
left a comment
There was a problem hiding this comment.
@jkmassel the testing instructions succeeded for me.
I also had Claude swiftly rebase #357 atop this work and update it to use the HTTP server library in this work. Good news is that it seems to work. The result of the work is in the feat/leverage-host-media-processing-stacked branch (here is the current diff).
I did encounter a couple of issues that I noted in inline comments below. I worked around them in the feat/leverage-host-media-processing-stacked branch, but we might address them in the library instead. WDYT?
|
|
||
| // Check auth before consuming body to avoid buffering | ||
| // up to maxRequestBodySize for unauthenticated clients. | ||
| if requiresAuthentication { |
There was a problem hiding this comment.
When requiresAuthentication is enabled, auth is checked on every request including OPTIONS. In practice this makes the server incompatible with any browser client using fetch(): browsers send a CORS preflight OPTIONS before the actual request, and the Fetch spec forbids auth headers on preflight — so it always gets rejected before the real request can be made.
Since OPTIONS responses contain no sensitive information (just allowed methods/headers), there's no security value in authenticating them. A simple exemption here would make the built-in auth usable from browser contexts without requiring callers to opt out entirely:
if requiresAuthentication && partial.method.uppercased() != "OPTIONS" {
guard authenticate(partial, token: token) else {
throw HTTPServerError.authenticationFailed
}
}Without this, callers who need to support browser clients must set requiresAuthentication: false and reimplement auth in their handler, losing the library's constant-time comparison and other protections.
Note: This applies to the Android implementation as well.
There was a problem hiding this comment.
Ah yep, this is a sensible change. c68a223 skips auth for OPTIONS
| /// Validates the proxy bearer token from the `Proxy-Authorization` header | ||
| /// (RFC 9110 §11.7.1). Using `Proxy-Authorization` keeps the client's | ||
| /// `Authorization` header available for upstream credentials. | ||
| private static func authenticate(_ request: ParsedHTTPRequest, token: String) -> Bool { | ||
| guard let proxyAuth = request.header("Proxy-Authorization") else { | ||
| return false | ||
| } | ||
|
|
||
| let prefix = "Bearer " | ||
| guard proxyAuth.prefix(prefix.count).caseInsensitiveCompare(prefix) == .orderedSame else { | ||
| return false | ||
| } | ||
|
|
||
| let provided = String(proxyAuth.dropFirst(prefix.count)) | ||
| return constantTimeEqual(provided, token) | ||
| } |
There was a problem hiding this comment.
The built-in auth uses Proxy-Authorization, which is a forbidden request header in the Fetch spec. WebKit's fetch() (and all standards-compliant browsers) silently strip it before sending — meaning any browser client using the built-in auth will always get a 407, with no error surfaced to the caller.
The RFC 9110 §11.7.1 rationale (keeping Authorization free for upstream credentials) is sound, but Proxy-Authorization is the wrong vehicle when the client is a browser. A custom header like X-GBKit-Token avoids the forbidden-header restriction while preserving the same separation of concerns.
Proposal: change the built-in auth to use a custom header (e.g. X-GBKit-Token) so it works correctly from browser contexts out of the box.
Note: This applies to the Android implementation as well.
There was a problem hiding this comment.
TIL about forbidden request headers. The reasoning seems sound though! 0f83848 adds the Relay-Authorization header (using X- as a prefix is deprecated).
What?
Adds a hardened, RFC-conformant HTTP/1.1 request parser and local proxy server for both iOS (Swift) and Android (Kotlin), with shared cross-platform test fixtures to guarantee behavioral parity.
Why?
GutenbergKit's native integration embeds a web editor that communicates with native networking through an in-process HTTP server. Because the server is exposed to JavaScript running in the WebView, the parser must be hardened against malformed and adversarial input per RFC 7230/9110/9112 — a lenient parser could enable request smuggling, header injection, or denial-of-service via resource exhaustion.
How?
Swift (iOS)
GutenbergKitHTTPmodule — Incremental, stateful parser (HTTPRequestParser) that buffers to a temporary file on disk so memory stays flat regardless of body size. Strict RFC conformance: rejects obs-fold, whitespace before colon, conflicting Content-Length, Transfer-Encoding, invalid UTF-8 (round-trip validated), lone surrogates, overlong encodings.HTTPServer— Local HTTP/1.1 server on Network.framework with async handler API, connection limits, read timeouts, and constant-time bearer token authentication.multipart/form-datasupport with lazy body references (file slices, not copies).RequestBody— Abstracts over in-memory and file-backed storage withInputStreamand asyncdataaccess.Kotlin (Android)
org.wordpress.gutenberg.http) — Feature-identical port of the Swift parser with no native dependencies. IncludesHeaderValue,HTTPRequestSerializer,HTTPRequestParser(with disk-backed buffering viaBuffer/TempFileOwner),ParsedHTTPRequest,MultipartPart, andRequestBody.HttpServer— Local HTTP/1.1 server with connection limits, read timeouts, pure-Kotlin response serialization, and proper 400 responses on premature connection close.Shared cross-platform test fixtures
test-fixtures/http/covering header value extraction (20 cases), request parsing (58 basic + 42 error + 4 incremental), and multipart parsing (32 field-based + 7 error).whitespaceBeforeColonerror (request smuggling vector per RFC 7230 §3.2.4).Key design decisions
Content-Lengthon both platforms (SwiftInt64, KotlinLong) with a 4 GB default max body size.inMemoryBodyThreshold(512 KB default) — bodies below threshold stay in memory, larger ones reference the temp file directly as a slice.Testing Instructions
Automated (CI runs these on every push)
swift test— runs 820+ tests including 163 fixture-based cross-platform testscd android && ./gradlew :Gutenberg:test— runs all Android unit tests including fixture testsOn-device (manual)
ios/Demo-iOS/Gutenberg.xcodeprojin Xcode, run on a device, navigate to the Media Proxy Server screen — it prints the server URLcd android && ./gradlew :Gutenberg:connectedDebugAndroidTest -Pandroid.testInstrumentationRunnerArguments.class=org.wordpress.gutenberg.http.InstrumentedFixtureTestsruns all 163 fixture cases on a connected device🤖 Generated with Claude Code