-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add UTF8 validation * Add UTF8 validation * Wrap validation code in compiler(>=6) * Disable some tests for swift 5.10 * Duplicate API being submitted to SwiftNIO * Update docs to use WSCore * Update Sources/WSCore/ByteBuffer+validatingString.swift Co-authored-by: Joannis Orlandos <[email protected]> * Minor updates * Fix CI --------- Co-authored-by: Joannis Orlandos <[email protected]>
- Loading branch information
1 parent
7c53f09
commit fee8d4f
Showing
11 changed files
with
195 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Hummingbird server framework project | ||
| // | ||
| // Copyright (c) 2024 the Hummingbird authors | ||
| // Licensed under Apache License v2.0 | ||
| // | ||
| // See LICENSE.txt for license information | ||
| // See hummingbird/CONTRIBUTORS.txt for the list of Hummingbird authors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| import NIOCore | ||
|
|
||
| #if compiler(>=6) | ||
| extension ByteBuffer { | ||
| /// Get the string at `index` from this `ByteBuffer` decoding using the UTF-8 encoding. Does not move the reader index. | ||
| /// The selected bytes must be readable or else `nil` will be returned. | ||
| /// | ||
| /// This is an alternative to `ByteBuffer.getString(at:length:)` which ensures the returned string is valid UTF8. If the | ||
| /// string is not valid UTF8 then a `ReadUTF8ValidationError` error is thrown. | ||
| /// | ||
| /// - Parameters: | ||
| /// - index: The starting index into `ByteBuffer` containing the string of interest. | ||
| /// - length: The number of bytes making up the string. | ||
| /// - Returns: A `String` value containing the UTF-8 decoded selected bytes from this `ByteBuffer` or `nil` if | ||
| /// the requested bytes are not readable. | ||
| @inlinable | ||
| @available(macOS 15, iOS 18, tvOS 18, watchOS 11, *) | ||
| public func getUTF8ValidatedString(at index: Int, length: Int) throws -> String? { | ||
| guard let range = self.rangeWithinReadableBytes(index: index, length: length) else { | ||
| return nil | ||
| } | ||
| return try self.withUnsafeReadableBytes { pointer in | ||
| assert(range.lowerBound >= 0 && (range.upperBound - range.lowerBound) <= pointer.count) | ||
| guard | ||
| let string = String( | ||
| validating: UnsafeRawBufferPointer(fastRebase: pointer[range]), | ||
| as: Unicode.UTF8.self | ||
| ) | ||
| else { | ||
| throw ReadUTF8ValidationError.invalidUTF8 | ||
| } | ||
| return string | ||
| } | ||
| } | ||
|
|
||
| /// Read `length` bytes off this `ByteBuffer`, decoding it as `String` using the UTF-8 encoding. Move the reader index | ||
| /// forward by `length`. | ||
| /// | ||
| /// This is an alternative to `ByteBuffer.readString(length:)` which ensures the returned string is valid UTF8. If the | ||
| /// string is not valid UTF8 then a `ReadUTF8ValidationError` error is thrown and the reader index is not advanced. | ||
| /// | ||
| /// - Parameters: | ||
| /// - length: The number of bytes making up the string. | ||
| /// - Returns: A `String` value deserialized from this `ByteBuffer` or `nil` if there aren't at least `length` bytes readable. | ||
| @inlinable | ||
| @available(macOS 15, iOS 18, tvOS 18, watchOS 11, *) | ||
| public mutating func readUTF8ValidatedString(length: Int) throws -> String? { | ||
| guard let result = try self.getUTF8ValidatedString(at: self.readerIndex, length: length) else { | ||
| return nil | ||
| } | ||
| self.moveReaderIndex(forwardBy: length) | ||
| return result | ||
| } | ||
|
|
||
| /// Errors thrown when calling `readUTF8ValidatedString` or `getUTF8ValidatedString`. | ||
| public struct ReadUTF8ValidationError: Error, Equatable { | ||
| private enum BaseError: Hashable { | ||
| case invalidUTF8 | ||
| } | ||
|
|
||
| private var baseError: BaseError | ||
|
|
||
| /// The length of the bytes to copy was negative. | ||
| public static let invalidUTF8: ReadUTF8ValidationError = .init(baseError: .invalidUTF8) | ||
| } | ||
|
|
||
| @inlinable | ||
| func rangeWithinReadableBytes(index: Int, length: Int) -> Range<Int>? { | ||
| guard index >= self.readerIndex, length >= 0 else { | ||
| return nil | ||
| } | ||
|
|
||
| // both these &-s are safe, they can't underflow because both left & right side are >= 0 (and index >= readerIndex) | ||
| let indexFromReaderIndex = index &- self.readerIndex | ||
| assert(indexFromReaderIndex >= 0) | ||
| guard indexFromReaderIndex <= self.readableBytes &- length else { | ||
| return nil | ||
| } | ||
|
|
||
| let upperBound = indexFromReaderIndex &+ length // safe, can't overflow, we checked it above. | ||
|
|
||
| // uncheckedBounds is safe because `length` is >= 0, so the lower bound will always be lower/equal to upper | ||
| return Range<Int>(uncheckedBounds: (lower: indexFromReaderIndex, upper: upperBound)) | ||
| } | ||
| } | ||
|
|
||
| extension UnsafeRawBufferPointer { | ||
| @inlinable | ||
| init(fastRebase slice: Slice<UnsafeRawBufferPointer>) { | ||
| let base = slice.base.baseAddress?.advanced(by: slice.startIndex) | ||
| self.init(start: base, count: slice.endIndex &- slice.startIndex) | ||
| } | ||
| } | ||
|
|
||
| #endif // compiler(>=6) | ||
|
|
||
| extension String { | ||
| init?(buffer: ByteBuffer, validateUTF8: Bool) { | ||
| #if compiler(>=6) | ||
| if #available(macOS 15, iOS 18, tvOS 18, watchOS 11, *), validateUTF8 { | ||
| do { | ||
| var buffer = buffer | ||
| self = try buffer.readUTF8ValidatedString(length: buffer.readableBytes)! | ||
| } catch { | ||
| return nil | ||
| } | ||
| } else { | ||
| self = .init(buffer: buffer) | ||
| } | ||
| #else | ||
| self = .init(buffer: buffer) | ||
| #endif // compiler(>=6) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters