HTTPField.Name.init(parsed:) rejects uppercased names again (#155)
### Motivation #144 introduced a regression in `HTTPField.Name(parsed:)`. HTTP/2 and HTTP/3 require field names to be lowercased on the wire (RFC 9113 § 8.2.1, RFC 9114 § 4.1.2). Previously we enforced this by only accepting lowercase ASCII letters. In #144 we replaced a specific scan with `HTTPField.isValidToken`, which is shared in multiple token validation places and returns `valid` for uppercased names. We checked for `isValid`, which is true for `valid` as well as `canonical` representations. Allowing `valid` and not just `canonical` representations is the regression. This lead to this unwanted behavior: - `HTTPField.Name(parsed: "Content-Type")` now succeeds, so a decoder can no longer detect the malformed message it has to reject. - The returned name violates the documented invariant that `canonicalName` is lowercased, so it compares and hashes unequal to `HTTPField.Name("Content-Type")`, which does canonicalise. This path had no test coverage, so neither regression was caught. ### Changes Require `.canonical` rather than merely valid token validity in `init(parsed:)`, restoring the pre-#144 behavior, and document why. Add `HTTPFieldNameTests` covering both initializers: valid names, pseudo header fields, invalid characters, the mixed-case canonicalisation that `init(_:)` performs, and the uppercase rejection that `init(parsed:)` performs. ### Result `init(parsed:)` rejects uppercased names again and `canonicalName` is lowercased for every name it returns.
Swift HTTP Types
Swift HTTP Types are version-independent HTTP currency types designed for both clients and servers. They provide a common set of representations for HTTP requests and responses, focusing on modern HTTP features.
Getting Started
Add the following dependency clause to your Package.swift:
dependencies: [
.package(url: "https://github.com/apple/swift-http-types.git", from: "1.0.0")
]
The HTTPTypes library exposes the core HTTP currency types, including HTTPRequest, HTTPResponse, and HTTPFields, as well as the HTTP/2 and HTTP/3 error code types HTTP2ErrorCode and HTTP3ErrorCode.
The HTTPTypesFoundation library provides conveniences for using new HTTP types with Foundation, including bidirectional convertors between the new types and Foundation URL types, and URLSession convenience methods with the new types.
The NIOHTTPTypes, NIOHTTPTypesHTTP1, and NIOHTTPTypesHTTP2 libraries provide channel handlers for translating the version-specific NIO HTTP types with the new HTTP types. They can be found in swift-nio-extras.
Usage
Create a request
let request = HTTPRequest(method: .get, scheme: "https", authority: "www.example.com", path: "/")
Create a request from a Foundation URL
var request = HTTPRequest(method: .get, url: URL(string: "https://www.example.com/")!)
request.method = .post
request.path = "/upload"
Create a response
let response = HTTPResponse(status: .ok)
Access and modify header fields
extension HTTPField.Name {
static let myCustomHeader = Self("My-Custom-Header")!
}
// Set
request.headerFields[.userAgent] = "MyApp/1.0"
request.headerFields[.myCustomHeader] = "custom-value"
request.headerFields[values: .acceptLanguage] = ["en-US", "zh-Hans-CN"]
// Get
request.headerFields[.userAgent] // "MyApp/1.0"
request.headerFields[.myCustomHeader] // "custom-value"
request.headerFields[.acceptLanguage] // "en-US, zh-Hans-CN"
request.headerFields[values: .acceptLanguage] // ["en-US", "zh-Hans-CN"]
Use with URLSession
var request = HTTPRequest(method: .post, url: URL(string: "https://www.example.com/upload")!)
request.headerFields[.userAgent] = "MyApp/1.0"
let (responseBody, response) = try await URLSession.shared.upload(for: request, from: requestBody)
guard response.status == .created else {
// Handle error
}
Use with SwiftNIO
channel.configureHTTP2Pipeline(mode: .server) { channel in
channel.pipeline.addHandlers([
HTTP2FramePayloadToHTTPServerCodec(),
ExampleChannelHandler()
])
}.map { _ in () }
final class ExampleChannelHandler: ChannelDuplexHandler {
typealias InboundIn = HTTPTypeServerRequestPart
typealias OutboundOut = HTTPTypeServerResponsePart
func channelRead(context: ChannelHandlerContext, data: NIOAny) {
switch unwrapInboundIn(data) {
case .head(let request):
// Handle request headers
case .body(let body):
// Handle request body
case .end(let trailers):
// Handle complete request
let response = HTTPResponse(status: .ok)
context.write(wrapOutboundOut(.head(response)), promise: nil)
context.writeAndFlush(wrapOutboundOut(.end(nil)), promise: nil)
}
}
}
Developing HTTP Types
For the most part, HTTP Types development is as straightforward as any other SwiftPM project. With that said, we do have a few processes that are worth understanding before you contribute. For details, please see CONTRIBUTING.md in this repository.
Please note that all work on HTTP Types is covered by the Swift HTTP Types Code of Conduct.