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

Fix crash in BinaryDataDecoder when decoding values from misaligned memory. #58

Merged
merged 2 commits into from Jul 5, 2020
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -124,10 +124,13 @@ private class BinaryDataDecodingContainer: BinaryDecodingContainer {
throw BinaryDecodingError.dataCorrupted(.init(debugDescription:
"Not enough data to create a a type of \(type). Needed: \(byteWidth). Received: \(bytes.count)."))
}
let value = bytes.withUnsafeBytes { ptr -> T in
return ptr.load(as: T.self)
return bytes.withUnsafeBytes { ptr in
var value: T = 0
withUnsafeMutableBytes(of: &value) { valuePtr in
valuePtr.copyMemory(from: UnsafeRawBufferPointer(rebasing: ptr[0..<ptr.count]))
}
return value
}
return value
}

func decodeString(encoding: String.Encoding, terminator: UInt8?) throws -> String {
Expand Down
40 changes: 40 additions & 0 deletions Tests/BinaryCodableTests/MisalignedDecoderTests.swift
@@ -0,0 +1,40 @@
// Copyright 2020-present the BinaryCodable authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import BinaryCodable
import XCTest

private struct MisalignedPacket: BinaryDecodable {
let twoByteInt: UInt16
init(from decoder: BinaryDecoder) throws {
var container = decoder.container(maxLength: nil)
_ = try container.decode(length: 1)
self.twoByteInt = try container.decode(UInt16.self)
}
}

final class MisalignedDecoderTests: XCTestCase {

func testEmpty() throws {
// Given
let packetData: [UInt8] = [0, 3, 0]
let decoder = BinaryDataDecoder()

// When
let packet = try decoder.decode(MisalignedPacket.self, from: packetData)

// Then
XCTAssertEqual(packet.twoByteInt, 3)
}
}