3.4 KiB
Implementation notes
Lightweight cleaning mode
Due to popular request, mat2 is providing a lightweight cleaning mode, that only cleans the superficial metadata of your file, but not the ones that might be in embedded resources. Like for example, images in a PDF or an office document.
Revisions handling
Revisions are handled according to the principle of least astonishment: they are entirely removed.
-
Either the users aren't aware of the revisions, are thus they should be deleted. For example journalists that are editing a document to erase mentions sources mentions.
-
Or they are aware of it, and will likely not expect mat2 to be able to keep the revisions, that are basically traces about how, when and who edited the document.
Race conditions
mat2 does its very best to avoid crashing at runtime. This is why it's checking if the file is valid at parser creation. mat2 doesn't take any measure to ensure that the file is not changed between the time the parser is instantiated, and the call to clean or show the metadata.
Symlink attacks
mat2 output predictable filenames (like yourfile.jpg.cleaned). This may lead to symlink attack. Please check if you OS prevent against them
Archives handling
By default, when cleaning a non-support file format in an archive, mat2 will abort with a detailed error message. While strongly discouraged, it's possible to override this behaviour to force the exclusion, or inclusion of unknown files into the cleaned archive.
While Python's zipfile module provides safe way to extract members of a zip archive, the tarfile one doesn't, meaning that it's up to mat2 to implement safety checks. Currently, it defends against path-traversal, both relative and absolute, symlink-related attacks, setuid/setgid attacks, duplicate members, block and char devices, … but there might still be dragons lurking there.
PDF handling
MAT was doing some kind of rendering for PDF files, on a cairo surface, then printed it to a file. This kept the text selectable, but unfortunately, it didn't remove any deep metadata, like the ones in embedded pictures. This was on of the reason MAT was abandoned: the absence of satisfying solution to handle PDF. But apparently, people are ok with pdf redact tools, that simply transform the PDF into images. So this is what's mat2 is doing too.
Of course, it would be possible to detect images in PDf file, and process them with mat2, but since a PDF can contain a lot of things, like images, videos, javascript, pdf, blobs, … this is the easiest and safest way to clean them.
Images handling
When possible, images are handled like PDF: rendered on a surface, then saved to the filesystem. This ensures that every metadata is removed.
XML attacks
Since our threat model conveniently excludes files crafted to specifically bypass mat2, fileformats containing harmful XML are out of our scope. But since mat2 is using etree to process XML, it's "only" vulnerable to DoS, and not memory corruption: odds are that the user will notice that the cleaning didn't succeed.