/* * Copyright (c) 2020-2022, the SerenityOS developers. * Copyright (c) 2021, Idan Horowitz * * SPDX-License-Identifier: BSD-2-Clause */ #include #include #include #include namespace Compress { bool GzipDecompressor::is_likely_compressed(ReadonlyBytes bytes) { return bytes.size() >= 2 && bytes[0] == gzip_magic_1 && bytes[1] == gzip_magic_2; } bool BlockHeader::valid_magic_number() const { return identification_1 == gzip_magic_1 && identification_2 == gzip_magic_2; } bool BlockHeader::supported_by_implementation() const { if (compression_method != 0x08) { // RFC 1952 does not define any compression methods other than deflate. return false; } if (flags > Flags::MAX) { // RFC 1952 does not define any more flags. return false; } return true; } ErrorOr> GzipDecompressor::Member::construct(BlockHeader header, Stream& stream) { auto deflate_stream = TRY(DeflateDecompressor::construct(MaybeOwned(stream))); return TRY(adopt_nonnull_own_or_enomem(new (nothrow) Member(header, move(deflate_stream)))); } GzipDecompressor::Member::Member(BlockHeader header, NonnullOwnPtr stream) : m_header(header) , m_stream(move(stream)) { } GzipDecompressor::GzipDecompressor(NonnullOwnPtr stream) : m_input_stream(move(stream)) { } GzipDecompressor::~GzipDecompressor() { m_current_member.clear(); } ErrorOr GzipDecompressor::read(Bytes bytes) { size_t total_read = 0; while (total_read < bytes.size()) { if (is_eof()) break; auto slice = bytes.slice(total_read); if (m_current_member) { auto current_slice = TRY(current_member().m_stream->read(slice)); current_member().m_checksum.update(current_slice); current_member().m_nread += current_slice.size(); if (current_slice.size() < slice.size()) { LittleEndian crc32, input_size; TRY(m_input_stream->read(crc32.bytes())); TRY(m_input_stream->read(input_size.bytes())); if (crc32 != current_member().m_checksum.digest()) return Error::from_string_literal("Stored CRC32 does not match the calculated CRC32 of the current member"); if (input_size != current_member().m_nread) return Error::from_string_literal("Input size does not match the number of read bytes"); m_current_member.clear(); total_read += current_slice.size(); continue; } total_read += current_slice.size(); continue; } else { auto current_partial_header_slice = Bytes { m_partial_header, sizeof(BlockHeader) }.slice(m_partial_header_offset); auto current_partial_header_data = TRY(m_input_stream->read(current_partial_header_slice)); m_partial_header_offset += current_partial_header_data.size(); if (is_eof()) break; if (m_partial_header_offset < sizeof(BlockHeader)) { break; // partial header read } m_partial_header_offset = 0; BlockHeader header = *(reinterpret_cast(m_partial_header)); if (!header.valid_magic_number()) return Error::from_string_literal("Header does not have a valid magic number"); if (!header.supported_by_implementation()) return Error::from_string_literal("Header is not supported by implementation"); if (header.flags & Flags::FEXTRA) { LittleEndian subfield_id, length; TRY(m_input_stream->read(subfield_id.bytes())); TRY(m_input_stream->read(length.bytes())); TRY(m_input_stream->discard(length)); } auto discard_string = [&]() -> ErrorOr { char next_char; do { TRY(m_input_stream->read({ &next_char, sizeof(next_char) })); } while (next_char); return {}; }; if (header.flags & Flags::FNAME) TRY(discard_string()); if (header.flags & Flags::FCOMMENT) TRY(discard_string()); if (header.flags & Flags::FHCRC) { LittleEndian crc16; TRY(m_input_stream->read(crc16.bytes())); // FIXME: we should probably verify this instead of just assuming it matches } m_current_member = TRY(Member::construct(header, *m_input_stream)); continue; } } return bytes.slice(0, total_read); } Optional GzipDecompressor::describe_header(ReadonlyBytes bytes) { if (bytes.size() < sizeof(BlockHeader)) return {}; auto& header = *(reinterpret_cast(bytes.data())); if (!header.valid_magic_number() || !header.supported_by_implementation()) return {}; LittleEndian original_size = *reinterpret_cast(bytes.offset(bytes.size() - sizeof(u32))); return DeprecatedString::formatted("last modified: {}, original size {}", Core::DateTime::from_timestamp(header.modification_time).to_deprecated_string(), (u32)original_size); } ErrorOr GzipDecompressor::decompress_all(ReadonlyBytes bytes) { auto memory_stream = TRY(try_make(bytes)); auto gzip_stream = make(move(memory_stream)); AllocatingMemoryStream output_stream; auto buffer = TRY(ByteBuffer::create_uninitialized(4096)); while (!gzip_stream->is_eof()) { auto const data = TRY(gzip_stream->read(buffer)); TRY(output_stream.write_entire_buffer(data)); } auto output_buffer = TRY(ByteBuffer::create_uninitialized(output_stream.used_buffer_size())); TRY(output_stream.read_entire_buffer(output_buffer)); return output_buffer; } bool GzipDecompressor::is_eof() const { return m_input_stream->is_eof(); } ErrorOr GzipDecompressor::write(ReadonlyBytes) { return Error::from_errno(EBADF); } GzipCompressor::GzipCompressor(MaybeOwned stream) : m_output_stream(move(stream)) { } ErrorOr GzipCompressor::read(Bytes) { return Error::from_errno(EBADF); } ErrorOr GzipCompressor::write(ReadonlyBytes bytes) { BlockHeader header; header.identification_1 = 0x1f; header.identification_2 = 0x8b; header.compression_method = 0x08; header.flags = 0; header.modification_time = 0; header.extra_flags = 3; // DEFLATE sets 2 for maximum compression and 4 for minimum compression header.operating_system = 3; // unix TRY(m_output_stream->write_entire_buffer({ &header, sizeof(header) })); auto compressed_stream = TRY(DeflateCompressor::construct(MaybeOwned(*m_output_stream))); TRY(compressed_stream->write_entire_buffer(bytes)); TRY(compressed_stream->final_flush()); Crypto::Checksum::CRC32 crc32; crc32.update(bytes); LittleEndian digest = crc32.digest(); LittleEndian size = bytes.size(); TRY(m_output_stream->write_entire_buffer(digest.bytes())); TRY(m_output_stream->write_entire_buffer(size.bytes())); return bytes.size(); } bool GzipCompressor::is_eof() const { return true; } bool GzipCompressor::is_open() const { return m_output_stream->is_open(); } void GzipCompressor::close() { } ErrorOr GzipCompressor::compress_all(ReadonlyBytes bytes) { auto output_stream = TRY(try_make()); GzipCompressor gzip_stream { MaybeOwned(*output_stream) }; TRY(gzip_stream.write_entire_buffer(bytes)); auto buffer = TRY(ByteBuffer::create_uninitialized(output_stream->used_buffer_size())); TRY(output_stream->read_entire_buffer(buffer.bytes())); return buffer; } }