1 files changed, 62 insertions, 0 deletions
diff --git a/test/pixmaps/README.md b/test/pixmaps/README.md
new file mode 100644
index 0000000..2481d14
--- /dev/null
+++ b/test/pixmaps/README.md
@@ -0,0 +1,62 @@
+The pixmaps under this directory are used as test cases for several tests.
+The tests iterate over all files in each directory, so new test cases can be
+added by just adding a file there, adding it to the `EXTRA_DIST` list in
+`test/Makefile`, and adding a note here to help us remember what each test case
+covers.  Please make sure all pixmaps are appropriately licensed.
+
+For details on the different format types, see xpmDataTypes in `src/data.c`,
+<https://en.wikipedia.org/wiki/X_PixMap>, and
+<http://fileformats.archiveteam.org/wiki/XPM>.
+
+good
+----
+
+Those under the `good` subdirectory are expected to work and
+return XpmSuccess when parsed.
+
+A subset of these are specifically chosen/designed to test various things:
+
+- plaid-v3.xpm - copy of the sample XPM file from pg. 10 of `doc/xpm.PS.gz`,
+  in XPM version 3 format
+
+- plaid-v1.xpm - alternate version of plaid.xpm in XPM version 1 format
+
+- plaid-v2.xpm - alternate version of plaid.xpm in XPM version 2 "natural" format
+
+- plaid-lisp.xpm - alternate version of plaid.xpm in XPM Version 2 Lisp format
+
+- jigglymap.xpm - transparent background
+
+Other pixmaps in this directory are a selection of real world XPM files
+with a variety of sizes & numbers of colors.
+
+invalid
+-------
+
+Those under the `invalid` subdirectory are expected to fail and
+return XpmFileInvalid when parsed.
+
+- doom.xpm - This file is originally from
+  <http://scary.beasts.org/misc/doom.xpm>.
+  It is a test case for the stack-based overflow in xpmParseColors in
+  CVE-2004-0687 as described in
+  <https://security.appspot.com/security/CESA-2004-003.txt>.
+
+- doom2.xpm - This file is originally from
+  <http://scary.beasts.org/misc/doom2.xpm>.
+  It is a test case for the stack-based overflow in ParseAndPutPixels
+  and ParsePixels in CVE-2004-0687 as described in
+  <https://security.appspot.com/security/CESA-2004-003.txt>.
+
+- invalid-type.xpm - This file has an invalid XPM version 2 type header
+
+- no-contents.xpm - This file has a valid header but no contents
+
+no-mem
+------
+
+Those under the `invalid` subdirectory are expected to fail and
+return XpmNoMemory when parsed.
+
+- oversize.xpm - This file specifies more pixels than can be mapped in
+  a 64-bit address space that already has programs & libraries mapped in.