mirror of
https://github.com/apple/swift-http-types
synced 2026-11-22 04:30:40 +00:00
198 lines
6.8 KiB
Swift
198 lines
6.8 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift open source project
|
|
//
|
|
// Copyright (c) 2023 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0
|
|
//
|
|
// See LICENSE.txt for license information
|
|
// See CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
/// A name-value pair with additional metadata.
|
|
///
|
|
/// The field name is a case-insensitive but case-preserving ASCII string; the field value is a
|
|
/// collection of bytes.
|
|
public struct HTTPField: Sendable, Hashable {
|
|
/// The strategy for whether the field is indexed in the HPACK or QPACK dynamic table.
|
|
public struct DynamicTableIndexingStrategy: Sendable, Hashable {
|
|
/// Default strategy.
|
|
public static var automatic: Self { .init(rawValue: 0) }
|
|
|
|
/// Always put this field in the dynamic table if possible.
|
|
public static var prefer: Self { .init(rawValue: 1) }
|
|
|
|
/// Don't put this field in the dynamic table.
|
|
public static var avoid: Self { .init(rawValue: 2) }
|
|
|
|
/// Don't put this field in the dynamic table, and set a flag to disallow intermediaries to
|
|
/// index this field.
|
|
public static var disallow: Self { .init(rawValue: 3) }
|
|
|
|
private let rawValue: UInt8
|
|
}
|
|
|
|
/// Create an HTTP field from a name and a value.
|
|
/// - Parameters:
|
|
/// - name: The HTTP field name.
|
|
/// - value: The HTTP field value is initialized from the UTF-8 encoded bytes of the string.
|
|
/// Invalid bytes are converted into space characters.
|
|
public init(name: Name, value: String) {
|
|
self.name = name
|
|
self.rawValue = Self.legalizeValue(ISOLatin1String(value))
|
|
}
|
|
|
|
/// Create an HTTP field from a name and a value.
|
|
/// - Parameters:
|
|
/// - name: The HTTP field name.
|
|
/// - value: The HTTP field value. Invalid bytes are converted into space characters.
|
|
public init(name: Name, value: some Collection<UInt8>) {
|
|
self.name = name
|
|
self.rawValue = Self.legalizeValue(ISOLatin1String(value))
|
|
}
|
|
|
|
init(name: Name, uncheckedValue: ISOLatin1String) {
|
|
self.name = name
|
|
self.rawValue = uncheckedValue
|
|
}
|
|
|
|
/// The HTTP field name.
|
|
public var name: Name
|
|
|
|
/// The HTTP field value as a UTF-8 string.
|
|
///
|
|
/// When setting the value, invalid bytes (defined in RFC 9110) are converted into space characters.
|
|
///
|
|
/// https://www.rfc-editor.org/rfc/rfc9110.html#name-field-values
|
|
///
|
|
/// If the field is not UTF-8 encoded, `withUnsafeBytesOfValue` can be used to access the
|
|
/// underlying bytes of the field value.
|
|
public var value: String {
|
|
get {
|
|
self.rawValue.string
|
|
}
|
|
set {
|
|
self.rawValue = Self.legalizeValue(ISOLatin1String(newValue))
|
|
}
|
|
}
|
|
|
|
/// Runs `body` over the raw HTTP field value bytes as a contiguous buffer.
|
|
///
|
|
/// This function is useful if the field is not UTF-8 encoded and the default `value` view
|
|
/// cannot be used.
|
|
///
|
|
/// Note that it is unsafe to escape the buffer pointer beyond the duration of this call.
|
|
///
|
|
/// - Parameter body: The closure to be invoked with the buffer.
|
|
/// - Returns: Result of the `body` closure.
|
|
public func withUnsafeBytesOfValue<Result>(_ body: (UnsafeBufferPointer<UInt8>) throws -> Result) rethrows -> Result {
|
|
try self.rawValue.withUnsafeBytes(body)
|
|
}
|
|
|
|
/// The strategy for whether the field is indexed in the HPACK or QPACK dynamic table.
|
|
public var indexingStrategy: DynamicTableIndexingStrategy = .automatic
|
|
|
|
var rawValue: ISOLatin1String
|
|
|
|
private static func _isValidValue(_ bytes: some Sequence<UInt8>) -> Bool {
|
|
var iterator = bytes.makeIterator()
|
|
guard var byte = iterator.next() else {
|
|
// Empty string is allowed.
|
|
return true
|
|
}
|
|
if byte == 0x09 || byte == 0x20 {
|
|
// First character cannot be a space or a tab.
|
|
return false
|
|
}
|
|
while true {
|
|
switch byte {
|
|
case 0x09, 0x20:
|
|
break
|
|
case 0x21 ... 0x7E, 0x80 ... 0xFF:
|
|
break
|
|
default:
|
|
return false
|
|
}
|
|
if let next = iterator.next() {
|
|
byte = next
|
|
} else {
|
|
break
|
|
}
|
|
}
|
|
if byte == 0x09 || byte == 0x20 {
|
|
// Last character cannot be a space or a tab.
|
|
return false
|
|
}
|
|
return true
|
|
}
|
|
|
|
static func legalizeValue(_ value: ISOLatin1String) -> ISOLatin1String {
|
|
if Self._isValidValue(value._storage.utf8) {
|
|
return value
|
|
} else {
|
|
let bytes = value._storage.utf8.lazy.map { byte -> UInt8 in
|
|
switch byte {
|
|
case 0x09, 0x20:
|
|
return byte
|
|
case 0x21 ... 0x7E, 0x80 ... 0xFF:
|
|
return byte
|
|
default:
|
|
return 0x20
|
|
}
|
|
}
|
|
let trimmed = bytes.reversed().drop { $0 == 0x09 || $0 == 0x20 }.reversed().drop { $0 == 0x09 || $0 == 0x20 }
|
|
return ISOLatin1String(unchecked: String(decoding: trimmed, as: UTF8.self))
|
|
}
|
|
}
|
|
|
|
/// Whether the string is valid for an HTTP field value based on RFC 9110.
|
|
///
|
|
/// https://www.rfc-editor.org/rfc/rfc9110.html#name-field-values
|
|
///
|
|
/// - Parameter value: The string to validate.
|
|
/// - Returns: Whether the string is valid.
|
|
public static func isValidValue(_ value: String) -> Bool {
|
|
self._isValidValue(value.utf8)
|
|
}
|
|
|
|
/// Whether the byte collection is valid for an HTTP field value based on RFC 9110.
|
|
///
|
|
/// https://www.rfc-editor.org/rfc/rfc9110.html#name-field-values
|
|
///
|
|
/// - Parameter value: The byte collection to validate.
|
|
/// - Returns: Whether the byte collection is valid.
|
|
public static func isValidValue(_ value: some Collection<UInt8>) -> Bool {
|
|
self._isValidValue(value)
|
|
}
|
|
}
|
|
|
|
extension HTTPField: CustomStringConvertible {
|
|
public var description: String {
|
|
"\(self.name): \(self.value)"
|
|
}
|
|
}
|
|
|
|
extension HTTPField: CustomPlaygroundDisplayConvertible {
|
|
public var playgroundDescription: Any {
|
|
self.description
|
|
}
|
|
}
|
|
|
|
extension HTTPField {
|
|
static func isValidToken(_ token: String) -> Bool {
|
|
!token.isEmpty && token.utf8.allSatisfy {
|
|
switch $0 {
|
|
case 0x21, 0x23, 0x24, 0x25, 0x26, 0x27, 0x2A, 0x2B, 0x2D, 0x2E, 0x5E, 0x5F, 0x60, 0x7C, 0x7E:
|
|
return true
|
|
case 0x30 ... 0x39, 0x41 ... 0x5A, 0x61 ... 0x7A: // DIGHT, ALPHA
|
|
return true
|
|
default:
|
|
return false
|
|
}
|
|
}
|
|
}
|
|
}
|