Implementation of HPACK encoding and header tables

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "hpack-test-case"]
+	path = hpack-test-case
+	url = [email protected]:http2jp/hpack-test-case

.mailmap

@@ -1,3 +1,4 @@
 Johannes Weiß <[email protected]>
 <[email protected]> <[email protected]>
 <[email protected]> <[email protected]>
+<[email protected]> <[email protected]>

CONTRIBUTORS.txt

@@ -12,7 +12,11 @@ needs to be listed here.
 ### Contributors
 
 - Cory Benfield <[email protected]>
+- Jim Dovey <[email protected]>
+- Johannes Weiß <[email protected]>
 - Johannes Weiß <[email protected]>
+- Tim <[email protected]>
+- tomer doron <[email protected]>
 
 **Updating this list**
 

Package.swift

@@ -19,10 +19,10 @@ let package = Package(
     name: "swift-nio-http2",
     products: [
         .executable(name: "NIOHTTP2Server", targets: ["NIOHTTP2Server"]),
-        .library(name: "NIOHTTP2", targets: ["NIOHTTP2"])
+        .library(name: "NIOHTTP2", targets: ["NIOHTTP2"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-nio.git", from: "1.7.0"),
+        .package(url: "https://github.com/apple/swift-nio.git", from: "1.9.0"),
         .package(url: "https://github.com/apple/swift-nio-nghttp2-support.git", from: "1.0.0"),
     ],
     targets: [
@@ -31,7 +31,11 @@ let package = Package(
             dependencies: ["NIOHTTP2"]),
         .target(name: "NIOHTTP2",
             dependencies: ["NIO", "NIOHTTP1", "NIOTLS", "CNIONghttp2"]),
+        .target(name: "NIOHPACK",
+            dependencies: ["NIO", "NIOConcurrencyHelpers", "NIOHTTP1"]),
         .testTarget(name: "NIOHTTP2Tests",
             dependencies: ["NIO", "NIOHTTP1", "NIOHTTP2"]),
+        .testTarget(name: "NIOHPACKTests",
+            dependencies: ["NIOHPACK"])
     ]
 )

Sources/NIOHPACK/DynamicHeaderTable.swift

@@ -0,0 +1,177 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the SwiftNIO open source project
+//
+// Copyright (c) 2017-2018 Apple Inc. and the SwiftNIO project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of SwiftNIO project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import NIO
+
+/// Implements the dynamic part of the HPACK header table, as defined in
+/// [RFC 7541 § 2.3](https://httpwg.org/specs/rfc7541.html#dynamic.table).
+struct DynamicHeaderTable {
+    public static let defaultSize = 4096
+
+    /// The actual table, with items looked up by index.
+    private var storage: HeaderTableStorage
+
+    /// The length of the contents of the table.
+    var length: Int {
+        return self.storage.length
+    }
+
+    /// The size to which the dynamic table may currently grow. Represents
+    /// the current maximum length signaled by the peer via a table-resize
+    /// value at the start of an encoded header block.
+    ///
+    /// - note: This value cannot exceed `self.maximumTableLength`.
+    var allowedLength: Int {
+        get {
+            return self.storage.maxSize
+        }
+        set {
+            self.storage.setTableSize(to: newValue)
+        }
+    }
+
+    /// The maximum permitted size of the dynamic header table as set
+    /// through a SETTINGS_HEADER_TABLE_SIZE value in a SETTINGS frame.
+    var maximumTableLength: Int {
+        didSet {
+            if self.allowedLength > maximumTableLength {
+                self.allowedLength = maximumTableLength
+            }
+        }
+    }
+
+    /// The number of items in the table.
+    var count: Int {
+        return self.storage.count
+    }
+
+    init(allocator: ByteBufferAllocator, maximumLength: Int = DynamicHeaderTable.defaultSize) {
+        self.storage = HeaderTableStorage(allocator: allocator, maxSize: maximumLength)
+        self.maximumTableLength = maximumLength
+        self.allowedLength = maximumLength  // until we're told otherwise, this is what we assume the other side expects.
+    }
+
+    /// Subscripts into the dynamic table alone, using a zero-based index.
+    subscript(i: Int) -> HeaderTableEntry {
+        return self.storage[i]
+    }
+
+    func view(of index: HPACKHeaderIndex) -> ByteBufferView {
+        return self.storage.view(of: index)
+    }
+
+    // internal for testing
+    func dumpHeaders() -> String {
+        return self.storage.dumpHeaders(offsetBy: StaticHeaderTable.count)
+    }
+
+    // internal for testing -- clears the dynamic table
+    mutating func clear() {
+        self.storage.purge(toRelease: self.storage.length)
+    }
+
+    /// Searches the table for a matching header, optionally with a particular value. If
+    /// a match is found, returns the index of the item and an indication whether it contained
+    /// the matching value as well.
+    ///
+    /// Invariants: If `value` is `nil`, result `containsValue` is `false`.
+    ///
+    /// - Parameters:
+    ///   - name: The name of the header for which to search.
+    ///   - value: Optional value for the header to find. Default is `nil`.
+    /// - Returns: A tuple containing the matching index and, if a value was specified as a
+    ///            parameter, an indication whether that value was also found. Returns `nil`
+    ///            if no matching header name could be located.
+    @_specialize(where Name == String.UTF8View, Value == String.UTF8View)   // from String-based API
+    @_specialize(where Name == ByteBufferView, Value == ByteBufferView)     // from HPACKHeaders-based API
+    func findExistingHeader<Name: Collection, Value: Collection>(named name: Name, value: Value?) -> (index: Int, containsValue: Bool)? where Name.Element == UInt8, Value.Element == UInt8 {
+        // looking for both name and value, but can settle for just name if no value
+        // has been provided. Return the first matching name (lowest index) in that case.
+        guard let value = value else {
+            // no `first` on AnySequence, just `first(where:)`
+            return self.storage.firstIndex(matching: name).map { ($0, false) }
+        }
+
+        // If we have a value, locate the index of the lowest header which contains that
+        // value, but if no value matches, return the index of the lowest header with a
+        // matching name alone.
+        var firstNameMatch: Int? = nil
+        for index in self.storage.indices(matching: name) {
+            if firstNameMatch == nil {
+                // record the first (most recent) index with a matching header name,
+                // in case there's no value match.
+                firstNameMatch = index
+            }
+
+            if self.storage.view(of: self.storage[index].value).matches(value) {
+                // this entry has both the name and the value we're seeking
+                return (index, true)
+            }
+        }
+
+        // no value matches -- but did we find a name?
+        if let index = firstNameMatch {
+            return (index, false)
+        } else {
+            // no matches at all
+            return nil
+        }
+    }
+
+    /// Appends a header to the table. Note that if this succeeds, the new item's index
+    /// is always zero.
+    ///
+    /// This call may result in an empty table, as per RFC 7541 § 4.4:
+    /// > "It is not an error to attempt to add an entry that is larger than the maximum size;
+    /// > an attempt to add an entry larger than the maximum size causes the table to be
+    /// > emptied of all existing entries and results in an empty table."
+    ///
+    /// - Parameters:
+    ///   - name: A collection of UTF-8 code points comprising the name of the header to insert.
+    ///   - value: A collection of UTF-8 code points comprising the value of the header to insert.
+    /// - Returns: `true` if the header was added to the table, `false` if not.
+    @_specialize(where Name == String.UTF8View, Value == String.UTF8View)   // from String-based API
+    mutating func addHeader<Name: Collection, Value: Collection>(named name: Name, value: Value) throws where Name.Element == UInt8, Value.Element == UInt8 {
+        do {
+            try self.storage.add(name: name, value: value)
+        } catch let error as RingBufferError.BufferOverrun {
+            // ping the error up the stack, with more information
+            throw NIOHPACKErrors.FailedToAddIndexedHeader(bytesNeeded: self.storage.length + error.amount,
+                                                          name: name, value: value)
+        }
+    }
+
+    /// Appends a header to the table. Note that if this succeeds, the new item's index
+    /// is always zero.
+    ///
+    /// This call may result in an empty table, as per RFC 7541 § 4.4:
+    /// > "It is not an error to attempt to add an entry that is larger than the maximum size;
+    /// > an attempt to add an entry larger than the maximum size causes the table to be
+    /// > emptied of all existing entries and results in an empty table."
+    ///
+    /// - Parameters:
+    ///   - name: A contiguous collection of UTF-8 bytes comprising the name of the header to insert.
+    ///   - value: A contiguous collection of UTF-8 bytes comprising the value of the header to insert.
+    /// - Returns: `true` if the header was added to the table, `false` if not.
+    @_specialize(where Name == ByteBufferView, Value == ByteBufferView)     // from HPACKHeaders-based API
+    mutating func addHeader<Name: ContiguousCollection, Value: ContiguousCollection>(nameBytes: Name, valueBytes: Value) throws where Name.Element == UInt8, Value.Element == UInt8 {
+        do {
+            try self.storage.add(nameBytes: nameBytes, valueBytes: valueBytes)
+        } catch let error as RingBufferError.BufferOverrun {
+            // convert the error to something more useful/meaningful to client code.
+            throw NIOHPACKErrors.FailedToAddIndexedHeader(bytesNeeded: self.storage.length + error.amount,
+                                                          name: nameBytes, value: valueBytes)
+        }
+    }
+}