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.

Sign up for GitHub

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

Jump to bottom

Version check for serialized data headers #35376

Merged
merged 2 commits into from
Apr 8, 2020
Merged

Version check for serialized data headers #35376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef6d7a4
Version check for serialized data headers
c42f Apr 4, 2020
77c202f
Remove wordsize check
c42f Apr 7, 2020
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
36 changes: 33 additions & 3 deletions stdlib/Serialization/src/Serialization.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -685,6 +685,38 @@ function writeheader(s::AbstractSerializer)
nothing
end

function readheader(s::AbstractSerializer)
# Tag already read
io = s.io
m1 = read(io, UInt8)
m2 = read(io, UInt8)
if m1 != UInt8('J') || m2 != UInt8('L')
error("Unsupported serialization format (got header magic bytes $m1 $m2)")
end
version = read(io, UInt8)
flags = read(io, UInt8)
reserved1 = read(io, UInt8)
reserved2 = read(io, UInt8)
reserved3 = read(io, UInt8)
endianflag = flags & 0x3
wordflag = (flags >> 2) & 0x3
wordsize = wordflag == 0 ? 4 :
wordflag == 1 ? 8 :
error("Unknown word size flag in header")
endian_bom = endianflag == 0 ? 0x04030201 :
endianflag == 1 ? 0x01020304 :
error("Unknown endianness flag in header")
# Check protocol compatibility.
endian_bom == ENDIAN_BOM || error("Serialized byte order mismatch ($(repr(endian_bom)))")
# We don't check wordsize == sizeof(Int) here, as Int is encoded concretely
# as Int32 or Int64, which should be enough to correctly deserialize a range
# of data structures between Julia versions.
if version > ser_version
error("""Cannot read stream serialized with a newer version of Julia.
Got data version $version > current version $ser_version""")
end
end

"""
serialize(stream::IO, value)

Expand Down Expand Up @@ -843,9 +875,7 @@ function handle_deserialize(s::AbstractSerializer, b::Int32)
elseif b == LONGSYMBOL_TAG
return deserialize_symbol(s, Int(read(s.io, Int32)::Int32))
elseif b == HEADER_TAG
for _ = 1:7
read(s.io, UInt8)
end
readheader(s)
return deserialize(s)
elseif b == INT8_TAG
return read(s.io, Int8)
Expand Down
23 changes: 21 additions & 2 deletions stdlib/Serialization/test/runtests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -529,8 +529,8 @@ let x = T20324[T20324(1) for i = 1:2]
@test y == x
end

# serializer header
let io = IOBuffer()
@testset "serializer header" begin
io = IOBuffer()
serialize(io, ())
seekstart(io)
b = read(io)
Expand All @@ -541,6 +541,25 @@ let io = IOBuffer()
@test ((b[5] & 0xc)>>2) == (sizeof(Int) == 8)
@test (b[5] & 0xf0) == 0
@test all(b[6:8] .== 0)

# Detection of incompatible binary serializations
function corrupt_header(bytes, offset, val)
b = copy(bytes)
b[offset] = val
IOBuffer(b)
end
@test_throws(
ErrorException("""Cannot read stream serialized with a newer version of Julia.
Got data version 255 > current version $(Serialization.ser_version)"""),
deserialize(corrupt_header(b, 4, 0xff)))
@test_throws(ErrorException("Unknown word size flag in header"),
deserialize(corrupt_header(b, 5, 2<<2)))
@test_throws(ErrorException("Unknown endianness flag in header"),
deserialize(corrupt_header(b, 5, 2)))
other_wordsize = sizeof(Int) == 8 ? 4 : 8
other_endianness = bswap(ENDIAN_BOM)
@test_throws(ErrorException("Serialized byte order mismatch ($(repr(other_endianness)))"),
deserialize(corrupt_header(b, 5, UInt8(ENDIAN_BOM != 0x01020304))))
end

# issue #26979
Expand Down