-
Notifications
You must be signed in to change notification settings - Fork 14
Add Oblivious DNS-over-HTTPS types and serialization #43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
706ef32
feat: add types and serialization for Oblivious DNS-over-HTTPS
yigityazicilar 7b5e59d
fix: apply review feedback to ODoH types and API
yigityazicilar e31d644
refactor: improve ODoH decoding API with proper error handling
yigityazicilar 1ccea7a
fix DocC comments as function signatures changed
yigityazicilar bc93496
docs: add DocC comments to public API.
yigityazicilar 67085b6
feat: add protocol conformance to errors
yigityazicilar 7ca45fe
Update Tests/ObliviousDoHTests/ObliviousDoHTests.swift
yigityazicilar be0245c
feat: add RawRepresentable conformance to MessageType
yigityazicilar File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,110 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the SwiftNIO open source project | ||
| // | ||
| // Copyright (c) 2025 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 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
| #if canImport(FoundationEssentials) | ||
| import FoundationEssentials | ||
| #else | ||
| import Foundation | ||
| #endif | ||
|
|
||
| /// An error occured when adding oblivious encapsulation. | ||
| public struct ObliviousDoHError: Error, Hashable { | ||
| private var backing: Backing | ||
|
|
||
| fileprivate init(backing: Backing) { | ||
| self.backing = backing | ||
| } | ||
|
|
||
| /// Create an error indicating that the HPKE parameters given were not supported. | ||
| /// - Returns: An Error representing this failure. | ||
| @inline(never) | ||
| public static var unsupportedHPKEParameters: Self { | ||
| Self.init(backing: .unsupportedHPKEParameters) | ||
| } | ||
|
|
||
| /// Create an error indicating that the ODoH data is malformed or invalid. | ||
| /// - Returns: An Error representing this failure. | ||
| @inline(never) | ||
| public static var invalidODoHData: Self { | ||
| Self.init(backing: .invalidODoHData) | ||
| } | ||
|
|
||
| /// Create an error indicating that the message type does not match expectations. | ||
| /// - Parameters: | ||
| /// - expected: The expected message type | ||
| /// - actual: The actual message type received | ||
| /// - Returns: An Error representing this type mismatch. | ||
| @inline(never) | ||
| public static func invalidMessageType( | ||
| expected: ODoH.Message.MessageType, | ||
| actual: ODoH.Message.MessageType | ||
| ) -> ObliviousDoHError { | ||
| Self.init(backing: .invalidMessageType(expected.rawValue, actual.rawValue)) | ||
| } | ||
|
|
||
| /// Create an error indicating that the public key is invalid for the given KEM ID. | ||
| /// - Parameters: | ||
| /// - kemID: The Key Encapsulation Mechanism identifier | ||
| /// - key: The invalid public key data | ||
| /// - Returns: An Error representing this key validation failure. | ||
| @inline(never) | ||
| public static func invalidPublicKey(kemID: UInt16, key: Data) -> ObliviousDoHError { | ||
| Self.init(backing: .invalidPublicKey(kemID, key)) | ||
| } | ||
|
|
||
| /// Create an error indicating that the ODoH message has an invalid length. | ||
| /// - Parameter length: The invalid length value | ||
| /// - Returns: An Error representing this length validation failure. | ||
| @inline(never) | ||
| public static func invalidODoHLength(length: Int) -> ObliviousDoHError { | ||
| Self.init(backing: .invalidODoHLength(length)) | ||
| } | ||
|
|
||
| /// Create an error indicating that the ODoH version is not supported. | ||
| /// - Parameter version: The unsupported version number | ||
| /// - Returns: An Error representing this version compatibility failure. | ||
| @inline(never) | ||
| public static func invalidODoHVersion(version: Int) -> ObliviousDoHError { | ||
| Self.init(backing: .invalidODoHVersion(version)) | ||
| } | ||
| } | ||
|
|
||
| extension ObliviousDoHError: CustomStringConvertible { | ||
| public var description: String { | ||
| switch self.backing { | ||
| case .unsupportedHPKEParameters: | ||
| return "Unsupported HPKE parameters" | ||
| case .invalidODoHData: | ||
| return "Invalid ODoH data format" | ||
| case .invalidMessageType(let expected, let actual): | ||
| return "Invalid message type: expected \(expected), got \(actual)" | ||
| case .invalidPublicKey(let kemID, let key): | ||
| return "Invalid public key for KEM ID \(kemID): \(key.count) bytes" | ||
| case .invalidODoHLength(let length): | ||
| return "Invalid ODoH message length: \(length)" | ||
| case .invalidODoHVersion(let version): | ||
| return "Unsupported ODoH version: \(version)" | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension ObliviousDoHError { | ||
| enum Backing: Hashable, Sendable { | ||
| case unsupportedHPKEParameters | ||
| case invalidODoHData | ||
| case invalidMessageType(UInt8, UInt8) | ||
| case invalidPublicKey(UInt16, Data) | ||
| case invalidODoHLength(Int) | ||
| case invalidODoHVersion(Int) | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.