tests/files/README

   1
   2 .lzma Test Files
   3 ----------------
   4
   5 0. Introduction
   6
   7     This directory contains bunch of files to test handling of .lzma files
   8     in .lzma decoder implementations. Many of the files have been created
   9     by hand with a hex editor, thus there is no better "source code" than
  10     the files themselves. All the test files (*.lzma) and this README have
  11     been put into the public domain.
  12
  13
  14 1. File Types
  15
  16     Good files (good-*.lzma) must decode successfully without requiring
  17     a lot of CPU time or RAM. If the decoder supports only Single-Block
  18     Streams, then good-multi-*.lzma won't decode, of course.
  19
  20     Bad files (bad-*.lzma) must cause the decoder to give an error. Like
  21     with the good files, these files must not require a lot of CPU time
  22     or RAM before they get detected to be broken.
  23
  24     Malicious files (malicious-*.lzma) are good in terms of the file format
  25     specification, but try to trigger excessive CPU, RAM or disk usage in
  26     the decoder. To prevent malicious files from putting the decoder in
  27     inifinite loop (*), eating all available RAM or disk space, decoders
  28     should have internal limitters that catch these situations.
  29
  30     (*) Strictly speaking not infinite, but if decoding of a small file
  31         would take a few weeks or even years, it's an infinite loop in
  32         practice.
  33
  34
  35 2. Descriptions of Individual Files
  36
  37 2.1. Good Files
  38
  39     good-single-none.lzma uses implicit Copy filter with known Uncompressed
  40     Size.
  41
  42     good-single-none-pad.lzma is good-single-none.lzma with Footer Padding.
  43
  44     good-cat-single-none-pad.lzma is two good-single-none-pad.lzma files
  45     concatenated as is. Fully decoding this file requires that the decoder
  46     supports decoding concatenated files.
  47
  48     good-single-subblock_implicit.lzma uses implicit Subblock filter.
  49
  50     good-single-lzma.lzma is LZMA compressed file with EOPM.
  51
  52     good-single-subblock-lzma.lzma has basic combination of Subblock and
  53     LZMA filters.
  54
  55     good-single-none-empty_1.lzma is an empty file with implicit Copy
  56     filter and no integrity Check.
  57
  58     good-single-none-empty_2.lzma is an empty file with implicit Copy
  59     filter and CRC32 as Check.
  60
  61     good-single-none-empty_3.lzma is an empty file with implicit Copy
  62     filter, known Compressed Size, and no integrity Check.
  63
  64     good-single-lzma-empty.lzma is an empty file with LZMA filter and no
  65     integrity Check.
  66
  67     good-single-subblock_rle.lzma takes advantage of Subblock filter's
  68     run-length encoding.
  69
  70     good-single-delta-lzma.tiff.lzma is an image file that compresses
  71     better with Delta+LZMA than with plain LZMA.
  72
  73     good-single-lzma-flush_1.lzma has a flush marker in the middle of
  74     the file, and no EOPM.
  75
  76     good-single-lzma-flush_2.lzma has a flush marker in the middle of
  77     the file and just before EOPM.
  78
  79     good-multi-none-1.lzma is a basic Multi-Block Stream with two Data
  80     Blocks and Footer Metadata Block.
  81
  82     good-multi-none-2.lzma is good-multi-none-1.lzma with Total Size and
  83     Uncompressed Size added to the Footer Metadata Block.
  84
  85     good-multi-none-extra_1.lzma has the `Extra is present' flag set but
  86     no actual Extra Records.
  87
  88     good-multi-none-extra_2.lzma has two non-empty Extra Records.
  89
  90     good-multi-none-extra_3.lzma has an Extra Record that has empty Data.
  91
  92     good-multi-none-header_1.lzma has very minimal Header Metadata Block
  93     with only the Metadata Flags field.
  94
  95     good-multi-none-header_2.lzma has all information in both Header and
  96     Footer Metadata Blocks. The Size of Header Metadata Block has wrong
  97     value in Header Metadata Block, but this value must be ignored by
  98     the decoder in case of Header Metadata Block.
  99
 100     good-multi-none-header_3.lzma has Index only in the Header Metadata
 101     Block. Footer Metadata Block contains only Size of Header Metadata
 102     Block and Total Size.
 103
 104     good-multi-none-block_1.lzma has Index in Header Metadata Block. The
 105     Compressed Size and Uncompressed Size fields are present in the Data
 106     Blocks. There is some Footer Padding between the Blocks.
 107
 108
 109 2.2. Bad Files
 110
 111     bad-single-none-truncated.lzma is good-single-none.lzma without the
 112     last byte of the file.
 113
 114     bad-cat-single-none-pad_garbage_1.lzma is good-cat-single-none-pad.lzma
 115     with 0xFE appended to the end of the file. 0xFE doesn't begin .lzma
 116     or LZMA_Alone format file.
 117
 118     bad-cat-single-none-pad_garbage_2.lzma is good-cat-single-none-pad.lzma
 119     with 0xFF appended to the end of the file. 0xFF begins .lzma format
 120     file, thus the decoder has to detect that the file is incomplete.
 121
 122     bad-cat-single-none-pad_garbage_3.lzma is good-cat-single-none-pad.lzma
 123     with 0x5D appended to the end of the file. 0x5D is the most common
 124     first byte of LZMA_Alone format file.
 125
 126     bad-single-none-footer_filter_flags.lzma has different Stream Flags
 127     in Stream Footer than in Stream Header.
 128
 129     bad-single-none-too_long_vli.lzma has 10-byte variable-length integer.
 130
 131     bad-single-none-empty.lzma is like good-single-none-empty_3.lzma but
 132     with non-zero value in the Compressed Size field.
 133
 134     bad-single-data_after_eopm_1.lzma has LZMA+Subblock, where the Subblock
 135     filter gives one byte of data to LZMA after LZMA has detected EOPM.
 136
 137     bad-single-data_after_eopm_2.lzma is like
 138     bad-single-data_after_eopm_1.lzma but Subblock gives 256 MiB of data
 139     to LZMA after LZMA has detected EOPM.
 140
 141     bad-single-subblock_subblock.lzma has Subblock+Subblock, where the
 142     Subblock decoder is given End of Input in the middle of a Subblock.
 143
 144     bad-single-subblock-padding_loop.lzma contains huge amount of
 145     consecutive Padding bytes, which isn't allowed by the Subblock filter
 146     format. If it were allowed, this file would hang the decoder for very
 147     long time (weeks to years).
 148
 149     bad-single-subblock1023-slow.lzma is similar to
 150     malicious-single-subblock31-slow.lzma except that this uses 1023 bytes
 151     of Padding in every place instead of 31 bytes. The Subblock filter
 152     format specification allows only 31-byte Padings, thus this file must
 153     get detected as bad without producing any output. Allowing larger
 154     Padding than 31 bytes was considered (so this test file was created),
 155     but it seemed to be a bad idea since it would increase worst-case CPU
 156     usage.
 157
 158     bad-single-lzma-flush_beginning.lzma has flush marker in the beginning
 159     of the LZMA data.
 160
 161     bad-single-lzma-flush_twice.lzma has two flush markers with no data
 162     between them.
 163
 164     bad-multi-none-1.lzma has data after the last field in the Metadata
 165     Block and the `Extra is present' flag is not set.
 166
 167     bad-multi-none-2.lzma has wrong Total Size in Footer Metadata Block.
 168
 169     bad-multi-none-3.lzma has wrong Uncompressed Size in Footer Metadata
 170     Block.
 171
 172     bad-multi-none-index_1.lzma has wrong value in the Number of Data
 173     Blocks field.
 174
 175     bad-multi-none-index_2.lzma has too short Metadata to contain all
 176     the Index Records.
 177
 178     bad-multi-none-index_3.lzma has wrong value in Total Size field in
 179     the Index.
 180
 181     bad-multi-none-index_4.lzma has wrong value in Uncompressed Size field
 182     in the Index.
 183
 184     bad-multi-none-extra_1.lzma has incomplete Extra Record at the end of
 185     the Metadata Block.
 186
 187     bad-multi-none-extra_2.lzma has incomplete variable-length integer as
 188     Extra Record ID.
 189
 190     bad-multi-none-extra_3.lzma has incomplete Extra Record at the end of
 191     the Metadata Block.
 192
 193     bad-multi-none-header_1.lzma has empty Header Metadata Block (even
 194     the Metadata Flags field is not present).
 195
 196     bad-multi-none-header_2.lzma has Index in the Header Metadata Block,
 197     which describes only one Data Block, while the Stream actually has
 198     two Data Blocks. A sophisticated decoder should give an error when
 199     it detects the second Data Block; all Multi-Block decoders must
 200     detect the file as corrupt at some point.
 201
 202     bad-multi-none-header_3.lzma contains too small Total Size in Header
 203     Metadata Block. A sophisticated decoder should abort decoding before
 204     the second Data Block, preferably before the first Data Block has
 205     been finished; all Multi-Block decoders must detect the file as
 206     corrupt at some point.
 207
 208     bad-multi-none-header_4.lzma is like bad-multi-none-header_3.lzma but
 209     with too small Uncompressed Size.
 210
 211     bad-multi-none-header_5.lzma has Index in the Header Metadata Block,
 212     but the Total Size field is missing from the Footer Metadata Block.
 213
 214     bad-multi-none-header_6.lzma has both Index and Total Size in Header
 215     Metadata Block, but Total Size doesn't match the Index. A sophisticated
 216     decoder should abort before decoding any Data Blocks; all Multi-Block
 217     decoders must detect the file as corrupt at some point.
 218
 219     bad-multi-none-block_1.lzma has wrong Uncompressed Size in the first
 220     Data Block. A sophisticated decoder should detect this error before
 221     producing any output, because it can see that the Uncompressed Size
 222     doesn't match with the Index in Header Metadata Block; all Multi-Block
 223     decoders must detect the file as corrupt at some point.
 224
 225     bad-multi-none-block_2.lzma has too big Compressed Size in the first
 226     Data Block. A sophisticated decoder may be able to detect the file as
 227     corrupt before producing any output, because Comrpessed Size + size
 228     of Block Header exceed the Total Size stored in Index in Header
 229     Metadata Block. A sophisticated decoder should be able to detect the
 230     error before the end of the first Data Block; all Multi-Block decoders
 231     must detect the file as corrupt at some point.
 232
 233
 234 2.3. Malicious Files
 235
 236     malicious-single-subblock31-slow.lzma requires quite a bit of CPU time
 237     per decoded byte. It contains LZMA compressed Subblock filter data that
 238     has as much Padding as the specification allows. LZMA is also used as
 239     a Subfilter, to further slowdown the decoder. Every Subfilter instance
 240     produces only one byte of output. If you can create a file that wastes
 241     notably more CPU cycles than this file, please contact Lasse Collin.
 242
 243     malicious-single-subblock-256MiB.lzma is a tiny file that produces
 244     256 MiB of output. It uses Subblock filter's run-length encoding
 245     to achieve this.
 246
 247     malicious-single-subblock-64PiB.lzma is a tiny file that produces
 248     64 PiB of output (if you have patience to wait). This is done by
 249     chaining two Subblock filters and using their run-length encoders.
 250
 251     malicious-multi-metadata-64PiB.lzma is like
 252     malicious-single-subblock-64PiB.lzma but the huge amount of output
 253     is in a Metadata Block. Trying to decode this file may take years
 254     unless the decoder catches that the Metadata has unreasonable size.
 255