Skip to content
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

During JSON parsing, validate @type to be minimally valid. #1742

Merged
merged 1 commit into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions Sources/Conformance/failure_list_swift.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
Required.Editions_Proto3.JsonInput.AnyWktRepresentationWithBadType # Should have failed to parse, but didn't.
Required.Editions_Proto3.JsonInput.AnyWktRepresentationWithEmptyTypeAndValue # Should have failed to parse, but didn't.
Required.Proto3.JsonInput.AnyWktRepresentationWithBadType # Should have failed to parse, but didn't.
Required.Proto3.JsonInput.AnyWktRepresentationWithEmptyTypeAndValue # Should have failed to parse, but didn't.
# No known failures.
7 changes: 7 additions & 0 deletions Sources/SwiftProtobuf/AnyMessageStorage.swift
Original file line number Diff line number Diff line change
Expand Up @@ -488,6 +488,13 @@ extension AnyMessageStorage {
try decoder.scanner.skipRequiredColon()
if key == "@type" {
_typeURL = try decoder.scanner.nextQuotedString()
// Spec for Any says this should contain atleast one slash. Looking at
// upstream languages, most actually look up the value in their runtime
// registries, but since we do deferred parsing, just do this minimal
// validation check.
guard _typeURL.contains("/") else {
throw SwiftProtobufError.JSONDecoding.invalidAnyTypeURL(type_url: _typeURL)
}
} else {
jsonEncoder.startField(name: key)
let keyValueJSON = try decoder.scanner.skip()
Expand Down
8 changes: 4 additions & 4 deletions Sources/SwiftProtobuf/Message+JSONAdditions.swift
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ extension Message {
///
/// - Parameter jsonString: The JSON-formatted string to decode.
/// - Parameter options: The JSONDecodingOptions to use.
/// - Throws: ``JSONDecodingError`` if decoding fails.
/// - Throws: ``SwiftProtobufError`` or ``JSONDecodingError`` if decoding fails.
public init(
jsonString: String,
options: JSONDecodingOptions = JSONDecodingOptions()
Expand All @@ -77,7 +77,7 @@ extension Message {
/// - Parameter jsonString: The JSON-formatted string to decode.
/// - Parameter extensions: An ExtensionMap for looking up extensions by name
/// - Parameter options: The JSONDecodingOptions to use.
/// - Throws: ``JSONDecodingError`` if decoding fails.
/// - Throws: ``SwiftProtobufError`` or ``JSONDecodingError`` if decoding fails.
public init(
jsonString: String,
extensions: (any ExtensionMap)? = nil,
Expand All @@ -100,7 +100,7 @@ extension Message {
/// - Parameter jsonUTF8Bytes: The JSON-formatted data to decode, represented
/// as UTF-8 encoded text.
/// - Parameter options: The JSONDecodingOptions to use.
/// - Throws: ``JSONDecodingError`` if decoding fails.
/// - Throws: ``SwiftProtobufError`` or ``JSONDecodingError`` if decoding fails.
public init<Bytes: SwiftProtobufContiguousBytes>(
jsonUTF8Bytes: Bytes,
options: JSONDecodingOptions = JSONDecodingOptions()
Expand All @@ -116,7 +116,7 @@ extension Message {
/// as UTF-8 encoded text.
/// - Parameter extensions: The extension map to use with this decode
/// - Parameter options: The JSONDecodingOptions to use.
/// - Throws: ``JSONDecodingError`` if decoding fails.
/// - Throws: ``SwiftProtobufError`` or ``JSONDecodingError`` if decoding fails.
public init<Bytes: SwiftProtobufContiguousBytes>(
jsonUTF8Bytes: Bytes,
extensions: (any ExtensionMap)? = nil,
Expand Down
6 changes: 3 additions & 3 deletions Sources/SwiftProtobuf/Message+JSONAdditions_Data.swift
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ extension Message {
/// - Parameter jsonUTF8Data: The JSON-formatted data to decode, represented
/// as UTF-8 encoded text.
/// - Parameter options: The JSONDecodingOptions to use.
/// - Throws: ``JSONDecodingError`` if decoding fails.
/// - Throws: ``SwiftProtobufError`` or ``JSONDecodingError`` if decoding fails.
public init(
jsonUTF8Data: Data,
options: JSONDecodingOptions = JSONDecodingOptions()
Expand All @@ -37,7 +37,7 @@ extension Message {
/// as UTF-8 encoded text.
/// - Parameter extensions: The extension map to use with this decode
/// - Parameter options: The JSONDecodingOptions to use.
/// - Throws: ``JSONDecodingError`` if decoding fails.
/// - Throws: ``SwiftProtobufError`` or ``JSONDecodingError`` if decoding fails.
public init(
jsonUTF8Data: Data,
extensions: (any ExtensionMap)? = nil,
Expand All @@ -54,7 +54,7 @@ extension Message {
/// - Returns: A Data containing the JSON serialization of the message.
/// - Parameters:
/// - options: The JSONEncodingOptions to use.
/// - Throws: ``JSONDecodingError`` if encoding fails.
/// - Throws: ``JSONEncodingError`` if encoding fails.
public func jsonUTF8Data(
options: JSONEncodingOptions = JSONEncodingOptions()
) throws -> Data {
Expand Down
8 changes: 4 additions & 4 deletions Sources/SwiftProtobuf/Message+JSONArrayAdditions.swift
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ extension Message {
///
/// - Parameter jsonString: The JSON-formatted string to decode.
/// - Parameter options: The JSONDecodingOptions to use.
/// - Throws: ``JSONDecodingError`` if decoding fails.
/// - Throws: ``SwiftProtobufError`` or ``JSONDecodingError`` if decoding fails.
public static func array(
fromJSONString jsonString: String,
options: JSONDecodingOptions = JSONDecodingOptions()
Expand All @@ -82,7 +82,7 @@ extension Message {
/// - Parameter jsonString: The JSON-formatted string to decode.
/// - Parameter extensions: The extension map to use with this decode
/// - Parameter options: The JSONDecodingOptions to use.
/// - Throws: ``JSONDecodingError`` if decoding fails.
/// - Throws: ``SwiftProtobufError`` or ``JSONDecodingError`` if decoding fails.
public static func array(
fromJSONString jsonString: String,
extensions: any ExtensionMap = SimpleExtensionMap(),
Expand All @@ -105,7 +105,7 @@ extension Message {
/// - Parameter jsonUTF8Bytes: The JSON-formatted data to decode, represented
/// as UTF-8 encoded text.
/// - Parameter options: The JSONDecodingOptions to use.
/// - Throws: ``JSONDecodingError`` if decoding fails.
/// - Throws: ``SwiftProtobufError`` or ``JSONDecodingError`` if decoding fails.
public static func array<Bytes: SwiftProtobufContiguousBytes>(
fromJSONUTF8Bytes jsonUTF8Bytes: Bytes,
options: JSONDecodingOptions = JSONDecodingOptions()
Expand All @@ -125,7 +125,7 @@ extension Message {
/// as UTF-8 encoded text.
/// - Parameter extensions: The extension map to use with this decode
/// - Parameter options: The JSONDecodingOptions to use.
/// - Throws: ``JSONDecodingError`` if decoding fails.
/// - Throws: ``SwiftProtobufError`` or ``JSONDecodingError`` if decoding fails.
public static func array<Bytes: SwiftProtobufContiguousBytes>(
fromJSONUTF8Bytes jsonUTF8Bytes: Bytes,
extensions: any ExtensionMap = SimpleExtensionMap(),
Expand Down
4 changes: 2 additions & 2 deletions Sources/SwiftProtobuf/Message+JSONArrayAdditions_Data.swift
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ extension Message {
/// - Parameter jsonUTF8Data: The JSON-formatted data to decode, represented
/// as UTF-8 encoded text.
/// - Parameter options: The JSONDecodingOptions to use.
/// - Throws: ``JSONDecodingError`` if decoding fails.
/// - Throws: ``SwiftProtobufError`` or ``JSONDecodingError`` if decoding fails.
public static func array(
fromJSONUTF8Data jsonUTF8Data: Data,
options: JSONDecodingOptions = JSONDecodingOptions()
Expand All @@ -43,7 +43,7 @@ extension Message {
/// as UTF-8 encoded text.
/// - Parameter extensions: The extension map to use with this decode
/// - Parameter options: The JSONDecodingOptions to use.
/// - Throws: ``JSONDecodingError`` if decoding fails.
/// - Throws: ``SwiftProtobufError`` or ``JSONDecodingError`` if decoding fails.
public static func array(
fromJSONUTF8Data jsonUTF8Data: Data,
extensions: any ExtensionMap = SimpleExtensionMap(),
Expand Down
28 changes: 28 additions & 0 deletions Sources/SwiftProtobuf/SwiftProtobufError.swift
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,16 @@ extension SwiftProtobufError {
private enum Wrapped: Hashable, Sendable, CustomStringConvertible {
case binaryDecodingError
case binaryStreamDecodingError
case jsonDecodingError

var description: String {
switch self {
case .binaryDecodingError:
return "Binary decoding error"
case .binaryStreamDecodingError:
return "Stream decoding error"
case .jsonDecodingError:
return "JSON decoding error"
}
}
}
Expand All @@ -122,6 +125,12 @@ extension SwiftProtobufError {
public static var binaryStreamDecodingError: Self {
Self(.binaryStreamDecodingError)
}

/// Errors arising from JSON decoding of data into protobufs.
public static var jsonDecodingError: Self {
Self(.jsonDecodingError)
}

}

/// A location within source code.
Expand Down Expand Up @@ -238,4 +247,23 @@ extension SwiftProtobufError {
)
}
}

/// Errors arising from JSON decoding of data into protobufs.
public enum JSONDecoding {
/// While decoding a `google.protobuf.Any` encountered a malformed `@type` key for
/// the `type_url` field.
public static func invalidAnyTypeURL(
type_url: String,
function: String = #function,
file: String = #fileID,
line: Int = #line
) -> SwiftProtobufError {
SwiftProtobufError(
code: .jsonDecodingError,
message: "google.protobuf.Any '@type' was invalid: \(type_url).",
location: SourceLocation(function: function, file: file, line: line)
)
}
}

}
30 changes: 30 additions & 0 deletions Tests/SwiftProtobufTests/Test_Any.swift
Original file line number Diff line number Diff line change
Expand Up @@ -873,6 +873,36 @@ final class Test_Any: XCTestCase {
XCTAssertEqual(rejson, start)
}

func test_Any_invalid() throws {
// These come from the upstream conformace tests.

// AnyWktRepresentationWithEmptyTypeAndValue
let emptyType = "{\"optional_any\":{\"@type\":\"\",\"value\":\"\"}}"
XCTAssertThrowsError(
try SwiftProtoTesting_Test3_TestAllTypesProto3(jsonString: emptyType)
) { error in
XCTAssertTrue(
self.isSwiftProtobufErrorEqual(
error as! SwiftProtobufError,
.JSONDecoding.invalidAnyTypeURL(type_url: "")
)
)
}

// AnyWktRepresentationWithBadType
let notAType = "{\"optional_any\":{\"@type\":\"not_a_url\",\"value\":\"\"}}"
XCTAssertThrowsError(
try SwiftProtoTesting_Test3_TestAllTypesProto3(jsonString: notAType)
) { error in
XCTAssertTrue(
self.isSwiftProtobufErrorEqual(
error as! SwiftProtobufError,
.JSONDecoding.invalidAnyTypeURL(type_url: "not_a_url")
)
)
}
}

func test_Any_nestedList() throws {
var start = "{\"optionalAny\":{\"x\":"
for _ in 0...10000 {
Expand Down
Loading